diff --git a/.speakeasy/logs/changes/changes.html b/.speakeasy/logs/changes/changes.html index cc03fdd43..8de530788 100644 --- a/.speakeasy/logs/changes/changes.html +++ b/.speakeasy/logs/changes/changes.html @@ -98,14 +98,34 @@

Csharp SDK Changes:

\ No newline at end of file diff --git a/.speakeasy/logs/changes/changes.md b/.speakeasy/logs/changes/changes.md index 1ed8d2a04..425e0fafb 100644 --- a/.speakeasy/logs/changes/changes.md +++ b/.speakeasy/logs/changes/changes.md @@ -1,6 +1,20 @@ ## Csharp SDK Changes: -* `Codat.platform.Companies.GetCompanySyncSettings()`: **Added** -* `Codat.platform.Companies.SetCompanySyncSettings()`: **Added** -* `Codat.platform.Companies.RefreshProductData()`: - * `request.RequestBody` **Added** -* `Codat.lending.Banking.CategorizedStatement.Get()`: `response.reportItems[].Transactions[].IsRecurring` **Added** +* `Codat.sync.expenses.Connections.Create()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Companies.List()`: + * `request.Tags` **Added** + * `response.results[].DataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Companies.Create()`: `response.dataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Companies.Update()`: + * `request` **Changed** (Breaking ⚠️) + - `companyRequestBody` **Removed** (Breaking ⚠️) + - `companyUpdateRequest` **Added** + * `response.dataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Companies.Get()`: `response.dataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Connections.List()`: `response.results[].ConnectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Connections.Get()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Connections.Unlink()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Connections.CreatePartnerExpenseConnection()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) +* `Codat.sync.expenses.Companies.Replace()`: **Added** +* `Codat.sync.expenses.ManageData.RefreshAllDataTypes()`: `error.status[400]` **Added** +* `Codat.sync.expenses.ManageData.Get()`: `response.accountTransactions.LastSuccessfulSync` **Changed** +* `Codat.sync.expenses.ManageData.RefreshDataType()`: `error.status[400]` **Added** diff --git a/.speakeasy/logs/changes/new.openapi.yaml b/.speakeasy/logs/changes/new.openapi.yaml index 108265e9c..624c47077 100644 --- a/.speakeasy/logs/changes/new.openapi.yaml +++ b/.speakeasy/logs/changes/new.openapi.yaml @@ -1,29 +1,23 @@ openapi: 3.1.0 -x-stoplight: - id: 466k6ayziv9at -servers: - - description: Production - url: 'https://api.codat.io' info: - title: Platform API - version: 3.0.0 - summary: Platform API + title: Expenses + version: prealpha + contact: + name: Codat + url: 'https://www.codat.io/' + email: expenses@codat.io description: |- - An API for the common components of all of Codat's products. - - These end points cover creating and managing your companies, data connections, and integrations. + The API for Codat's Expenses solution. - [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) + Expenses is an API and a set of supporting tools. It has been built to + enable corporate card and expense management platforms to provide high-quality + integrations with multiple accounting software through a standardized API. - --- - title: Lending - description: |- - 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. + [Explore solution](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) - 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/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + Not seeing the endpoints you're expecting? We've [reorganized our solutions](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). + --- ## Endpoints @@ -31,33 +25,19 @@ info: | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | - | Connection management | Configure connection management UI and retrieve access tokens for authentication. | - | Webhooks | Create and manage webhooks that listen to Codat's events. | - | Integrations | Get a list of integrations supported by Codat and their logos. | - | Refresh data | Initiate data refreshes, view pull status and history. | - | Settings | Manage company profile configuration, sync settings, and API keys. | - | Push data | Initiate and monitor Create, Update, and Delete operations. | - | Supplemental data | Configure and pull additional data you can include in Codat's standard data types. | - | Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. | + | Configuration | View and manage mapping configuration and defaults for expense transactions. | + | Sync | Monitor the status of data syncs. | + | Expenses | Create and update transactions that represent your customers' spend. | + | Transfers | Create and update transactions that represent the movement of your customers' money. | + | Reimbursements | Create and update transactions that represent your customers' repayable spend. | + | Attachments | Attach receipts to a transaction for a complete audit trail. | + | Transaction status | Monitor the status of individual transactions in data syncs. | + | Manage data | Control and monitor the retrieval of data from an integration. | + | Push operations | View historic push operations. | + | Accounts | Create accounts and view account schemas. | + | Customers | Get, create, and update customers. | + | Suppliers | Get, create, and update suppliers. | - | 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: [] @@ -98,8 +78,7 @@ x-speakeasy-name-override: methodNameOverride: download-attachment - operationId: ^upload-.*?-attachment methodNameOverride: upload-attachment -x-codat-docs-path: platform-api -x-codat-docs-path: lending-api +x-codat-docs-path: sync-for-expenses-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -112,60 +91,42 @@ x-codat-speakeasy-pagination: tags: - name: Companies description: Create and manage your SMB users' companies. - - name: Connection management - description: Configure UI and retrieve access tokens for authentication used by **Connections SDK**. - - name: Connections - description: Create new and manage existing data connections for a company. - - name: Webhooks - description: Create and manage webhooks that listen to Codat's events. - - name: Integrations - description: Get a list of integrations supported by Codat and their logos. - - name: Refresh data - description: 'Initiate data refreshes, view pull status and history.' - - name: Settings - description: 'Manage company profile configuration, sync settings, and API keys.' - - name: Push data - description: 'Initiate and monitor Create, Update, and Delete operations.' - - name: Read data - description: View validation outcomes for completed read data operations. - - name: Supplemental data - description: Configure and pull additional data you can include in Codat's standard data types. - - name: Custom data type - description: Configure and pull additional data types that are not included in Codat's standardized data model. - name: Connections description: Create new and manage existing data connections for a company. - - 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: 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. + description: View the company information of your customers' linked accounting software. - 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.' + description: Control and monitor the retrieval of data from an integration. + - name: Mapping options + description: 'Get accounts, trackingCategories and taxRates that can be used in your create and update requests.' + - name: Accounts + description: Create accounts and view create account options. + - name: Bank accounts + description: Create bank accounts and view create bank account options. + - name: Customers + description: 'Get, create, and update customers.' + - name: Suppliers + description: 'Get, create, and update suppliers.' + - name: Push operations + description: View historic push operations. + - name: Configuration + description: View and manage mapping configuration and defaults for expense transactions. + - name: Expenses + description: Create and update transactions that represent your customers' spend. + - name: Reimbursements + description: Create and update transactions that represent your customers' repayable spend. + - name: Transfers + description: Create and update transactions that represent the movement of your customers' money. + - name: Adjustments + description: Create transactions that represent your adjustments to your customers' spend. + - name: Attachments + description: Attach receipts to a transaction for a complete audit trail. + - name: Sync + description: Monitor the status of data syncs. + - name: Transaction status + description: Monitor the status of individual transactions in data syncs. +servers: + - url: 'https://api.codat.io' paths: /companies: get: @@ -335,8 +296,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/platform-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/platform-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`" + description: "\uFEFFThe *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\n## Filter by tags\n\nThe *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):\n\n- equals (`=`)\n- not equals (`!=`)\n- contains (`~`)\n\nFor example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: \n- Foreign key: `uid = {yourCustomerId}`\n- Region: `region != uk`\n- Owning team and region: `region = uk && owningTeam = invoice-finance`" parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' @@ -404,7 +364,6 @@ paths: region: us referenceSubsidiaryCompanies: [] '400': - $ref: '#/components/responses/Bad-Request' $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' @@ -418,8 +377,7 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/platform-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`." - description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/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`." + description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`." requestBody: content: application/json: @@ -434,13 +392,9 @@ paths: name: Technicalium description: 'Technology services, including web and app design and development' '/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/platform-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/platform-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" 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/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." + description: "\uFEFFUse the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data." operationId: replace-company x-speakeasy-name-override: replace parameters: @@ -483,7 +437,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/lending-api#/schemas/Company) represents a business sharing access to their data." + description: "\uFEFFUse the *Update company* endpoint to update the name, description, or tags of the company.\n\nThe *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update. \n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data." operationId: update-company parameters: - $ref: '#/components/parameters/companyId' @@ -528,7 +482,7 @@ paths: 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" + description: "\uFEFFThe *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company), its [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" tags: - Companies responses: @@ -551,7 +505,7 @@ paths: get: summary: Get company operationId: get-company - description: "\uFEFFThe *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/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" + description: "\uFEFFThe *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" parameters: - $ref: '#/components/parameters/companyId' tags: @@ -649,254 +603,6 @@ paths: $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/platform-api#/schemas/Company), its [connections](https://docs.codat.io/platform-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/platform-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' - 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/platform-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/platform-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: - - $ref: '#/components/parameters/companyId' - tags: - - Companies - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Company' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyRequestBody' - examples: - Update name: - value: - name: New Name - Update description: - value: - name: Same name - description: Additional documents required - 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/platform-api#/schemas/Company) represents a business sharing access to their data." - operationId: update-company - parameters: - - $ref: '#/components/parameters/companyId' - tags: - - Companies - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Company' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyUpdateRequest' - examples: - Update tags: - value: - tags: - refrence: new reference - Update name: - value: - name: New Name - '/companies/{companyId}/products/{productIdentifier}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/productIdentifier' - put: - summary: Add product - operationId: add-product - x-speakeasy-name-override: add-product - description: |- - Use the *Add product* endpoint to enable a product for the company specified by `companyId`. - - > Note: This feature is currently in alpha and available only to participants in the development program. - tags: - - Companies - responses: - '204': - description: OK - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - delete: - summary: Remove product - operationId: remove-product - x-speakeasy-name-override: remove-product - description: |- - Use the *Remove product* endpoint to disable a product for the company specified by `companyId`. - - > Note: This feature is currently in alpha and available only to participants in the development program. - tags: - - Companies - responses: - '204': - description: OK - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/products/{productIdentifier}/refresh': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/productIdentifier' - post: - summary: Refresh product data - operationId: refresh-product-data - x-speakeasy-name-override: refresh-product-data - description: |- - Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company. - - ### Tips and traps - - - This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead. - - If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response. - - If a company has multiple custom products enabled, you can refresh data for each product individually. - - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product's scheduled refresh is triggered as usual. - - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options. - tags: - - Companies - requestBody: - required: false - description: 'Optionally specify one or more data types to refresh for the given custom product. If omitted, the product''s scheduled refresh is triggered as usual. When provided, each data type must be valid for the specified product.' - content: - application/json: - schema: - type: object - properties: - dataTypes: - type: array - description: One or more data types to refresh for the product. - items: - type: string - additionalProperties: false - examples: - Filter specific data types: - value: - dataTypes: - - invoices - - payments - responses: - '202': - description: OK - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - examples: - Standard product not supported: - value: - statusCode: 400 - service: PublicApi - error: 'Bank Feeds doesn''t support data refreshing. For more information, refer to your solution’s documentation [here](https://docs.codat.io).' - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - Read in progress: - value: - statusCode: 400 - service: PublicApi - error: Data cannot be refreshed while a read operation is in progress. Allow the read to complete before attempting to refresh. - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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 @@ -974,7 +680,6 @@ paths: type: object properties: platformKey: - $ref: '#/components/parameters/platformKey/schema' type: string minLength: 4 maxLength: 4 @@ -1120,7 +825,6 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateConnectionStatus' title: Update connection x-internal: true type: object @@ -1135,24 +839,26 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/connections/{connectionId}/authorization': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - put: - summary: Update authorization - operationId: update-connection-authorization - x-speakeasy-name-override: update-authorization - description: Update data connection's authorization. + '/companies/{companyId}/sync/expenses/connections/partnerExpense': + post: tags: - Connections + description: Creates a partner expense data connection + summary: Create partner expense connection + operationId: create-partner-expense-connection + x-speakeasy-name-override: create-partner-expense-connection + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - description: OK + description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1167,85 +873,90 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: - type: string - description: '' - '/companies/{companyId}/accessToken': + '/companies/{companyId}/data/info': 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. + tags: + - Company info + summary: Get company info + description: Gets the latest basic info for a company. + operationId: get-company-info parameters: - $ref: '#/components/parameters/companyId' - tags: - - Companies responses: '200': - description: OK + description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyAccessToken' + $ref: '#/components/schemas/CompanyInformation' examples: - Simple company: + Example 1: value: - expiresIn: 86400 - accessToken: string - tokenType: Bearer - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' + 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}/syncSettings': - parameters: - - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/config': get: - summary: Get company sync settings tags: - - Companies - operationId: get-company-syncSettings - x-speakeasy-name-override: get-company-sync-settings - description: 'Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched.' + - Configuration + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - description: OK + description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanySyncSettings' - examples: - Example: - value: - companyId: 8a210b68-6988-11ed-a1eb-0242ac120002 - settings: - - dataType: invoices - fetchOnFirstLink: true - syncSchedule: 24 - syncOrder: 0 - syncFromUtc: '2020-01-01T12:00:00.000Z' - syncFromWindow: 24 - monthsToSync: 24 - isLocked: true - overridesDefaults: true + $ref: '#/components/schemas/CompanyConfiguration' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1260,18 +971,29 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' + summary: Get company configuration + description: Gets a company's expense sync configuration + operationId: get-company-configuration post: - summary: Set company sync settings - description: Set the sync settings for a specific company. tags: - - Companies - operationId: set-company-syncSettings - x-speakeasy-name-override: set-company-sync-settings + - Configuration + parameters: + - $ref: '#/components/parameters/companyId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyConfiguration' + examples: {} responses: - '204': - description: No Content + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyConfiguration' '400': - $ref: '#/components/responses/Bad-Request' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1286,59 +1008,26 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - allOf: - - properties: - companyId: - type: string - format: uuid - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for your SMB in Codat. - settings: - type: array - items: - $ref: '#/components/schemas/SyncSetting' - overridesDefaults: - type: boolean - default: true - description: 'Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).' - required: - - companyId - - settings - - overridesDefaults - type: object - description: |- - Include a `syncSetting` object for each data type. - `syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them. - '/companies/{companyId}/connectionManagement/accessToken': + summary: Set company configuration + description: Sets a company's expense sync configuration + operationId: set-company-configuration + x-speakeasy-name-override: set parameters: - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/mappingOptions': get: - summary: Get access token (old) - operationId: get-connection-management-access-token - deprecated: true - x-speakeasy-deprecation-message: | - The endpoint for generating company-specific connection management access tokens has been deprecated. - Codat now supports a global company access token, providing seamless access across multiple products. - Update your integration to use the global token for improved efficiency and consistency. - x-speakeasy-deprecation-replacement: get-company-access-token tags: - - Connection management - description: "\uFEFFThe new [Get company access token](https://docs.codat.io/platform-api#/operations/get-company-access-token) endpoint replaces this endpoint and includes additional functionality." + - Mapping options + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ConnectionManagementAccessToken' - examples: - Access token: - value: - accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + $ref: '#/components/schemas/MappingOptions' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1353,22 +1042,26 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - /connectionManagement/corsSettings: + description: 'Gets the mapping options (accounts, trackingCategories and taxRates) for a company''s accounting software' + summary: Mapping options + operationId: get-mapping-options + x-speakeasy-name-override: get-mapping-options + parameters: + - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/syncs/lastSuccessful/status': get: - summary: Get CORS settings (old) - operationId: get-connection-management-cors-settings - x-speakeasy-group: cors - deprecated: true - x-speakeasy-deprecation-message: | - The new [Get CORS settings](https://docs.codat.io/platform-api#/operations/get-cors-settings) endpoint replaces this endpoint and includes additional functionality. - Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release. - x-speakeasy-deprecation-replacement: get-cors-settings tags: - - Settings - description: "\uFEFFThe *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat. \n\nEnabling CORS with Codat is required by our 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 access Codat's API endpoints." + - Sync + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1383,30 +1076,26 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - post: - summary: Set CORS settings (old) - operationId: set-connection-management-cors-settings - x-speakeasy-name-override: set - x-speakeasy-group: cors - deprecated: true - x-speakeasy-deprecation-message: | - The new [Set CORS settings](https://docs.codat.io/platform-api#/operations/set-cors-settings) endpoint replaces this endpoint and includes additional functionality. - Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release. - x-speakeasy-deprecation-replacement: set-cors-settings + description: Gets the status of the last successful sync + summary: Last successful sync + operationId: get-last-successful-sync + x-speakeasy-name-override: get-last-successful-sync + parameters: + - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/syncs/latest/status': + get: tags: - - Settings - description: "\uFEFFThe *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).\n \nEnabling CORS with Codat is required by our 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 access Codat's API endpoints. " - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionManagementAllowedOrigins' - examples: - Allowed origins: - $ref: '#/components/examples/connectionManagementAllowedOriginsResponse' + - Sync + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1421,16 +1110,28 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - /corsSettings: + description: Gets the latest sync status + summary: Latest sync status + operationId: get-latest-sync + x-speakeasy-name-override: get-latest-sync + parameters: + - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/syncs/list/status': + parameters: + - $ref: '#/components/parameters/companyId' get: - summary: Get CORS settings - operationId: get-cors-settings tags: - - Settings - description: "\uFEFFThe *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat. \n\nEnabling CORS with Codat is required by our 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 access Codat's API endpoints." + - Sync responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1445,24 +1146,24 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - post: - summary: Set CORS settings - operationId: set-cors-settings - x-speakeasy-name-override: set + summary: List sync statuses + description: Gets a list of sync statuses + operationId: list-syncs + '/companies/{companyId}/sync/expenses/syncs/{syncId}/status': + get: tags: - - Settings - description: "\uFEFFThe *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).\n \nEnabling CORS with Codat is required by our 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 access Codat's API endpoints." - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionManagementAllowedOrigins' - examples: - Allowed origins: - $ref: '#/components/examples/connectionManagementAllowedOriginsResponse' + - Sync + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1477,19 +1178,27 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/all': + summary: Get sync status + description: Get the sync status for a specified sync + operationId: get-sync-by-id parameters: - $ref: '#/components/parameters/companyId' - post: - summary: Refresh all data - operationId: refresh-company-data - x-speakeasy-name-override: all - operationId: refresh-all-data-types - x-speakeasy-group: manage-data.refresh - x-speakeasy-name-override: all-data-types + - $ref: '#/components/parameters/syncId' + '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions': + get: + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' responses: - '204': - description: No Content + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Transactions' + examples: {} '400': $ref: '#/components/responses/Malformed-Query' '401': @@ -1506,44 +1215,90 @@ paths: $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: - - Refresh data - '/companies/{companyId}/data/queue/{dataType}': + - Transaction status + summary: List sync transactions + description: Gets the transactions and status for a sync + operationId: list-sync-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}': + get: + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/transactionId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionResponse' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + tags: + - Transaction status + summary: Get sync transaction + description: Gets the status of a transaction for a sync + operationId: get-sync-transaction + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/transactionId' + '/companies/{companyId}/sync/expenses/expense-transactions': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/dataType' post: - summary: Refresh data type - operationId: refresh-data-type - x-speakeasy-name-override: by-data-type - description: |- - Refreshes a given data type for a given company. + summary: Create expense transaction + operationId: create-expense-transaction + description: | + The *Create expense* endpoint creates an [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) in the accounting software for a given company's connection. - This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. + + ### Supported Integrations + + | Integration | Supported | + |-------------------------------|-----------| + | Dynamics 365 Business Central | Yes | + | FreeAgent | Yes | + | QuickBooks Desktop | Yes | + | QuickBooks Online | Yes | + | Oracle NetSuite | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | tags: - - Refresh data - parameters: - - schema: - type: string - format: uuid - in: query - name: connectionId - description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + - Expenses responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/PullOperation' + $ref: '#/components/schemas/CreateExpenseResponse' + examples: + Example 1: + value: + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1558,423 +1313,173 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - - Manage data - '/companies/{companyId}/dataStatus': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExpenseRequest' + examples: + Payment: + value: + - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 + type: Payment + issueDate: '2024-05-21T00:00:00+00:00' + currency: GBP + currencyRate: 1 + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + Refund: + value: + - id: 7008d3f2-aeb4-11ed-afa1-0242ac120002 + type: Refund + issueDate: '2024-02-17T00:00:00+00:00' + currency: GBP + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '42' + trackingRefs: + - id: DEPARTMENT_6 + '/companies/{companyId}/sync/expenses/expense-transactions/{transactionId}': parameters: - $ref: '#/components/parameters/companyId' - get: - summary: Get data status - operationId: get-company-data-status - description: Get the state of each data type for a company - tags: - - Refresh data - 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 + - $ref: '#/components/parameters/transactionId' + put: + summary: Update expense transactions tags: - - Manage data + - Expenses responses: - '200': - description: OK + '202': + description: Accepted content: application/json: schema: - $ref: '#/components/schemas/DataStatuses' - 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 + $ref: '#/components/schemas/UpdateExpenseResponse' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '422': + $ref: '#/components/responses/Unprocessable-Content' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: update-expense-transaction + description: |- + The *Update expense* endpoint updates an existing [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) in the accounting software for a given company's connection. + + [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. + + ### Supported integrations + The following integrations are supported for the [Payment](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) transaction `type` only: + | Integration | Supported | + |-----------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Desktop | Yes | + | QuickBooks Online | Yes | + | Oracle NetSuite | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | + + #### Integration-specific behavior + + | Integration | Specifics | + |-----------------------|-----------| + | Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.| + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExpenseRequest' + examples: + Payment: + value: + type: Payment + issueDate: '2024-05-21T00:00:00+00:00' + currency: GBP + currencyRate: 1 + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + '/companies/{companyId}/sync/expenses/transfer-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/transactionId' + put: + summary: Create transfer transaction + operationId: create-transfer-transaction + description: "Use the *Create transfer* endpoint to create or update a [transfer transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/TransferTransactionRequest) in the accounting software for a given company's connection. \r\n\r\nTransfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card.\r\n\r\nThe `from.amount` and `to.amount` fields are in the native currency of the account.\r\n\r\n### Supported Integrations\r\n| Integration | Create transfer | Update transfer |\r\n|-----------------------|------------------|------------------|\r\n| Dynamics\t\t\t\t| No\t\t\t | No\t\t\t\t |\r\n| FreeAgent | Yes | Yes |\r\n| NetSuite | No | No |\r\n| QuickBooks Desktop | Yes | No |\r\n| QuickBooks Online | Yes | Yes |\r\n| Sage Intacct | No | No |\r\n| Xero | Yes | No |\r\n| Zoho Books | No | No |" + tags: + - Transfers + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/TransferTransactionResponse' examples: - Example: + Example 1: 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 + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1989,37 +1494,56 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/queue/{dataType}': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferTransactionRequest' + examples: + Create transfer: + value: + description: Sample transfer description + date: '2021-05-21T00:00:00+00:00' + from: + accountRef: + id: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea + amount: 100 + to: + accountRef: + id: 777dfb37-5506-3dc0-6g86-8d34z4cc78ea + amount: 100 + '/companies/{companyId}/sync/expenses/adjustment-transactions': 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 + summary: Create adjustment transaction + operationId: create-adjustment-transaction description: |- - Refreshes a given data type for a given company. + Use the *Create adjustment expense* endpoint to create an [adjustment](https://docs.codat.io/sync-for-expenses-api#/schemas/AdjustmentTransactionRequest) in the accounting software for a given company's connection. - This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + Adjustments represent write-offs and transaction alterations, such as foreign exchange adjustments, in the form of a journal entry. + + ### Supported Integrations + + | Integration | Supported | + |-----------------------|-----------| + | QuickBooks Desktop | Yes | tags: - - Manage data - parameters: - - schema: - type: string - format: uuid - in: query - name: connectionId - description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + - Adjustments responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/PullOperation' + $ref: '#/components/schemas/AdjustmentTransactionResponse' + examples: + Example 1: + value: + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2034,50 +1558,60 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/history': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAdjustmentRequest' + examples: + Create adjustment: + value: + - id: 3357b3df-5f2e-465d-b9ba-226519dbb8f1 + date: '2024-05-21T00:00:00+00:00' + currency: USD + currencyRate: 1 + reference: test reference + lines: + - amount: 50 + accountRef: + id: 80000018-1671793811 + description: debit line + trackingRefs: + - id: 80000003-1674553958 + dataType: trackingCategories + invoiceTo: + id: 80000002-1674552702 + type: customer + - amount: -50 + accountRef: + id: 80000028-1671794219 + description: credit line + trackingRefs: + - id: 80000003-1674553958 + dataType: trackingCategories + '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions': parameters: - $ref: '#/components/parameters/companyId' - get: - summary: List pull operations + post: + summary: Create reimbursable expense transaction + operationId: create-reimbursable-expense-transaction + description: "Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.\r\n\r\n[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Zoho Books | Yes |\r\n| Sage Intacct | Yes |" tags: - - Refresh data - operationId: list-pull-operations - x-speakeasy-name-override: list-pull-operations - - Manage data - operationId: list-pull-operations - x-speakeasy-group: manage-data.pull-operations + - Reimbursements responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/PullOperations' + $ref: '#/components/schemas/CreateReimbursableExpenseResponse' examples: - Example: + Example 1: value: - results: - - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b - companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 - connectionId: 51baa045-4836-4317-a42e-3542e991e581 - dataType: invoices - status: Initial - requested: '2022-11-14T11:18:37.2798351Z' - progress: 10 - isCompleted: false - isErrored: false - _links: - current: - href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 - self: - href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history - next: - href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 - pageNumber: 0 - pageSize: 0 - totalResults: 0 + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2092,256 +1626,123 @@ paths: $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-name-override: get-pull-operation - tags: - - Refresh data - 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. - /webhooks: - get: - summary: List webhook consumers - operationId: list-webhook-consumers - x-speakeasy-name-override: list-consumers - description: "\uFEFFUse the *List webhook consumers* endpoint to return a list of all webhook consumers that currently exist for your client.\n\n[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview)." - tags: - - Webhooks - '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReimbursableExpenseTransactionRequest' + examples: + Create reimbursable expense: + value: + - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 + reference: expenses w/c 01/07 + contactRef: + id: '752' + issueDate: '2024-05-21' + dueDate: '2024-05-21' + currency: GBP + currencyRate: 1 + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - description: Hotel + netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions/{transactionId}': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/dataIntegrityDataType' - get: - summary: Get data integrity status + - $ref: '#/components/parameters/transactionId' + put: + summary: Update reimbursable expense transaction + operationId: update-reimbursable-expense-transaction + description: "The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection. \r\n\r\nUpdating an existing [reimbursable expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateReimbursableExpenseTransactionRequest) will update the existing **bill** against an employee (who exists as a supplier in the accounting software).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Sage Intacct | Yes |\r\n| Zoho Books | Yes |" tags: - - Data integrity + - Reimbursements responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/WebhookConsumer/definitions/webhookConsumers' + $ref: '#/components/schemas/CreateReimbursableExpenseResponse' examples: - Webhook consumers: + Example 1: value: - results: - - id: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - url: 'https://example.com/webhoook-consumers/sync-complete' - eventTypes: - - DataSyncCompleted - disabled: false - - id: ca3cac86-7925-4759-abc2-96405780fdfa - url: 'https://example.com/webhoook-consumers/dataset-changed' - eventTypes: - - DatasetDataChanged - disabled: true + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Bad-Request' + $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: - summary: Create webhook consumer - operationId: create-webhook-consumer - x-speakeasy-name-override: create-consumer - description: "\uFEFFUse the *Create webhook consumer* endpoint to create a new webhook consumer that will listen to messages we send you.\n\n[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).\n\n### Tips and traps\n- The number of webhook consumers you can create is limited to 50. If you have reached the maximum number of consumers, use the [*Delete webhook consumer*](https://docs.codat.io/platform-api#/operations/delete-webhook-consumer) endpoint to delete an unused consumer first." - tags: - - Webhooks requestBody: content: application/json: schema: - $ref: '#/components/schemas/WebhookConsumer/definitions/webhookConsumerPrototype' + $ref: '#/components/schemas/UpdateReimbursableExpenseTransactionRequest' examples: - Subscribe consumer to one or more event types: + Update reimbursable expense: value: - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - - Dataset data changed - Subscribe consumer with disabled endpoint: - value: - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - disabled: true - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/WebhookConsumer' - examples: - Subscribe consumer to one or more event types: - value: - id: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - - DatasetDataChanged - disabled: false - Subscribe consumer with disabled endpoint: - value: - id: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - disabled: true - '400': - $ref: '#/components/responses/Bad-Request' - '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' - '/webhooks/{webhookId}': - parameters: - - $ref: '#/components/parameters/webhookId' - delete: - summary: Delete webhook consumer - operationId: delete-webhook-consumer - x-speakeasy-name-override: delete-consumer - description: "\uFEFFUse the *Delete webhook consumer* endpoint to delete an existing webhoook consumer, providing its valid `id` as a parameter.\n\n[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview)." - tags: - - Webhooks - responses: - '204': - description: No content - $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' - /webhooks/integrationKeys/zapier: + reference: expenses w/c 01/07 + contactRef: + id: '752' + issueDate: '2024-05-21' + dueDate: '2024-05-21' + currency: GBP + currencyRate: 1 + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - description: Hotel + netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/transactionId' post: - summary: Rotate Zapier key - operationId: rotate-zapier-key - x-speakeasy-ignore: true - description: "\uFEFFThe *Rotate Zapier key* endpoint returns the Zapier integration key needed to configure Zaps triggered by Codat's webhooks. \n\nIf a key has already been created, calling this will revoke that existing key.\n\nThe key changes each time this endpoint is called. If you are already using our Zapier integration and called this endpoint again, you need to reauthenticate using the latest integration key returned in the response.\n\nOur Zapier integration makes it simple for you to set up and receive user notifications in your preferred ways, such as via email or Slack. See our [Zapier documentation](https://docs.codat.io/using-the-api/webhooks/zapier-integration) for detailed instructions on setting up this integration.\n\n" - tags: - - Webhooks - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/WebhookZapierKey' - examples: - Integration key: - value: - key: sk_integ_WM4dfoK1nKZnDE_kceze6hWDjbRwOZwG.us - '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' - /integrations: - get: - summary: List integrations - description: List your available integrations - tags: - - Integrations - operationId: list-integrations - 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 + summary: Upload attachment + operationId: upload-expense-attachment + x-speakeasy-name-override: upload responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Integrations' - $ref: '#/components/schemas/DataIntegritySummaries' + $ref: '#/components/schemas/Attachment' + examples: {} '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2356,32 +1757,40 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - operationId: get-data-integrity-summaries - x-speakeasy-name-override: summaries + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/AttachmentUpload' + tags: + - Attachments 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). + The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. - 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`. + [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. - 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': + **Integration-specific behavior** + + Each accounting software supports different file formats and sizes. + + | Integration | File size | File extension | Supported transactions | + |-----------------------------------|-----------|-------------------------------------------------------|------------------------| + | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | + | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `expense-transactions.Payment`, `expense-transactions.Refund`, `reimbursable-expense-transactions` | + | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`expense-transactions.Payment`, `expense-transactions.Refund` | + | **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types + | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | + | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` + | **Zoho Books** | 5MB | GIF, PNG, JPEG, JPG, BMP, PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` | + '/companies/{companyId}/data/all': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/dataIntegrityDataType' - get: - summary: List data integrity details - tags: - - Data integrity + post: + summary: Refresh all data + operationId: refresh-all-data-types responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/DataIntegrityDetails' - examples: {} + '204': + description: No Content '400': $ref: '#/components/responses/Malformed-Query' '401': @@ -2398,81717 +1807,8326 @@ paths: $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. + Refreshes all data types with `fetch on first link` set to `true` for a given company. - 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. + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. - 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. + [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. 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': + - Manage data + '/companies/{companyId}/dataStatus': 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." + summary: Get data status + operationId: get-data-status + description: Get the state of each data type for a company tags: - - Bank statements + - Manage data 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' - '/integrations/{platformKey}': - parameters: - - $ref: '#/components/parameters/platformKey' - get: - summary: Get integration - tags: - - Integrations - operationId: get-integration - description: 'Get single integration, by platformKey' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Integration' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/integrations/{platformKey}/branding': - parameters: - - $ref: '#/components/parameters/platformKey' - get: - summary: Get branding - tags: - - Integrations - operationId: get-integrations-branding - x-speakeasy-name-override: get-branding - description: Get branding for platform. - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Branding' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - /profile: - get: - summary: Get profile - tags: - - Settings - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Profile' - examples: {} - '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' - operationId: get-profile - x-speakeasy-name-override: get-profile - description: Fetch your Codat profile. - put: - summary: Update profile - operationId: update-profile - x-speakeasy-name-override: update-profile - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Profile' - examples: {} - '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' - tags: - - Settings - description: Update your Codat profile - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Profile' - examples: {} - description: All fields should be included when updating your profile. - /profile/syncSettings: - get: - summary: Get sync settings - tags: - - Settings - operationId: get-profile-syncSettings - x-speakeasy-name-override: get-sync-settings - description: 'Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SyncSettings' - examples: - Example: - value: - clientId: 367f7975-267b-439b-90c6-a6040ee680f3 - settings: - - dataType: invoices - fetchOnFirstLink: true - syncSchedule: 24 - syncOrder: 0 - syncFromUtc: '2020-01-01T12:00:00.000Z' - syncFromWindow: 24 - monthsToSync: 24 - isLocked: true - overridesDefaults: true - '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' - post: - summary: Update all sync settings - description: Update sync settings for all data types. - tags: - - Settings - operationId: update-profile-syncSettings - x-speakeasy-name-override: update-sync-settings - responses: - '204': - description: No Content - '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' - requestBody: - content: - application/json: - schema: - allOf: - - properties: - clientId: - $ref: '#/components/schemas/ClientId' - settings: - type: array - items: - $ref: '#/components/schemas/SyncSetting' - overridesDefaults: - type: boolean - default: true - description: 'Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).' - required: - - clientId - - settings - - overridesDefaults - type: object - description: |- - Include a `syncSetting` object for each data type. - `syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them. - /apiKeys: - get: - summary: List API keys - description: |- - Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint. - - [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - - You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - operationId: list-api-keys - x-speakeasy-name-override: list-api-keys - tags: - - Settings - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ApiKeys' - examples: - Example: - value: - results: - - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-11T13:49:37Z' - - id: c438836a-61fe-443f-8a19-24cc18be21e4 - name: azure-invoice-finance-processor - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-23T09:43:48Z' - '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' - post: - summary: Create API key - operationId: create-api-key - x-speakeasy-name-override: create-api-key - description: |- - Use the *Create API keys* endpoint to generate a new API key for your client. - - [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - - You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - - ### Tips and pitfalls - - * Your first API key is created for you. Access this key via [Codat's Portal](https://app.codat.io/developers/api-keys). - * If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint. - * The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first. - tags: - - Settings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateApiKey' - examples: - Create API key with name: - value: - name: azure-invoice-finance-processor - responses: - '201': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ApiKeyDetails' - examples: - API key details: - value: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-11T13:49:37Z' - API key details with name: - value: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: azure-invoice-finance-processor - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-11T13:49:37Z' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - examples: - Max length for name reached: - value: - statusCode: 400 - service: PublicApi - error: Max string length (50) for `name` reached. - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '409': - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - examples: - Max length for name reached: - value: - statusCode: 400 - service: PublicApi - error: 'Maximum number of API keys reached. To create a new API key, delete an unused key and try again.' - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/apiKeys/{apiKeyId}': - delete: - summary: Delete API key - operationId: delete-api-key - x-speakeasy-name-override: delete-api-key - parameters: - - name: apiKeyId - in: path - required: true - schema: - type: string - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for api key. - description: |- - Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible. - - [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - - You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - - ### Tips and pitfalls - - * It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal. - * It is possible to delete the API key used to authenticate the *Delete API key* request. - tags: - - Settings - responses: - '204': - description: No Content - $ref: '#/components/responses/Too-Many-Requests' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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}/sync/{datasetId}/validation': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/datasetId' - get: - summary: Get validation results - tags: - - Read data - operationId: get-read-validation-results - x-speakeasy-name-override: get-validation-results - description: |- - Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase. - - The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays: - - - **`warnings`** array lists potential issues with the data type that may require attention but don't block usage. - - **`errors`** array contains critical issues that must be resolved before the data type can be used. - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationResult' - examples: - Validation result: - value: - errors: - - ruleId: accounting-bill-030 - itemId: fc2f2d1a-ff4d-40c6-a7fb-4bd7d04f4008 - message: A bill's lines summed (69.99) should be the same as TotalAmount (70.00). - validatorName: BillValidator - warnings: - - ruleId: accounting-bill-032 - itemId: 1d3979e5-7c28-432e-b562-04e9013c1ea0 - message: A bill's lines sub total amount summed (3201.20) should be the same as SubTotal (3201.25) - validatorName: BillValidator - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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/{dataType}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/dataType' - get: - summary: Get push options - tags: - - Push data - operationId: get-create-update-model-options-by-data-type - x-speakeasy-name-override: get-model-options - 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: 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' - description: |- - This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information. - - Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear. - - Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented "options" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field. - '/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 - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: false - validation: - warnings: [] - information: - - field: IssueDate - details: 'If the issue date is not supplied, the current date on the server is used.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: - - field: Reference - details: Must be less than 22 characters. - information: [] - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company. - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: false - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: false - validation: - warnings: - - field: Allocation.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: false - validation: - warnings: - - field: Allocation.Currency - details: Must match the Currency of the company - information: [] - required: false - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: false - validation: - warnings: - - field: Payment.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency for the payment - required: false - validation: - warnings: - - field: Payment.Currency - details: Must match the Currency of the company - information: [] - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: [] - information: - - field: AccountRef.Id - details: 'Must be Bank, Cash or Asset account' - required: true - required: true - required: true - validation: - warnings: - - field: PaymentAllocations - details: Must have exactly one payment allocation. - information: [] - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - validation: - warnings: - - field: TrackingCategoryRefs.TrackingCategoryRefs - details: Must be a valid Id - information: [] - required: false - validation: - warnings: - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type CLASS can be provided per item. - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type DEPARTMENT can be provided per invoice. - - field: LineItems.TrackingCategoryRefs - details: All DEPARTMENT tracking categories must be the same - information: [] - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be an Expense or Income account - information: [] - required: false - validation: - warnings: - - field: LineItems.AccountRef - details: Must be set if ItemRef is not - information: [] - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: true - required: false - validation: - warnings: - - field: LineItems.ItemRef - details: Must be set if AccountRef is not - information: [] - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: false - validation: - warnings: - - field: LineItems.Description - details: Must be less than 4000 characters. - information: [] - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: false - validation: - warnings: - - field: LineItems.TaxAmount - details: Must be specified on all line items or none. If specified will override QBO tax calculations. - information: [] - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - validation: - warnings: [] - information: - - field: TaxRateRef.Id - details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' - required: false - validation: - warnings: - - field: LineItems.TaxRateRef - details: Required for all companies except QuickBooks Online France companies. - information: [] - required: true - required: true - QuickBooks Online: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - options: - - value: Suppliers - type: String - displayName: Suppliers - required: false - required: true - required: true - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: false - validation: - warnings: [] - information: - - field: IssueDate - details: 'If the issue date is not supplied, the current date on the server is used.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: - - field: Reference - details: Must be less than 22 characters. - information: [] - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company. - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: false - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: false - validation: - warnings: - - field: Allocation.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: false - validation: - warnings: - - field: Allocation.Currency - details: Must match the Currency of the company - information: [] - required: false - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: false - validation: - warnings: - - field: Payment.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency for the payment - required: false - validation: - warnings: - - field: Payment.Currency - details: Must match the Currency of the company - information: [] - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: [] - information: - - field: AccountRef.Id - details: 'Must be Bank, Cash or Asset account' - required: true - required: true - required: true - validation: - warnings: - - field: PaymentAllocations - details: Must have exactly one payment allocation. - information: [] - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - validation: - warnings: - - field: TrackingCategoryRefs.TrackingCategoryRefs - details: Must be a valid Id - information: [] - required: false - validation: - warnings: - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type CLASS can be provided per item. - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type DEPARTMENT can be provided per invoice. - - field: LineItems.TrackingCategoryRefs - details: All DEPARTMENT tracking categories must be the same - information: [] - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be an Expense or Income account - information: [] - required: false - validation: - warnings: - - field: LineItems.AccountRef - details: Must be set if ItemRef is not - information: [] - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: true - required: false - validation: - warnings: - - field: LineItems.ItemRef - details: Must be set if AccountRef is not - information: [] - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: false - validation: - warnings: - - field: LineItems.Description - details: Must be less than 4000 characters. - information: [] - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: false - validation: - warnings: - - field: LineItems.TaxAmount - details: Must be specified on all line items or none. If specified will override QBO tax calculations. - information: [] - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - validation: - warnings: [] - information: - - field: TaxRateRef.Id - details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' - required: false - validation: - warnings: - - field: LineItems.TaxRateRef - details: Required for all companies except QuickBooks Online France companies. - information: [] - required: true - required: true - Sage 50 (UK): - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - reference: - type: String - displayName: Reference - description: The user reference for this direct cost. - required: false - issueDate: - type: Number - displayName: Issue Date - description: The date this payment was issued. - required: true - currency: - type: String - displayName: Currency - description: The currency in which the direct cost is issued in. - required: true - validation: - warnings: - - field: currency - details: This must match the target account's default currency. - information: [] - currencyRate: - type: Number - displayName: Currency Rate - description: The currency rate associated with this transaction. - required: true - accountRef: - type: Object - displayName: Bank Account - description: The bank account to pay this direct cost from. - properties: - id: - type: String - displayName: Account Id - description: Nominal code of the bank account. - required: true - validation: - warnings: - - field: accountRef.id - details: Must match the ID of an existing bank account and have a max length of 8 characters. - information: [] - required: true - subTotal: - type: Number - displayName: Sub Total - description: The net amount being paid in this direct cost. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line net amounts - taxAmount: - type: Number - displayName: Tax Amount - description: The tax amount being paid in this direct cost. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line tax amounts - totalAmount: - type: Number - displayName: Total Amount - description: The total amount being paid in this direct cost. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line amounts - lineItems: - type: Array - displayName: Line Items - description: Line items of the direct cost. - properties: - description: - type: String - displayName: description - description: Description of the direct cost line item. - required: false - accountRef: - type: Object - displayName: Nominal Code - description: Target bank account for the direct cost line item. - properties: - id: - type: String - displayName: Id - description: The ID of the Account the line is linked to. - required: true - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: Unit amount for the direct cost line item. - required: true - validation: - warnings: - - field: LineItems.unitAmount - details: Cannot equal 0 and will be set to Net amount if not provided accordingly. - information: [] - quantity: - type: Number - displayName: Quantity - description: Quantity for the direct cost line item. - required: true - validation: - warnings: - - field: LineItems.quantity - details: Must be 1 or -1. - information: [] - subTotal: - type: Number - displayName: Net Amount - description: 'Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.' - required: true - validation: - warnings: - - field: LineItems.subTotal - details: Cannot have both subtotal and tax amount as 0 for line item. - information: [] - taxAmount: - type: Number - displayName: Tax Amount - description: Tax amount for the direct cost line item. - required: false - validation: - warnings: - - field: LineItems.taxAmount - details: Cannot have both tax amount and subtotal as 0 for line item. - information: [] - totalAmount: - type: Number - displayName: Total Amount - description: Total amount for the direct cost line item. - required: false - validation: - warnings: [] - information: - - field: LineItems.totalAmount - details: Will be auto populated using tax amount and net amount. - taxCode: - type: Number - displayName: Tax Code Id - description: The tax code ID associated with this transaction. - required: true - trackingCategoryRefs: - type: Object - displayName: Tracking Category References - description: Tracking categories associated with this transaction. - properties: - id: - type: String - displayName: Id - description: The ID of the tracking category associated with the transaction - required: true - validation: - warnings: - - field: id - details: 'A department is required. If a project reference is provided, the cost code for that project must also be provided.' - information: [] - required: true - required: true - required: true - validation: - warnings: [] - information: - - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' - Sage Intacct: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: true - validation: - warnings: [] - information: - - field: Note - details: Must be used to provide payee's name and contain no more than 80 characters. - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - validation: - warnings: [] - information: - - field: TaxRateRef.Id - details: Must be an existing tax rate in Sage Intacct. - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: false - validation: - warnings: [] - information: - - field: LineItems.Description - details: Must not contain no more than 1000 characters. - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: false - subTotal: - type: Number - displayName: Sub Total Amount - description: 'The amount of the line, inclusive of discounts but exclusive of tax' - required: false - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: false - name: - type: String - displayName: Tracking Category Name - description: The name of the category referenced by the identifier - required: false - required: false - required: true - validation: - warnings: [] - information: - - field: LineItems - details: Must contain at least one line item. - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - paidOnDate: - type: DateTime - displayName: Paid On Date - description: The date the payment was paid - required: true - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: false - validation: - warnings: [] - information: - - field: Payment.TotalAmount - details: 'If provided, must match the sum of the line items.' - required: true - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: false - validation: - warnings: [] - information: - - field: Allocation.TotalAmount - details: 'If provided, must match the sum of the line items.' - required: true - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations - details: Must contain a single allocation. - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: - - field: Currency - details: When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail. - information: [] - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: [] - information: - - field: Reference - details: Must not contain no more than 45 characters. - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The amount of the direct transaction, inclusive of tax' - required: false - validation: - warnings: [] - information: - - field: TotalAmount - details: 'If provided, must match the sum of the line items.' - required: true - Sandbox: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: true - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: true - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - required: true - required: true - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: true - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: true - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - required: true - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - name: - type: String - displayName: Name - description: The name of the tax rate referenced by the identifier - required: true - effectiveTaxRate: - type: Number - displayName: Effective Tax Rate - description: 'The total applied tax percentage, including compounding details' - required: true - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - discountAmount: - type: Number - displayName: Discount Amount - description: 'The value, in the given currency, of any discounts applied' - required: true - discountPercentage: - type: Number - displayName: Discount Percentage - description: The percentage rate of any discount that has been applied - required: true - subTotal: - type: Number - displayName: Sub Total Amount - description: 'The amount of the line, inclusive of discounts but exclusive of tax' - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: true - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: true - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: true - name: - type: String - displayName: Name - description: The name of the item referenced by the identifier - required: true - required: true - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - name: - type: String - displayName: Tracking Category Name - description: The name of the category referenced by the identifier - required: true - required: true - tracking: - type: Object - displayName: Tracking - description: Information this item is being tracked against - properties: - recordRefs: - type: Array - displayName: Record References - description: A collection of records this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - required: true - required: true - invoiceTo: - type: Object - displayName: Invoice To - description: The entity the record should be invoiced to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - required: true - required: true - required: true - required: true - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - id: - type: String - displayName: Identifier - description: The identifier for the allocated payment - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the allocated payment - required: true - reference: - type: String - displayName: Reference - description: Reference associated with the allocated payment - required: true - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - required: true - currency: - type: String - displayName: Currency - description: The currency for the payment - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the allocated payment and the currency of the base company - required: true - paidOnDate: - type: DateTime - displayName: Paid On Date - description: The date the payment was paid - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: true - required: true - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the allocated payment and the currency of the transaction - required: true - allocatedOnDate: - type: DateTime - displayName: Allocated On Date - description: The date the payment was allocated - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: true - required: true - required: true - subTotal: - type: Number - displayName: Sub Total Amount - description: The total amount of the direct transaction excluding any taxes - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The total amount of tax on the direct transaction - required: true - totalAmount: - type: Number - displayName: Total Amount - description: 'The amount of the direct transaction, inclusive of tax' - required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item - properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted - required: true - required: true - required: true - Xero: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: true - validation: - warnings: [] - information: - - field: IssueDate - details: Must be provided. - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: [] - information: - - field: Reference - details: Must not exceed 255 characters. - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: true - validation: - warnings: [] - information: - - field: Currency - details: Must be provided. - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - taxAmount: - type: Number - displayName: Tax Amount - description: The total amount of tax on the direct transaction - required: true - validation: - warnings: [] - information: - - field: TaxAmount - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The amount of the direct transaction, inclusive of tax' - required: true - validation: - warnings: [] - information: - - field: TotalAmount - details: Must be provided. - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - validation: - warnings: - - field: ContactRef.Id - details: Must be a valid GUID. - - field: ContactRef.Id - details: Must match the ID of an existing contact. - information: - - field: ContactRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: ContactRef - details: Must be provided. - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a bank account. - - field: AccountRef.Id - details: Must match the ID of an existing bank account. - information: - - field: AccountRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Payment.AccountRef - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations.Payment - details: Must be provided. - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: true - validation: - warnings: - - field: Allocation.TotalAmount - details: Must be equal to the sum of line items. - information: - - field: Allocation.TotalAmount - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations.Allocation - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations - details: Must be provided. - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: true - validation: - warnings: [] - information: - - field: LineItems.Description - details: Must not be longer than 4000 characters long. - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - validation: - warnings: [] - information: - - field: LineItems.Quantity - details: Must be provided. - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - validation: - warnings: [] - information: - - field: LineItems.UnitAmount - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: false - validation: - warnings: - - field: LineItems.TotalAmount - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' - information: - - field: LineItems.TotalAmount - details: 'When one line is negative, all lines must be negative.' - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: true - validation: - warnings: [] - information: - - field: LineItems.TaxAmount - details: Must be provided. - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a valid GUID. - - field: AccountRef.Id - details: Must match the ID of an existing account. - information: - - field: AccountRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: LineItems.AccountRef - details: Must be provided. - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - validation: - warnings: [] - information: - - field: TrackingCategoryRefs.Id - details: Must be provided. - required: false - validation: - warnings: [] - information: - - field: LineItems.TrackingCategoryRefs - details: Tracking categories must not have the same parent tracking category. - - field: LineItems.TrackingCategoryRefs - details: Maximum of 2 Tracking Categories. - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: false - validation: - warnings: - - field: TaxRateRef.Id - details: Must match the ID of an existing tax rate. - information: - - field: TaxRateRef.Id - details: 'If not provided, will be set to the default tax rate for the line''s account.' - required: false - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: false - validation: - warnings: - - field: ItemRef.Id - details: Must be a valid GUID. - - field: ItemRef.Id - details: Must match the ID of an existing item. - information: [] - required: false - required: true - validation: - warnings: [] - information: - - field: LineItems - details: Must be provided. - required: true - validation: - warnings: - - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' - information: [] - Zoho Books: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: false - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: false - required: false - validation: - warnings: [] - information: - - field: ContactRef - details: Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: false - validation: - warnings: [] - information: - - field: LineItems.TotalAmount - details: Should be provided when SubTotal is not provided - subTotal: - type: Number - displayName: Sub Total Amount - description: 'The amount of the line, inclusive of discounts but exclusive of tax' - required: false - validation: - warnings: [] - information: - - field: LineItems.SubTotal - details: Should be provided when TotalAmount is not provided - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: false - required: false - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - required: false - required: true - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: [] - information: - - field: Currency - details: Is required when pushing a negative direct cost - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - currency: - type: String - displayName: Currency - description: The currency for the payment - required: false - validation: - warnings: [] - information: - - field: Payment.Currency - details: Is required when pushing a negative direct cost - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - required: true - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: false - validation: - warnings: [] - information: - - field: Allocation.Currency - details: Is required when pushing a negative direct cost - required: true - required: true - required: true - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: get-create-directCosts-model - 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: TotalAmount - details: Must match the sum of the line amounts. - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: Must match the sum of the link amounts. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: CreditNote - required: false - - value: Other - type: String - displayName: Other - required: false - required: true - required: true - required: true - validation: - warnings: - - field: Lines - details: Only one line may be specified - information: [] - required: true - FreshBooks: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - required: true - required: true - validation: - warnings: - - field: Lines.Links - details: Payment Amount must not exceed Invoice Amount Due or available Customer Credit - - field: Lines.Links - details: Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount - information: [] - required: true - validation: - warnings: - - field: Lines - details: Only one line is supported - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - options: - - value: AED - type: Array - displayName: AED - required: false - - value: AFN - type: Array - displayName: AFN - required: false - - value: ALL - type: Array - displayName: ALL - required: false - - value: AMD - type: Array - displayName: AMD - required: false - - value: ANG - type: Array - displayName: ANG - required: false - - value: AOA - type: Array - displayName: AOA - required: false - - value: ARS - type: Array - displayName: ARS - required: false - - value: AUD - type: Array - displayName: AUD - required: false - - value: AWG - type: Array - displayName: AWG - required: false - - value: AZN - type: Array - displayName: AZN - required: false - - value: BAM - type: Array - displayName: BAM - required: false - - value: BBD - type: Array - displayName: BBD - required: false - - value: BDT - type: Array - displayName: BDT - required: false - - value: BGN - type: Array - displayName: BGN - required: false - - value: BHD - type: Array - displayName: BHD - required: false - - value: BIF - type: Array - displayName: BIF - required: false - - value: BMD - type: Array - displayName: BMD - required: false - - value: BND - type: Array - displayName: BND - required: false - - value: BOB - type: Array - displayName: BOB - required: false - - value: BRL - type: Array - displayName: BRL - required: false - - value: BSD - type: Array - displayName: BSD - required: false - - value: BTN - type: Array - displayName: BTN - required: false - - value: BWP - type: Array - displayName: BWP - required: false - - value: BYR - type: Array - displayName: BYR - required: false - - value: BZD - type: Array - displayName: BZD - required: false - - value: CAD - type: Array - displayName: CAD - required: false - - value: CDF - type: Array - displayName: CDF - required: false - - value: CHF - type: Array - displayName: CHF - required: false - - value: CLP - type: Array - displayName: CLP - required: false - - value: CNY - type: Array - displayName: CNY - required: false - - value: COP - type: Array - displayName: COP - required: false - - value: CRC - type: Array - displayName: CRC - required: false - - value: CUC - type: Array - displayName: CUC - required: false - - value: CUP - type: Array - displayName: CUP - required: false - - value: CVE - type: Array - displayName: CVE - required: false - - value: CZK - type: Array - displayName: CZK - required: false - - value: DJF - type: Array - displayName: DJF - required: false - - value: DKK - type: Array - displayName: DKK - required: false - - value: DOP - type: Array - displayName: DOP - required: false - - value: DZD - type: Array - displayName: DZD - required: false - - value: EGP - type: Array - displayName: EGP - required: false - - value: ERN - type: Array - displayName: ERN - required: false - - value: ETB - type: Array - displayName: ETB - required: false - - value: EUR - type: Array - displayName: EUR - required: false - - value: FJD - type: Array - displayName: FJD - required: false - - value: FKP - type: Array - displayName: FKP - required: false - - value: GBP - type: Array - displayName: GBP - required: false - - value: GEL - type: Array - displayName: GEL - required: false - - value: GGP - type: Array - displayName: GGP - required: false - - value: GHS - type: Array - displayName: GHS - required: false - - value: GIP - type: Array - displayName: GIP - required: false - - value: GMD - type: Array - displayName: GMD - required: false - - value: GNF - type: Array - displayName: GNF - required: false - - value: GTQ - type: Array - displayName: GTQ - required: false - - value: GYD - type: Array - displayName: GYD - required: false - - value: HKD - type: Array - displayName: HKD - required: false - - value: HNL - type: Array - displayName: HNL - required: false - - value: HRK - type: Array - displayName: HRK - required: false - - value: HTG - type: Array - displayName: HTG - required: false - - value: HUF - type: Array - displayName: HUF - required: false - - value: IDR - type: Array - displayName: IDR - required: false - - value: ILS - type: Array - displayName: ILS - required: false - - value: IMP - type: Array - displayName: IMP - required: false - - value: INR - type: Array - displayName: INR - required: false - - value: IQD - type: Array - displayName: IQD - required: false - - value: IRR - type: Array - displayName: IRR - required: false - - value: ISK - type: Array - displayName: ISK - required: false - - value: JEP - type: Array - displayName: JEP - required: false - - value: JMD - type: Array - displayName: JMD - required: false - - value: JOD - type: Array - displayName: JOD - required: false - - value: JPY - type: Array - displayName: JPY - required: false - - value: KES - type: Array - displayName: KES - required: false - - value: KGS - type: Array - displayName: KGS - required: false - - value: KHR - type: Array - displayName: KHR - required: false - - value: KMF - type: Array - displayName: KMF - required: false - - value: KPW - type: Array - displayName: KPW - required: false - - value: KRW - type: Array - displayName: KRW - required: false - - value: KWD - type: Array - displayName: KWD - required: false - - value: KYD - type: Array - displayName: KYD - required: false - - value: KZT - type: Array - displayName: KZT - required: false - - value: LAK - type: Array - displayName: LAK - required: false - - value: LBP - type: Array - displayName: LBP - required: false - - value: LKR - type: Array - displayName: LKR - required: false - - value: LRD - type: Array - displayName: LRD - required: false - - value: LSL - type: Array - displayName: LSL - required: false - - value: LYD - type: Array - displayName: LYD - required: false - - value: MAD - type: Array - displayName: MAD - required: false - - value: MDL - type: Array - displayName: MDL - required: false - - value: MGA - type: Array - displayName: MGA - required: false - - value: MKD - type: Array - displayName: MKD - required: false - - value: MMK - type: Array - displayName: MMK - required: false - - value: MNT - type: Array - displayName: MNT - required: false - - value: MOP - type: Array - displayName: MOP - required: false - - value: MRO - type: Array - displayName: MRO - required: false - - value: MUR - type: Array - displayName: MUR - required: false - - value: MVR - type: Array - displayName: MVR - required: false - - value: MWK - type: Array - displayName: MWK - required: false - - value: MXN - type: Array - displayName: MXN - required: false - - value: MYR - type: Array - displayName: MYR - required: false - - value: MZN - type: Array - displayName: MZN - required: false - - value: NAD - type: Array - displayName: NAD - required: false - - value: NGN - type: Array - displayName: NGN - required: false - - value: NIO - type: Array - displayName: NIO - required: false - - value: NOK - type: Array - displayName: NOK - required: false - - value: NPR - type: Array - displayName: NPR - required: false - - value: NZD - type: Array - displayName: NZD - required: false - - value: OMR - type: Array - displayName: OMR - required: false - - value: PAB - type: Array - displayName: PAB - required: false - - value: PEN - type: Array - displayName: PEN - required: false - - value: PGK - type: Array - displayName: PGK - required: false - - value: PHP - type: Array - displayName: PHP - required: false - - value: PKR - type: Array - displayName: PKR - required: false - - value: PLN - type: Array - displayName: PLN - required: false - - value: PYG - type: Array - displayName: PYG - required: false - - value: QAR - type: Array - displayName: QAR - required: false - - value: RON - type: Array - displayName: RON - required: false - - value: RSD - type: Array - displayName: RSD - required: false - - value: RUB - type: Array - displayName: RUB - required: false - - value: RWF - type: Array - displayName: RWF - required: false - - value: SAR - type: Array - displayName: SAR - required: false - - value: SBD - type: Array - displayName: SBD - required: false - - value: SCR - type: Array - displayName: SCR - required: false - - value: SDG - type: Array - displayName: SDG - required: false - - value: SEK - type: Array - displayName: SEK - required: false - - value: SGD - type: Array - displayName: SGD - required: false - - value: SHP - type: Array - displayName: SHP - required: false - - value: SLL - type: Array - displayName: SLL - required: false - - value: SOS - type: Array - displayName: SOS - required: false - - value: SPL - type: Array - displayName: SPL - required: false - - value: SRD - type: Array - displayName: SRD - required: false - - value: STD - type: Array - displayName: STD - required: false - - value: SVC - type: Array - displayName: SVC - required: false - - value: SYP - type: Array - displayName: SYP - required: false - - value: SZL - type: Array - displayName: SZL - required: false - - value: THB - type: Array - displayName: THB - required: false - - value: TJS - type: Array - displayName: TJS - required: false - - value: TMT - type: Array - displayName: TMT - required: false - - value: TND - type: Array - displayName: TND - required: false - - value: TOP - type: Array - displayName: TOP - required: false - - value: TRY - type: Array - displayName: TRY - required: false - - value: TTD - type: Array - displayName: TTD - required: false - - value: TVD - type: Array - displayName: TVD - required: false - - value: TWD - type: Array - displayName: TWD - required: false - - value: TZS - type: Array - displayName: TZS - required: false - - value: UAH - type: Array - displayName: UAH - required: false - - value: UGX - type: Array - displayName: UGX - required: false - - value: USD - type: Array - displayName: USD - required: false - - value: UYU - type: Array - displayName: UYU - required: false - - value: UZS - type: Array - displayName: UZS - required: false - - value: VEF - type: Array - displayName: VEF - required: false - - value: VND - type: Array - displayName: VND - required: false - - value: VUV - type: Array - displayName: VUV - required: false - - value: WST - type: Array - displayName: WST - required: false - - value: XAF - type: Array - displayName: XAF - required: false - - value: XCD - type: Array - displayName: XCD - required: false - - value: XDR - type: Array - displayName: XDR - required: false - - value: XOF - type: Array - displayName: XOF - required: false - - value: XPF - type: Array - displayName: XPF - required: false - - value: YER - type: Array - displayName: YER - required: false - - value: ZAR - type: Array - displayName: ZAR - required: false - - value: ZMW - type: Array - displayName: ZMW - required: false - - value: ZWD - type: Array - displayName: ZWD - required: false - required: false - validation: - warnings: - - field: Currency - details: Can be used for Payments on Account only - information: [] - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - required: true - MYOB AccountRight and Essentials: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must be a valid GUID. - - field: CustomerRef.Id - details: Must match the ID of an existing customer. - information: - - field: CustomerRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: Must be provided. - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a valid GUID. - - field: AccountRef.Id - details: Must match the ID of an existing account. - information: - - field: AccountRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: AccountRef - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Precision must be maximum of two decimal places. - - field: TotalAmount - details: Must be greater than zero. - information: - - field: TotalAmount - details: Must be provided and must equal the sum of the link items amount. - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must be provided. - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: [] - information: - - field: Reference - details: Must not be greater than 8 characters long. - currency: - type: String - displayName: Currency - description: Currency of the payment - options: - - value: AUD - type: String - displayName: Australian Dollar - required: false - required: true - validation: - warnings: [] - information: - - field: Currency - details: Must be provided. - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: Must be provided. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: [] - information: - - field: Links.Id - details: Must be provided. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: [] - information: - - field: Links.Amount - details: Precision must be maximum of two decimal places. - - field: Links.Amount - details: Must be provided. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - required: false - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines - details: Must be provided. - required: true - Oracle NetSuite: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense') - information: [] - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Must be greater than zero - - field: TotalAmount - details: Must be provided and must be equal to the sum of the lines amounts - information: [] - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: - - field: Currency - details: If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency - information: [] - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: - - field: Reference - details: The id format should be 'location-' - information: - - field: Reference - details: This field can be used to provide a tracking category id (Location only) - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: - - field: Links.Id - details: If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted' - information: [] - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: true - required: true - QuickBooks Desktop: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must match the ID of an existing supplier. - information: [] - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must match the ID of an existing 'Bank' or 'Other Current Asset' account. - information: - - field: AccountRef.Id - details: Not required if total amount of the payment is 0. - required: true - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: - - field: Reference - details: Max length of 20 characters. - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: - - field: Currency - details: Must be a three letter ISO code that matches the currency of the customer. - - field: Currency - details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. - information: - - field: Currency - details: 'If not set, will default to the default currency of the customer.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - validation: - warnings: [] - information: - - field: CurrencyRate - details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' - - field: CurrencyRate - details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Must match the sum of amounts in the lines - information: [] - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: - - field: Lines.Amount - details: Amount plus the sum of amounts in the links must equal 0 - information: [] - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - validation: - warnings: - - field: Links.Type - details: 'Only 1 link with type ''PaymentOnAccount'' may be specified per line, this line may contain no other links' - - field: Links.Type - details: Only 1 link with type 'Invoice' may be specified per line - information: [] - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: true - required: true - QuickBooks Online Sandbox: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: false - validation: - warnings: [] - information: - - field: AccountRef - details: Must match the ID of an existing Account. - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - required: true - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: false - required: true - QuickBooks Online: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: false - validation: - warnings: [] - information: - - field: AccountRef - details: Must match the ID of an existing Account. - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - required: true - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: false - required: true - Sage 50 (UK): - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - accountRef: - type: Object - displayName: Bank Account - description: The bank account to pay this invoice from. - properties: - id: - type: String - displayName: Account Id - description: Nominal code of the bank account. - required: true - validation: - warnings: - - field: accountRef.id - details: Must match the ID of an existing bank account and have a max length of 8 characters. - information: [] - required: true - customerRef: - type: Object - displayName: Customer - description: Customer to be paid. - properties: - id: - type: String - displayName: Customer Id - description: Identifier of the customer. - required: true - validation: - warnings: - - field: customerRef.id - details: Must match the ID of an existing customer and have a max length of 8 characters. - information: [] - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount being paid to the customer. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line amounts - reference: - type: Number - displayName: Reference - description: The user reference for this invoice payment. - required: false - date: - type: Number - displayName: Issue Date - description: The date this payment was issued. - required: true - note: - type: Number - displayName: Note - description: A description of the payment. - required: false - lines: - type: Array - displayName: Line Items - description: Line items of the payment. - properties: - amount: - type: Number - displayName: Amount - description: The amount of this line item - required: true - validation: - warnings: [] - information: - - details: this must equal the negative of the sum of the link amounts - links: - type: Array - displayName: Links - description: Links to the invoice being paid. - properties: - amount: - type: Number - displayName: Amount - description: The amount to be added to the value of the invoice - required: true - validation: - warnings: [] - information: - - details: 'When paying off an invoice, this value will be negative' - id: - type: String - displayName: Invoice Id - description: The ID of the invoice to pay - required: true - type: - type: String - displayName: Payment Link Type - description: The type of the item to be paid - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - - value: Refund - type: String - displayName: Refund - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: Payment - type: String - displayName: Payment - required: false - required: true - required: true - required: true - validation: - warnings: [] - information: - - details: Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response. - required: true - validation: - warnings: [] - information: - - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' - Sage Business Cloud Accounting: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must match the ID of an existing Account. - information: - - field: AccountRef.Id - details: Must be provided. - required: false - validation: - warnings: - - field: AccountRef - details: Required unless the Payment is only allocating a Credit Note. - information: [] - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must match the ID of an existing Customer. - information: - - field: CustomerRef.Id - details: Must be provided. - required: true - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Must be zero when allocating against Invoices using a Credit Note only. - - field: TotalAmount - details: Must equal the sum of the link items amount. - information: - - field: TotalAmount - details: Must be provided. - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - validation: - warnings: - - field: Note - details: Should not be longer than 25 characters. - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: [] - information: - - field: Currency - details: 'If supplied, must match the currency of the customer.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: [] - information: - - field: Links.Id - details: Must be provided. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: - - field: Links.Amount - details: Must be greater than zero except when Type is Invoice - information: - - field: Links.Amount - details: Must be provided. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: PaymentOnAccount - type: String - displayName: PaymentOnAccount - required: false - - value: Refund - type: String - displayName: Refund - required: false - - value: CreditNote - type: String - displayName: CreditNote - required: false - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: Must be provided. - required: true - required: true - Sage Intacct: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: [] - information: - - field: TotalAmount - details: Must equal the sum of Lines.Amount. - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - validation: - warnings: [] - information: - - field: Note - details: Must be less than 1000 characters. - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - options: - - value: '1' - type: String - displayName: Printed Check - required: false - - value: '3' - type: String - displayName: Credit Card - required: false - - value: '5' - type: String - displayName: EFT - required: false - - value: '6' - type: String - displayName: Cash - required: false - required: true - required: true - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: [] - information: - - field: Reference - details: Can be used to set the Document/Check No. in Sage Intacct. - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - validation: - warnings: [] - information: - - field: CurrencyRate - details: Is required if currency is provided. - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must occur after the date the invoice was created. - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: [] - information: - - field: CustomerRef.Id - details: Must be an existing customer ID in Sage Intacct. - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: [] - information: - - field: AccountRef.Id - details: For undeposited payments use the GL account record number to charge. - - field: AccountRef.Id - details: 'To charge either a savings, checking or credit card account use its associated GL account number.' - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: When added together with the sum of the Links.Amount the total must be zero. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: [] - information: - - field: Links.Id - details: 'Must be a valid Record No. from accounts receivable of either an invoice for an ''Invoice'', adjustment for a ''CreditNote'' or an advance for a ''PaymentOnAccount'' in Sage Intacct.' - - field: Links.Id - details: Must be an integer. - - field: Links.Id - details: Must related to CustomerRef.Id in Sage Intacct. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be one of Invoiceor CreditNoteor PaymentOnAccount. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: [] - information: - - field: Links.Amount - details: Must not be more than the total amount due for an invoice or the available funds in the account to be charged. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount. - - field: Lines.Links - details: Must contain only one Invoice. - required: true - validation: - warnings: [] - information: - - field: Lines - details: Must contain at least one payment line. - required: true - validation: - warnings: [] - information: - - details: Sage Intacct handles allocated payments only. - Sandbox: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - companyName: - type: String - displayName: Name - description: The name of the customer referenced by the identifier - required: true - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - required: true - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - required: true - name: - type: String - displayName: Name - description: The name of the payment method referenced by the identifier - required: true - required: true - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: true - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - required: true - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the currency of the linked transaction - required: true - required: true - allocatedOnDate: - type: DateTime - displayName: Allocated On Date - description: The date the payment was allocated - required: true - required: true - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item - properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted - required: true - required: true - required: true - Xero: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must be a valid GUID. - - field: CustomerRef.Id - details: Must match the ID of an existing account. - information: - - field: CustomerRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: Must be provided. - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a valid GUID. - - field: AccountRef.Id - details: Must match the ID of an existing account. - information: - - field: AccountRef.Id - details: Must be either a type of BANK account or enable payments must be switched on. - required: true - validation: - warnings: [] - information: - - field: AccountRef - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: 'Must be greater than 0, unless the payment is a credit note allocation.' - information: - - field: TotalAmount - details: Must be provided and must equal the sum of the link items amount. - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must be provided. - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - validation: - warnings: [] - information: - - field: Currency - details: Must be provided. - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: Must be provided. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: - - field: Links.Id - details: Must be a valid GUID. - information: - - field: Links.Id - details: Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice. - - field: Links.Id - details: Must be provided. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: [] - information: - - field: Links.Amount - details: Must be provided. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: CreditNote - required: false - - value: Payment - type: String - displayName: Payment - required: false - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines - details: Must be provided. - required: true - Zoho Books: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: AccountRef.ID is required when making a payment to an invoice and/or a payment on account - information: [] - required: true - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - validation: - warnings: - - field: Currency - details: must match the currency of any invoices or credit notes - information: [] - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: must be greater than or equal to 0 - information: [] - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: - - field: Links.Amount - details: the sum of all link amounts must equal the negated total amount of the payment - information: [] - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - type: Array - displayName: Invoice - required: false - - type: Array - displayName: CreditNote - required: false - - type: Array - displayName: PaymentOnAccount - required: false - required: true - required: true - validation: - warnings: - - field: Lines.Links - details: 'if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed' - information: [] - required: true - required: true - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: get-create-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 push operations - tags: - - Push data - operationId: get-company-push-history - x-speakeasy-name-override: list-operations - description: |- - The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - 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}/push/{pushOperationKey}': - parameters: - - $ref: '#/components/parameters/companyId' - - schema: - type: string - format: uuid - name: pushOperationKey - in: path - required: true - description: Push operation key. - get: - summary: Get push operation - tags: - - Push data - operationId: get-push-operation - x-speakeasy-name-override: get-operation - description: |- - The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - 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' - '/integrations/{platformKey}/dataTypes/{dataType}/supplementalDataConfig': - parameters: - - $ref: '#/components/parameters/platformKey' - - name: dataType - in: path - required: true - description: Supported supplemental data data type. - schema: - x-internal: true - type: string - description: Data types that support supplemental data - enum: - - chartOfAccounts - - bills - - company - - creditNotes - - customers - - invoices - - items - - journalEntries - - suppliers - - taxRates - - commerce-companyInfo - - commerce-customers - - commerce-disputes - - commerce-locations - - commerce-orders - - commerce-payments - - commerce-paymentMethods - - commerce-products - - commerce-productCategories - - commerce-taxComponents - - commerce-transactions - example: invoices - put: - summary: Configure - description: |- - The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination. - - [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types. - - **Integration-specific behavior** - See the *examples* for integration-specific frequently requested properties. - operationId: configure-supplemental-data - x-speakeasy-name-override: configure - tags: - - Supplemental data - responses: - '200': - description: OK - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SupplementalDataConfiguration' - examples: - Xero - Accounts: - value: - yourKeyNameForAccounts: - dataSource: /Accounts - pullData: - yourNameForTaxType: TaxType - yourNameForSystemAccount: SystemAccount - Xero - Invoices: - value: - yourKeyNameForInvoices: - dataSource: /Invoices - pullData: - yourNameForExpectedPaymentDate: ExpectedPaymentDate - yourNameForHasAttachments: HasAttachments - Xero - Items: - value: - yourKeyNameForItems: - dataSource: /Items - pullData: - yourNameForQuantityOnHand: QuantityOnHand - yourNameForTotalCostPool: TotalCostPool - Xero - Contacts: - value: - yourKeyNameForContacts: - dataSource: /Contacts - pullData: - yourNameForBankAccounts: BankAccountDetails - Xero - Tax rates: - value: - yourKeyNameForTaxRates: - dataSource: /TaxRates - pullData: - yourNameForCanApplyToLiabilities: CanApplyToLiabilities - yourNameForCanApplyToAssets: CanApplyToAssets - yourNameForCanApplyToEquity: CanApplyToEquity - yourNameForCanApplyToExpenses: CanApplyToExpenses - yourNameForCanApplyToRevenue: CanApplyToRevenue - QBO - Customers: - value: - yourKeyNameForCustomers: - dataSource: /Customer - pullData: - yourNameForSalesTermRef: SalesTermRef.value - yourNameForParentRef: ParentRef.value - QBO - Invoices: - value: - yourKeyNameForInvoices: - dataSource: /Invoice - pullData: - yourNameForSalesTermRef: SalesTermRef.value - description: The configuration for the specified platform and data type. - get: - summary: Get configuration - description: |- - The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination. - - [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types. - operationId: get-supplemental-data-configuration - x-speakeasy-name-override: get-configuration - tags: - - Supplemental data - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SupplementalDataConfiguration' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}': - parameters: - - $ref: '#/components/parameters/platformKey' - - $ref: '#/components/parameters/customDataIdentifier' - put: - summary: Configure custom data type - description: |- - The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration. - - A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model. - - ### Tips and traps - - - You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms. - - - You can only indicate a single data source for each customer data type. - - - Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way. - operationId: configure-custom-data-type - x-speakeasy-name-override: configure - tags: - - Custom data type - requestBody: - description: Custom data type configuration for the specified platform. - content: - application/json: - schema: - $ref: '#/components/schemas/CustomDataTypeConfiguration' - examples: - Dynamics 365 Business Central: - value: - dataSource: api/purchaseOrders - requiredData: - currency: '$[*].currencyCode' - number: '$[*].number' - date: '$[*].orderDate' - totalexvat: '$[*].totalAmountExcludingTax' - totaltax: '$[*].totalTaxAmount' - vendor: '$[*].number' - keyBy: - - '$[*].id' - sourceModifiedDate: - - '$[*].lastModifiedDateTime' - Xero Simple Record: - value: - dataSource: /api.xro/2.0/Accounts - requiredData: - code: $.Code - accountId: $.AccountID - type: $.Type - SysAcc: $.SystemAccount - keyBy: - - $.AccountID - Xero Mapping Arrays: - value: - dataSource: /api.xro/2.0/Invoices - requiredData: - invNumber: $.InvoiceNumber - type: $.Type - InvoiceID: $.InvoiceID - lines: '$.LineItems[*]' - keyBy: - - $.InvoiceID - sourceModifiedDate: - - $.UpdatedDateUTC - QuickBooks Online: - value: - dataSource: /query?query=select * from Account - requiredData: - id: $.Id - Currentbal: $.CurrentBalance - SubAcc: $.SubAccount - keyBy: - - $.Id - sourceModifiedDate: - - $.time - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CustomDataTypeConfiguration' - examples: - Dynamics 365 Business Central: - value: - dataSource: api/purchaseOrders - requiredData: - currency: '$[*].currencyCode' - number: '$[*].number' - date: '$[*].orderDate' - totalexvat: '$[*].totalAmountExcludingTax' - totaltax: '$[*].totalTaxAmount' - vendor: '$[*].number' - keyBy: - - '$[*].id' - sourceModifiedDate: - - '$[*].lastModifiedDateTime' - Xero Simple Record: - value: - dataSource: /api.xro/2.0/Accounts - requiredData: - code: $.Code - accountId: $.AccountID - type: $.Type - SysAcc: $.SystemAccount - keyBy: - - $.AccountID - Xero Mapping Arrays: - value: - dataSource: /api.xro/2.0/Invoices - requiredData: - invNumber: $.InvoiceNumber - type: $.Type - InvoiceID: $.InvoiceID - lines: '$.LineItems[*]' - keyBy: - - $.InvoiceID - sourceModifiedDate: - - $.UpdatedDateUTC - QuickBooks Online: - value: - dataSource: /query?query=select * from Account - requiredData: - id: $.Id - Currentbal: $.CurrentBalance - SubAcc: $.SubAccount - keyBy: - - $.Id - sourceModifiedDate: - - $.time - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - get: - summary: Get custom data configuration - description: |- - The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured. - - A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model. - operationId: get-custom-data-type-configuration - x-speakeasy-name-override: get-configuration - tags: - - Custom data type - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CustomDataTypeRecords' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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}/data/queue/custom/{customDataIdentifier}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/customDataIdentifier' - post: - summary: Refresh custom data type - description: The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view. - operationId: refresh-custom-data-type - x-speakeasy-name-override: refresh - tags: - - Custom data type - responses: - '200': - description: OK - '/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' - '451': - $ref: '#/components/responses/Legal-Reasons' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/customDataIdentifier' - get: - summary: List custom data type records - description: |- - The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured. - - A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type) - operationId: list-custom-data-type-records - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - tags: - - Custom data type - '/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': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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/CustomDataTypeRecords' - '400': - $ref: '#/components/responses/Bad-Request' - $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' - '451': - $ref: '#/components/responses/Legal-Reasons' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' -webhooks: - company.created: - post: - description: Called when a company is created in Codat. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyWebhook' - examples: - Company created: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: company.created - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Bank of Dave - description: Requested a loan for refurb. - redirect: 'https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2' - lastSync: '2022-01-01T12:00:00.000Z' - created: '2022-01-01T12:00:00.000Z' - tags: - customerRegion: us - uid: 335a086e-8563-4b03-94e3-39544225ecb6 - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - company.deleted: - post: - description: Called when a company is deleted in Codat. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyWebhook' - examples: - Company deleted: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: company.deleted - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Bank of Dave - description: Requested a loan for refurb. - redirect: 'https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2' - lastSync: '2022-01-01T12:00:00.000Z' - created: '2022-01-01T12:00:00.000Z' - tags: - customerRegion: uk - uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.created: - post: - description: Called when a connection is created by the SMB. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Connection created: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.created - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: PendingAuth - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.connected: - post: - description: Called when a connection is successfully linked by the SMB. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Connection connected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.connected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.failed: - post: - description: Called when a connection failed linking to the SMB. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Connection failed: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.failed - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: PendingAuth - created: '2022-10-27T09:53:29Z' - sourceType: Banking - dataConnectionErrors: - - statusCode: '403' - statusText: User cancelled linking - errorMessage: User cancelled - erroredOnUtc: '2022-10-27T09:53:29Z' - status: Active - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.disconnected: - post: - description: Called when a connection is disconnected either due to being unlinked or de-authorized by the SMB or integration. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Unlinked: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.disconnected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Unlinked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - De-authorized: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.disconnected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Deauthorized - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - dataConnectionErrors: - - statusCode: '401' - statusText: The integration de-authorized access to the connection. - errorMessage: The integration de-authorized access to the connection. - erroredOnUtc: '2022-12-27T09:53:29Z' - status: Active - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.reconnected: - post: - description: Called when a connection is reconnected after becoming disconnected. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Reconnected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.reconnected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.deleted: - post: - description: Called when a connection is deleted. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Deleted: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.deleted - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - read.completed: - post: - description: Called when the fetch of data types for a product has completed. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ReadCompletedWebhook' - examples: - Read completed with validation warnings: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed - 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' - modifiedFromDate: '2022-10-23T00:00:00.000Z' - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: - - type: warning.validation - message: Something doesn't look right about these invoices. You can see more information in the logs. - links: - logs: 'https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/743ec94a-8aa4-44bb-8bd4-e1855ee0e74b/validation' - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history' - readMore: 'https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation' - Read completed without issues: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed - 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' - modifiedFromDate: '2022-10-23T00:00:00.000Z' - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: [] - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - read.completed.initial: - post: - description: Called when the initial fetch of data types for a product has been completed. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ReadCompletedWebhook' - examples: - Initial with validation warnings: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed.initial - 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' - modifiedFromDate: '2022-10-23T00:00:00.000Z' - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: - - type: warning.validation - message: Something doesn't look right about these invoices. You can see more information in the logs. - links: - logs: 'https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/743ec94a-8aa4-44bb-8bd4-e1855ee0e74b/validation' - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history' - readMore: 'https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation' - Initial without issues: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed.initial - 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' - modifiedFromDate: '2022-10-23T00:00:00.000Z' - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: [] - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - '{dataType}.write.successful': - post: - description: | - Indicates that a `dataType` has been successfully created, updated, deleted, or had an attachment uploaded in the accounting software. - - Codat now refers to push operations as write requests. - - For example, to subscribe to events where a bill is written into the accounting software, use the `bills.write.successful` webhook. - - ### Supported data types and write types - - | `dataType` | Create | Update | Delete | UploadAttachment | - |------------------|---------|---------|---------|------------------| - | bankAccounts | ✅ | ✅ | - | - | - | bankTransactions | ✅ | - | - | - | - | billCreditNotes | ✅ | ✅ | - | ✅ | - | billPayments | ✅ | - | ✅ | - | - | bills | ✅ | ✅ | ✅ | ✅ | - | chartOfAccounts | ✅ | - | - | - | - | creditNotes | ✅ | ✅ | - | - | - | customers | ✅ | ✅ | - | - | - | directCosts | ✅ | - | ✅ | ✅ | - | directIncomes | ✅ | - | - | ✅ | - | invoices | ✅ | ✅ | ✅ | ✅ | - | items | ✅ | - | - | - | - | journalEntries | ✅ | - | ✅ | - | - | journals | ✅ | - | - | - | - | payments | ✅ | - | - | - | - | purchaseOrders | ✅ | ✅ | - | - | - | suppliers | ✅ | ✅ | - | - | - | transfers | ✅ | - | - | ✅ | - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataTypeWriteWebhook' - examples: - Record: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.successful' - generatedDate: '2023-05-03T10:00:23Z' - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: Create - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: '2023-05-03T10:00:00Z' - completedOnDate: '2023-05-03T10:00:23Z' - status: Success - record: - id: bil_1Nispe2eZvKYlo2Cd31jOCgZ - Attachment: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.successful' - generatedDate: '2023-05-03T10:00:23Z' - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: UploadAttachment - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: '2023-05-03T10:00:00Z' - completedOnDate: '2023-05-03T10:00:23Z' - status: Success - record: - id: bil_1Nispe2eZvKYlo2Cd31jOCgZ - attachmentId: att_1AZtxr2eZvKYlo2CJDX8whov - responses: - '200': - description: Return a 200 status to indicate that the webhook was received. - '{dataType}.write.unsuccessful': - post: - description: | - Indicates that a `dataType` has not been successfully created, updated, deleted, or had an attachment uploaded in the accounting software. - - Codat now refers to push operations as write requests. - - For example, to subscribe to events where a bill is written into the accounting software, use the `bills.write.unsuccessful` webhook. - - ### Supported data types and write types - - | `dataType` | Create | Update | Delete | UploadAttachment | - |------------------|---------|---------|---------|------------------| - | bankAccounts | ✅ | ✅ | - | - | - | bankTransactions | ✅ | - | - | - | - | billCreditNotes | ✅ | ✅ | - | ✅ | - | billPayments | ✅ | - | ✅ | - | - | bills | ✅ | ✅ | ✅ | ✅ | - | chartOfAccounts | ✅ | - | - | - | - | creditNotes | ✅ | ✅ | - | - | - | customers | ✅ | ✅ | - | - | - | directCosts | ✅ | - | ✅ | ✅ | - | directIncomes | ✅ | - | - | ✅ | - | invoices | ✅ | ✅ | ✅ | ✅ | - | items | ✅ | - | - | - | - | journalEntries | ✅ | - | ✅ | - | - | journals | ✅ | - | - | - | - | payments | ✅ | - | - | - | - | purchaseOrders | ✅ | ✅ | - | - | - | suppliers | ✅ | ✅ | - | - | - | transfers | ✅ | - | - | ✅ | - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataTypeWriteWebhook' - examples: - Record: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.unsuccessful' - generatedDate: '2023-05-03T10:00:23Z' - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: Update - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: '2023-05-03T10:00:00Z' - completedOnDate: '2023-05-03T10:00:23Z' - status: Failed - Record timed out: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.unsuccessful' - generatedDate: '2023-05-03T10:00:23Z' - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: Delete - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: '2023-05-03T10:00:00Z' - completedOnDate: '2023-05-03T10:00:23Z' - status: TimedOut - Attachment: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.unsuccessful' - generatedDate: '2023-05-03T10:00:23Z' - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: UploadAttachment - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: '2023-05-03T10:00:00Z' - completedOnDate: '2023-05-03T10:00:23Z' - status: TimedOut - record: - id: bil_1Nispe2eZvKYlo2Cd31jOCgZ - responses: - '200': - description: Return a 200 status to indicate that the webhook was received. - 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. -components: - schemas: - ApiKeyDetails: - title: API key details - description: Details of the API key. - 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: Unique identifier for the API key. - example: e288a972-b402-4b21-93f9-b5335ae5679c - name: - type: string - maxLength: 50 - nullable: true - description: A meaningful name assigned to the API key. - example: azure-invoice-finance-processor - apiKey: - type: string - description: The API key value used to make authenticated http requests. - example: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - - nullable: true - description: Datetime in UTC the API key was created. The created date will be null if the API key created before YYYY-MM-DD. - title: Created date - type: object - x-internal: true - properties: - createdDate: - $ref: '#/components/schemas/DateTime' - description: The date the entity was created. - ApiKeys: - title: API keys - x-internal: true - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/ApiKeyDetails' - Branding: - title: Branding - type: object - properties: - logo: - $ref: '#/components/schemas/Branding/definitions/brandingLogo' - button: - $ref: '#/components/schemas/Branding/definitions/brandingButton' - 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`.' - definitions: - brandingLogo: - description: Logo branding references. - type: object - properties: - full: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - square: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - brandingButton: - type: object - description: Button branding references. - properties: - default: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - hover: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - brandingImage: - title: Branding Image - type: object - properties: - image: - $ref: '#/components/schemas/Branding/definitions/imageReference' - examples: [] - imageReference: - type: object - title: Image Reference - description: Image reference. - properties: - src: - type: string - format: uri - description: Source URL for image. - alt: - type: string - description: Alternative text when image is not available. - examples: - - logo: - full: - image: - src: 'https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png' - alt: xero full icon - square: - image: - src: 'https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png' - alt: xero square icon - button: - default: - image: - src: 'https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png' - alt: xero default button icon - hover: - image: - src: 'https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png' - alt: xero hover button icon - sourceId: 35b92968-9851-4095-ad60-395c95cbcba4 - ClientId: - title: Client ID - type: string - format: uuid - description: Unique identifier for your client in Codat. - 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 + title: Data statuses + x-internal: true 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 + 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/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' + $ref: '#/components/schemas/DataStatus' + nullable: true + journalEntries: + $ref: '#/components/schemas/DataStatus' + nullable: true + journals: + $ref: '#/components/schemas/DataStatus' + nullable: true + paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + profitAndLoss: + $ref: '#/components/schemas/DataStatus' + nullable: true + purchaseOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + salesOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + suppliers: + $ref: '#/components/schemas/DataStatus' + nullable: true + taxRates: + $ref: '#/components/schemas/DataStatus' + nullable: true + trackingCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + transfers: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accountBalances: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactionCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-companyInfo: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-disputes: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-locations: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-orders: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-productCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-products: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-taxComponents: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + examples: + Example: + value: + accountTransactions: + dataType: accountTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + balanceSheet: + dataType: balanceSheet + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankAccounts: + dataType: bankAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankTransactions: + dataType: bankTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billCreditNotes: + dataType: billCreditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billPayments: + dataType: billPayments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bills: + dataType: bills + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + cashFlowStatement: + dataType: cashFlowStatement + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + chartOfAccounts: + dataType: chartOfAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + company: + dataType: company + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + creditNotes: + dataType: creditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + customers: + dataType: customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directCosts: + dataType: directCosts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directIncomes: + dataType: directIncomes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + invoices: + dataType: invoices + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + itemReceipts: + dataType: itemReceipts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + items: + dataType: items + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journalEntries: + dataType: journalEntries + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journals: + dataType: journals + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + paymentMethods: + dataType: paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + payments: + dataType: payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + profitAndLoss: + dataType: profitAndLoss + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + purchaseOrders: + dataType: purchaseOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + salesOrders: + dataType: salesOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + suppliers: + dataType: suppliers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + taxRates: + dataType: taxRates + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + trackingCategories: + dataType: trackingCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + transfers: + dataType: transfers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accountBalances: + dataType: banking-accountBalances + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accounts: + dataType: banking-accounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactionCategories: + dataType: banking-transactionCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactions: + dataType: banking-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-companyInfo: + dataType: commerce-companyInfo + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-customers: + dataType: commerce-customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-disputes: + dataType: commerce-disputes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-locations: + dataType: commerce-locations + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-orders: + dataType: commerce-orders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-paymentMethods: + dataType: commerce-paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-payments: + dataType: commerce-payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-productCategories: + dataType: commerce-productCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-products: + dataType: commerce-products + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-taxComponents: + dataType: commerce-taxComponents + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-transactions: + dataType: commerce-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/queue/{dataType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataType' + post: + summary: Refresh data type + operationId: refresh-data-type description: |- - ## Overview + Refreshes a given data type for a given company. - 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. + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + tags: + - Manage data + parameters: + - schema: + type: string + format: uuid + in: query + name: connectionId + description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/history': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List pull operations + tags: + - Manage data + operationId: list-pull-operations + x-speakeasy-name-override: list-pull-operations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperations' + examples: + Example: + value: + results: + - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b + companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 + connectionId: 51baa045-4836-4317-a42e-3542e991e581 + dataType: invoices + status: Initial + requested: '2022-11-14T11:18:37.2798351Z' + progress: 10 + isCompleted: false + isErrored: false + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets the pull operation history (datasets) for a given company. + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/data/history/{datasetId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: datasetId + in: path + required: true + schema: type: string - 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' + format: uuid + description: Unique identifier for the dataset that completed its sync. + description: Unique identifier for the dataset that completed its sync. + get: + summary: Get pull operation + operationId: get-pull-operation + x-speakeasy-name-override: get-pull-operation + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Retrieve information about a single dataset or pull operation. + '/companies/{companyId}/push': + parameters: + - $ref: '#/components/parameters/companyId' + get: + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + summary: List push operations + tags: + - Push operations + operationId: list-push-operations + description: List push operation records. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperations' + examples: {} + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/push/{pushOperationKey}': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + format: uuid + name: pushOperationKey + in: path + required: true + description: Push operation key. + get: + summary: Get push operation + tags: + - Push operations + operationId: get-push-operation + description: Retrieve push operation. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/push/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Accounts + summary: Create account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Account/definitions/accountPrototype' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create account* endpoint creates a new [account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). + operationId: create-account + '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create account model + tags: + - Accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + Exact (UK): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: Name + details: Must have a length between 1 and 60 characters + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Must have a length between 1 and 255 characters + information: [] + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank + type: String + displayName: Bank + required: false + - value: Asset.AccountReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Asset.CashAndBank + type: String + displayName: Cash + required: false + - value: Asset.Property Plant and Equipment + type: String + displayName: Equipment Machinery + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherLiability + type: String + displayName: Other Liability + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Equity.Equity + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Owner's Equity + type: String + displayName: Retained Earnings + required: false + - value: Income + type: String + displayName: Income + required: false + - value: OtherIncome + type: String + displayName: Other Income + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Expense.Expense + type: String + displayName: Sales Marketing + required: false + - value: Expense.Expense.Insurance + type: String + displayName: General Administrative + required: false + - value: Expense.Overhead + type: String + displayName: General Administrative + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repairs Maintenance + required: false + - value: OtherExpense + type: String + displayName: Other Expense + required: false + - value: CostOfSales + type: String + displayName: Cost of Sales + required: false + - value: Cost Of Goods Sold.Cost of Sales + type: String + displayName: Other + required: false + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Max length of 31 characters. + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Max length of 200 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.AccountsReceivable + type: String + displayName: Account Receivable + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Income.Income + type: String + displayName: Income + required: false + - value: Income.OtherIncome + type: String + displayName: Other Income + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.CostOfGoodsSold + type: String + displayName: Cost Of Goods Sold + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.OtherExpense + type: String + displayName: Other Expense + required: false + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Should not be longer than 200 characters. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: SALES + type: String + displayName: Sales + required: false + - value: OTHER_INCOME + type: String + displayName: Other Income + required: false + - value: DIRECT_EXPENSES + type: String + displayName: Direct Expenses + required: false + - value: OVERHEADS + type: String + displayName: Overheads + required: false + - value: DEPRECIATION + type: String + displayName: Depreciation + required: false + - value: CURRENT_ASSETS + type: String + displayName: Current Assets + required: false + - value: FIXED_ASSETS + type: String + displayName: Fixed Assets + required: false + - value: FUTURE_ASSETS + type: String + displayName: Future Assets + required: false + - value: BANK + type: String + displayName: Bank + required: false + - value: CURRENT_LIABILITY + type: String + displayName: Current Liability + required: false + - value: FUTURE_LIABILITY + type: String + displayName: Future Liability + required: false + - value: EQUITY + type: String + displayName: Equity + required: false + - value: LINE_OF_CREDIT + type: String + displayName: Credit Card / Loan + required: false + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Must be unique within the entity. + - field: NominalCode + details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + options: + - value: Asset + type: String + displayName: Asset + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Income + type: String + displayName: Income + required: false + - value: Liability + type: String + displayName: Liability + required: false + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' + required: true + Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + description: + type: String + displayName: Description + description: Description of the account + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + fullyQualifiedName: + type: String + displayName: Fully Qualified Name + description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales + required: true + currency: + type: String + displayName: Currency + description: The currency of the account + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + required: true + status: + type: String + displayName: Account Status + description: The status of the account + required: true + isBankAccount: + type: Boolean + displayName: Is Bank Account? + description: Confirms whether the nominal account represents a bank account or not + required: true + validDatatypeLinks: + type: Array + displayName: Valid Datatype Links + description: Describes which fields on other data types are valid links to this account in the originating system + properties: + property: + type: String + displayName: Property + description: The field on the source data type that other data types can link to + required: true + links: + type: Array + displayName: Links + description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: Identifier for the nominal account. + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 10 characters. + information: [] + name: + type: String + displayName: Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + validation: + warnings: [] + information: + - field: Name + details: Payments are enabled to this account if the name ends in .PaymentsEnabled. + description: + type: String + displayName: Description + description: Description for the nominal account. + required: false + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: Account type and category for nominal account. + options: + - value: Asset.Current + type: String + displayName: Current Asset + required: false + - value: Asset.Fixed + type: String + displayName: Fixed Asset + required: false + - value: Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.NonCurrent + type: String + displayName: Non-current Asset + required: false + - value: Asset.Prepayment + type: String + displayName: Prepayment + required: false + - value: Expense.DirectCosts + type: String + displayName: Direct Costs + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.Overhead + type: String + displayName: Overhead + required: false + - value: Expense.Superannuation + type: String + displayName: Superannuation + required: false + - value: Expense.Wages + type: String + displayName: Wages + required: false + - value: Income.Sales + type: String + displayName: Sales + required: false + - value: Income.Revenue + type: String + displayName: Revenue + required: false + - value: Income.Other + type: String + displayName: Other Income + required: false + - value: Liability.Current + type: String + displayName: Current Liability + required: false + - value: Liability.Depreciation + type: String + displayName: Depreciation + required: false + - value: Liability.Liability + type: String + displayName: Liability + required: false + - value: Liability.NonCurrent + type: String + displayName: Non Current Liability + required: false + - value: Liability.PayAsYouGo + type: String + displayName: Pay As You Go Liability + required: false + - value: Liability.Superannuation + type: String + displayName: Superannuation Liability + required: false + - value: Liability.WagesPayable + type: String + displayName: Wages Payable Liability + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-chartOfAccounts-model description: |- - > **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. + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) for a given company and integration. - **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. + [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. - 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 + **Integration-specific behavior** - 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. + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Bank accounts + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankAccount' + examples: + QuickBooks Online: + value: + accountName: GBP Bank Account + accountType: Debit + accountNumber: '12345678' + currency: GBP + status: Active + Xero: + value: + accountName: Xero GBP Bank Account + accountType: Debit + sortCode: '445566' + accountNumber: '12345678' + currency: GBP + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBankAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create bank account + description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model)." + operationId: create-bank-account + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create bank account model + tags: + - Bank accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' examples: - - +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' + Dynamics 365 Business Central: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: 'Needs to be of the format ''{No.}-{Name}''' + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Bank Account Posting Group with Nominal Account must exist + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Must have a length between 0 and 20 characters + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: false + validation: + warnings: [] + information: + - field: OverdraftLimit + details: Default value is 0 + required: true + Exact (Netherlands): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must have a length between 0 and 8 characters + information: [] + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account + options: + - value: AED + type: String + displayName: AED + required: false + - value: AMD + type: String + displayName: AMD + required: false + - value: AOA + type: String + displayName: AOA + required: false + - value: ARS + type: String + displayName: ARS + required: false + - value: AUD + type: String + displayName: AUD + required: false + - value: AWG + type: String + displayName: AWG + required: false + - value: AZN + type: String + displayName: AZN + required: false + - value: BBD + type: String + displayName: BBD + required: false + - value: BDT + type: String + displayName: BDT + required: false + - value: BGN + type: String + displayName: BGN + required: false + - value: BRL + type: String + displayName: BRL + required: false + - value: BWP + type: String + displayName: BWP + required: false + - value: CAD + type: String + displayName: CAD + required: false + - value: CHF + type: String + displayName: CHF + required: false + - value: CLP + type: String + displayName: CLP + required: false + - value: CNY + type: String + displayName: CNY + required: false + - value: COP + type: String + displayName: COP + required: false + - value: CRC + type: String + displayName: CRC + required: false + - value: CUC + type: String + displayName: CUC + required: false + - value: CUP + type: String + displayName: CUP + required: false + - value: CZK + type: String + displayName: CZK + required: false + - value: DKK + type: String + displayName: DKK + required: false + - value: DOP + type: String + displayName: DOP + required: false + - value: EGP + type: String + displayName: EGP + required: false + - value: EUR + type: String + displayName: EUR + required: false + - value: FJD + type: String + displayName: FJD + required: false + - value: GBP + type: String + displayName: GBP + required: false + - value: GEL + type: String + displayName: GEL + required: false + - value: GHS + type: String + displayName: GHS + required: false + - value: GTQ + type: String + displayName: GTQ + required: false + - value: GYD + type: String + displayName: GYD + required: false + - value: HKD + type: String + displayName: HKD + required: false + - value: HNL + type: String + displayName: HNL + required: false + - value: HRK + type: String + displayName: HRK + required: false + - value: HUF + type: String + displayName: HUF + required: false + - value: IDR + type: String + displayName: IDR + required: false + - value: ILS + type: String + displayName: ILS + required: false + - value: INR + type: String + displayName: INR + required: false + - value: ISK + type: String + displayName: ISK + required: false + - value: JMD + type: String + displayName: JMD + required: false + - value: JPY + type: String + displayName: JPY + required: false + - value: KES + type: String + displayName: KES + required: false + - value: KRW + type: String + displayName: KRW + required: false + - value: KWD + type: String + displayName: KWD + required: false + - value: KYD + type: String + displayName: KYD + required: false + - value: KZT + type: String + displayName: KZT + required: false + - value: LAK + type: String + displayName: LAK + required: false + - value: LBP + type: String + displayName: LBP + required: false + - value: LKR + type: String + displayName: LKR + required: false + - value: LTL + type: String + displayName: LTL + required: false + - value: LVL + type: String + displayName: LVL + required: false + - value: MAD + type: String + displayName: MAD + required: false + - value: MDL + type: String + displayName: MDL + required: false + - value: MGA + type: String + displayName: MGA + required: false + - value: MUR + type: String + displayName: MUR + required: false + - value: MVR + type: String + displayName: MVR + required: false + - value: MWK + type: String + displayName: MWK + required: false + - value: MXN + type: String + displayName: MXN + required: false + - value: MYR + type: String + displayName: MYR + required: false + - value: MZN + type: String + displayName: MZN + required: false + - value: NAD + type: String + displayName: NAD + required: false + - value: NGN + type: String + displayName: NGN + required: false + - value: NOK + type: String + displayName: NOK + required: false + - value: NPR + type: String + displayName: NPR + required: false + - value: NZD + type: String + displayName: NZD + required: false + - value: OMR + type: String + displayName: OMR + required: false + - value: PEN + type: String + displayName: PEN + required: false + - value: PHP + type: String + displayName: PHP + required: false + - value: PKR + type: String + displayName: PKR + required: false + - value: PLN + type: String + displayName: PLN + required: false + - value: QAR + type: String + displayName: QAR + required: false + - value: RON + type: String + displayName: RON + required: false + - value: RSD + type: String + displayName: RSD + required: false + - value: RUB + type: String + displayName: RUB + required: false + - value: RWF + type: String + displayName: RWF + required: false + - value: SAR + type: String + displayName: SAR + required: false + - value: SCR + type: String + displayName: SCR + required: false + - value: SEK + type: String + displayName: SEK + required: false + - value: SGD + type: String + displayName: SGD + required: false + - value: THB + type: String + displayName: THB + required: false + - value: TND + type: String + displayName: TND + required: false + - value: TRY + type: String + displayName: TRY + required: false + - value: TTD + type: String + displayName: TTD + required: false + - value: TWD + type: String + displayName: TWD + required: false + - value: TZS + type: String + displayName: TZS + required: false + - value: UAH + type: String + displayName: UAH + required: false + - value: UGX + type: String + displayName: UGX + required: false + - value: USD + type: String + displayName: USD + required: false + - value: UYU + type: String + displayName: UYU + required: false + - value: VEF + type: String + displayName: VEF + required: false + - value: VND + type: String + displayName: VND + required: false + - value: VUV + type: String + displayName: VUV + required: false + - value: XAF + type: String + displayName: XAF + required: false + - value: XCD + type: String + displayName: XCD + required: false + - value: XOF + type: String + displayName: XOF + required: false + - value: ZAR + type: String + displayName: ZAR + required: false + - value: ZMK + type: String + displayName: ZMK + required: false + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + validation: + warnings: [] + information: + - field: Balance + details: 'The opening balance, in the account currency' + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: false + required: true + KashFlow: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of the bank account as it appears in Kashflow. + required: true + balance: + type: Number + displayName: Balance + description: 'The opening balance, in the account currency.' + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account. + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: + - field: AccountName + details: Max length of 31 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + accountNumber: + type: String + displayName: Account Number + description: User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. + required: true + currency: + type: String + displayName: Currency + description: Currency of the bank account. + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: Must be provided. + - field: AccountName + details: Should not be longer than 50 characters. + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + - field: Currency + details: Must match the company's base currency. + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Should be a 6 digit number. + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + validation: + warnings: [] + information: + - field: AccountNumber + details: Should not be longer than 25 characters. + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + validation: + warnings: [] + information: + - field: IBan + details: Should be in the international bank account number format. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + required: true + Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountType: + type: String + displayName: Account Type + description: The type of account + required: true + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: true + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: true + availableBalance: + type: Number + displayName: Available Balance + description: The available balance of the bank account + required: true + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: true + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-bankAccounts-model + description: "The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" + '/companies/{companyId}/data/customers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Customers + summary: List customers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Customers' + examples: + Clear Books: + value: + results: + - id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + contactName: Miguel Hahn + emailAddress: contact@BreitenbergEmardandSchiller.biz + defaultCurrency: GBP + phone: 0800 445 6957 + addresses: + - type: Billing + line1: Apt. 184 + line2: 60578 Louie Springs + city: East Khalid + region: Wales + country: United Kingdom + postalCode: XW89 7NT + contacts: + - name: Miguel Hahn + email: Miguel.Hahn@gmail.com + phone: + - number: 018555 09614 + type: Landline + address: + type: Delivery + line1: Suite 400 + line2: 21930 Milan Lane + city: Reingerton + region: Wales + country: United Kingdom + postalCode: QG10 2DL + status: Active + registrationNumber: KME0AMIL + taxNumber: '8560920952.553111' + status: Archived + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-12-03T11:05:01' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-06-03T08:48:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 + customerName: anna test 2 + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-05-24T11:53:21Z' + pageNumber: 1 + pageSize: 2 + totalResults: 71 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c + customerName: Abdulbasit Al-haj + contactName: abeee + emailAddress: a.alhaj@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + country: GB + contacts: + - name: abeee + phone: [] + address: + type: Unknown + line1: '' + country: 'GB ' + status: Active + modifiedDate: '2020-02-24T12:00:51.027Z' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-24T12:00:50Z' + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + - id: '9677150' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-24T06:19:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: 1234 56789 + type: Primary + - number: 9876 54321 + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + - id: '634486' + customerName: A test customer name 2 + contactName: test person name + emailAddress: test8@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test9@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test10@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test8@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-11T11:39:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: '88459410' + customerName: Diogo Sousa + contactName: Mr Diogo Sousa + emailAddress: diogomail@mail.com + phone: '123123123' + addresses: + - type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + - type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + contacts: + - name: Mr Diogo Sousa + email: diogomail@mail.com + phone: + - number: '123123123' + type: Landline + - number: '321321321' + type: Mobile + address: + type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + status: Active + - name: Mr Diogo Sousa + phone: [] + address: + type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2021-05-04T13:22:19' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + - id: '172722' + customerName: 1248 European Company + contactName: European Company + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-07-27T14:29:16' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + - id: 800000D0-1182061376 + customerName: 'Allard, Robert' + contactName: Amanda Roberts + emailAddress: rallard@myemail.com + defaultCurrency: GBP + phone: 650-555-3422 + addresses: + - type: Delivery + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + - type: Billing + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + contacts: + - name: 'Allard, Robert' + email: rallard@myemail.com + phone: + - number: 650-555-3422 + type: Primary + - number: 650-555-9804 + type: Fax + - number: 650-555-8349 + type: Unknown + status: Active + - name: Robert Allard + phone: [] + status: Active + - name: Rachel Fisher + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + - id: '49' + customerName: adeel qbo child test + contactName: Adeel test + emailAddress: adeel@adeel.com + defaultCurrency: GBP + phone: '123456789' + addresses: + - type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + - type: Delivery + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + contacts: + - name: Adeel test + email: adeel@adeel.com + phone: + - number: '123456789' + type: Primary + - number: '07546543216' + type: Mobile + address: + type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + status: Active + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-08-22T09:21:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + - id: '67' + customerName: Abercrombie International Group + contactName: Natalie Watts + emailAddress: n.watts@google.com + defaultCurrency: USD + addresses: + - type: Billing + - type: Delivery + contacts: + - name: Abercrombie International Group + email: n.watts@google.com + phone: [] + address: + type: Billing + status: Active + registrationNumber: XXXXVat123456 + taxNumber: XXXXVat123456 + status: Active + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2023-03-29T01:12:55Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 243 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + - id: A1D002 + customerName: A2 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Billing + line1: 77a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 40 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2020-09-23T10:28:58Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + - id: ABS001 + customerName: ABS Garages Ltd + contactName: Mike Hall + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 0191 254 5909 + addresses: + - type: Delivery + line1: Swanson Industries + line2: Dukes Industrial Estate + city: Whitley Bay + region: North Tyneside + country: GB + postalCode: NE56 4ER + - type: Delivery + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + - type: Unknown + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + contacts: [] + taxNumber: GB745 4584 68 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + - id: 44a5d9461d9e4f6d90a5ace251c5cf35 + customerName: 100 test name DS + contactName: Main Contact + emailAddress: DCemail@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: POST - Aruba Address line 1 + line2: POST - Aruba Address line 2 + city: POST - Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: [] + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-06-10T14:22:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 168 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + - id: '324' + customerName: 3Way International Logistics + contactName: Lauri O'Heagertie + defaultCurrency: CAD + phone: 410-309-3976 + addresses: + - type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + contacts: + - name: 'O''Heagertie, Lauri' + phone: + - number: 410-309-3976 + type: Primary + address: + type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2020-10-20T05:01:49' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 530 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 + customerName: Coffee Cart + contactName: Coffee Carl + emailAddress: coffee.cart@example.com + defaultCurrency: GBP + phone: '0201111' + addresses: + - type: Billing + line1: 11 Coffee Lane + line2: Coffee Town + city: Coffee City + region: Hampshire + country: United Kingdom + postalCode: CC1 1CC + contacts: + - name: Coffee Carl + phone: + - number: '07733' + type: Mobile + status: Active + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2020-03-17T19:12:39Z' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + customerName: 7-Eleven + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + - id: '104957000000054050' + customerName: 'Doe, John' + contactName: John Doe + emailAddress: '' + defaultCurrency: GBP + addresses: [] + contacts: + - name: John Doe + email: '' + phone: [] + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-28T15:09:22' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' description: |- - 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. + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - ## 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**. + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - 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' + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). + + operationId: list-customers + '/companies/{companyId}/data/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Customers + summary: Get customer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + examples: + Clear Books: + value: + id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + Exact (UK): + value: + id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + FreeAgent: + value: + id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + KashFlow: + value: + id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Oracle NetSuite: + value: + id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + QuickBooks Desktop: + value: + id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + QuickBooks Online Sandbox: + value: + id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + Sage 50 (UK): + value: + id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + Sage Intacct: + value: + id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). + operationId: get-customer + '/companies/{companyId}/connections/{connectionId}/push/customers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Customers + summary: Create customer + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCustomerResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: create-customer + description: |- + The *Create customer* endpoint creates a new [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. + + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). + '/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + put: + tags: + - Customers + summary: Update customer + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + - $ref: '#/components/parameters/forceUpdate' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomerResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' description: |- - 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. + The *Update customer* endpoint updates an existing [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. + + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). + operationId: update-customer + '/companies/{companyId}/data/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Suppliers + summary: List suppliers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Suppliers' + examples: + Clear Books: + value: + results: + - id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: FyUkHbZxhn + supplierName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + phone: 0116 796 3163 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '0177-04-27T11:56:00' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 100 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: be49ec62-6754-ed11-946f-0022481b67d1 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2022-10-25T13:17:36Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 31 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + - id: 00014c12-2616-481a-a2e8-31bdf2497775 + supplierName: Ann's test supplier 2 + contactName: Ann's contact name + emailAddress: anna@anna888888.com + phone: '55555555' + addresses: + - type: Billing + line1: line1 + line2: line2 + city: city + region: region + country: RU + postalCode: postal + registrationNumber: '55566677788899944455' + taxNumber: RU4444444 + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-09T12:04:08Z' + defaultCurrency: USD + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + - id: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2020-05-01T14:05:46Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 118 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + - id: '9677150' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-24T06:19:23' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + - id: DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA== + supplierName: 'Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez' + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + - id: '9338173' + supplierName: Home + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '1990-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + - id: '726' + supplierName: Vendor -.A + contactName: Vendor -.A + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2021-03-26T09:53:15' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: A40000-1197774038 + supplierName: Bank of Anycity + contactName: Lisa D. Holzhauser + emailAddress: lisah@samplename.com + phone: 415-555-9135 + addresses: + - type: Billing + line1: 'Bank of Anycity, Lisa Holzhauser' + line2: 1935 Main Street + city: Middlefield + region: CA + postalCode: '94482' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 54 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + - id: '42' + supplierName: AI Support 2 + contactName: AI Support 2 + addresses: + - type: Billing + line1: test + region: string + country: DJ + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2021-08-31T08:45:02Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 23 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: '88' + supplierName: Andrew Haberbosch + addresses: [] + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2022-07-06T15:55:28Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + - id: '914' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + pageNumber: 1 + pageSize: 2 + totalResults: 943 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: MCN001 + supplierName: McNally Computer Supplies + contactName: Stuart Lynn + emailAddress: newbusinessadvice@sage.com + phone: 0191 415 3434 + addresses: + - type: Delivery + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + - type: Unknown + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + taxNumber: GB455 2385 34 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-12-05T13:37:26Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + - id: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + contactName: Abdi + emailAddress: abdisupplier@company.com + addresses: + - type: Billing + line1: 1 Place House + city: London + country: United Kingdom (GB) + postalCode: WC1X 1AH + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-13T10:38:19Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + - id: '29' + supplierName: Advisor Printing + contactName: 'Roach, Nathan' + phone: 130-202-4796 + addresses: + - type: Unknown + line1: 5 Carey Hill + line2: '' + city: Drayton Valley + region: Alberta + country: Canada + postalCode: G8V + registrationNumber: '' + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2022-06-15T11:38:29' + defaultCurrency: CAD + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx + supplierName: Flour Mill + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:12:40Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + supplierName: 7-Eleven + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + - id: '104957000000648001' + supplierName: Cool company + contactName: Dre + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-10T09:07:16' + defaultCurrency: CAD + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. - 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. + [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - 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. + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-all-data-types). - Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + ### Supported Integrations - > **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 Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. + | Integration | Supported | + |-------------------------------|-----------| + | Dynamics 365 Business Central | Yes | + | FreeAgent | Yes | + | Oracle NetSuite | Yes | + | QuickBooks Desktop | Yes | + | QuickBooks Online | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | + operationId: list-suppliers + '/companies/{companyId}/data/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/supplierId' + get: + tags: + - Suppliers + summary: Get supplier + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier' + examples: + Clear Books: + value: + id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + Exact (UK): + value: + id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + FreeAgent: + value: + id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + FreshBooks: + value: + id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + Oracle NetSuite: + value: + id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + QuickBooks Desktop: + value: + id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + QuickBooks Online Sandbox: + value: + id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + Sage 50 (UK): + value: + id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + Sage Intacct: + value: + id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get supplier* endpoint returns a single supplier for a given supplierId. - 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. + [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - 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. + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-all-data-types). - 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. + ### Supported Integrations - 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' + | Integration | Supported | + |-------------------------------|-----------| + | Dynamics 365 Business Central | Yes | + | FreeAgent | Yes | + | Oracle NetSuite | Yes | + | QuickBooks Desktop | Yes | + | QuickBooks Online | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | + operationId: get-supplier + '/companies/{companyId}/connections/{connectionId}/push/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Suppliers + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier' + examples: + Sage Intacct: + value: + id: '73593' + supplierName: test 20230420 1004 + contactName: Joe Bloggs + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create supplier description: | - 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. + The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. - 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: - - 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 Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. + [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - 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' + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). + + ### Supported Integrations + + | Integration | Supported | + |-------------------------------|-----------| + | Dynamics 365 Business Central | Yes | + | FreeAgent | Yes | + | Oracle NetSuite | Yes | + | QuickBooks Desktop | Yes | + | QuickBooks Online | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | + operationId: create-supplier + '/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/supplierId' + put: + tags: + - Suppliers + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + - $ref: '#/components/parameters/forceUpdate' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Update supplier description: | - 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). + The *Update supplier* endpoint updates an existing [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. + + [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). + + ### Supported Integrations + + | Integration | Supported | + |-------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Online | Yes | + | Xero | Yes | + operationId: update-supplier +webhooks: + expenses.sync.successful: + post: + description: Called when an expense sync successfully completes without any errors or warnings. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpensesSyncWebhook' + examples: + Successful: + value: + id: ba29118f-5406-4e59-b05c-ba307ca38d01 + eventType: expenses.sync.successful + generatedDate: '2024-09-01T00:00:00Z' + payload: + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Toft stores + description: Syncing expenses + syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + transactions: + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: Completed + errorMessage: null + - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 + status: Completed + errorMessage: null + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + expenses.sync.unsuccessful: + post: + description: 'Called when an expense sync fails to complete successfully, resulting in at least one error or warning.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpensesSyncWebhook' + examples: + Unsuccessful: + value: + id: ba29118f-5406-4e59-b05c-ba307ca38d01 + eventType: expenses.sync.unsuccessful + generatedDate: '2024-09-01T00:00:00Z' + payload: + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Toft stores + description: Syncing expenses + syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + transactions: + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: Completed + errorMessage: null + - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 + status: Failed + errorMessage: Insufficient funds + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reached: + post: + description: Called when your client’s request count to Codat's API surpasses the allocated quota. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reached: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reached + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 0 + expiryDate: '2024-09-01T12:14:14Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reset: + post: + description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reset: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reset + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 11993 + expiryDate: '2024-09-01T23:59:99Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + Account: + title: 'Accounting: Account' + description: "\uFEFF> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\n## Overview\n\nAccounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model).\n- Refer to the integration's own documentation.\n\n> **Accounts with no category**\n>\n> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.\n>\n> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports." allOf: - - type: object - x-stoplight: - id: 516bf0ecc4907 - required: - - id - properties: + - 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 + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + - $ref: '#/components/schemas/Account/definitions/accountPrototype' - 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. - - 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. + metadata: + title: Metadata + type: object + x-internal: true + properties: + isDeleted: + type: boolean + description: Indicates whether the record has been deleted in the third-party system this record originated from. + nullable: true - title: Modified dates x-internal: true allOf: @@ -84118,7 +10136,7 @@ components: properties: modifiedDate: allOf: - - $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: |- The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. @@ -84134,7 +10152,7 @@ components: properties: sourceModifiedDate: allOf: - - $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: |- The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. @@ -84146,987 +10164,525 @@ components: 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 - enum: - - Generic - - Shipping - - Overpayment - - Unknown - example: Overpayment - orderDiscountAllocation: + accountPrototype: + title: Account prototype 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: + nominalCode: 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: + 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 - description: The name of the PaymentMethod - example: Alipay - status: - description: Status of the Payment Method. - x-internal: true + nullable: true + description: Name of the account. + example: Accounts Receivable + description: 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: + nullable: true + description: Description for the account. + example: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: type: string - description: Name of the product in the commerce or POS system - examples: - - Hard Drive - - Windows Installation - - Software Support (Hourly) - description: + 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 - description: Description of the product recorded in the commerce or point of sale platform. + nullable: true + description: |- + Full name of the account, for example: + - `Cash On Hand` + - `Rents Held In Trust` + - `Fixed Asset` examples: - - 1tb Western Digital Hard Drive - - Install of Windows 11 (Professional Edition) - - 1 hour of support from an agent (phone or remote) - categorization: + - Cash On Hand + - Fixed Asset + currency: + title: Currency + x-internal: true type: string - description: Retail category that the product is assigned to e.g. `Hardware`. + description: |- + The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. + + ## Unknown currencies + + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. + + There are only a very small number of edge cases where this currency code is returned by the Codat system. + format: ISO4217 examples: - - Hardware - - Software - - Support Services - isGiftCard: + - GBP + - USD + - EUR + currentBalance: + type: number + format: decimal + nullable: true + description: Current balance in the account. + example: 0 + type: + $ref: '#/components/schemas/Account/definitions/accountType' + status: + $ref: '#/components/schemas/Account/definitions/accountStatus' + isBankAccount: type: boolean - description: | - Whether the product represents a gift card or voucher that - can be redeemed in the commerce or POS platform. - variants: + description: Confirms whether the account is a bank account or not. + validDatatypeLinks: type: array + nullable: true + description: 'The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-expenses-api#/schemas/ValidDataTypeLinks).' items: - $ref: '#/components/schemas/CommerceProduct/definitions/productVariant' + 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' - 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 + accountRef: + title: Account reference type: object - description: Reference that links the line item to the specific version of product that has been ordered. + 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: - description: The unique identifier of the product variant being referenced. type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ + description: '''id'' from the Accounts data type.' 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 + description: '''name'' from the Accounts data type.' + accountType: + title: Account type + enum: + - Unknown + - Asset + - Expense + - Income + - Liability + - Equity type: string - description: The status of the product variant. + description: Type of account + example: Asset + accountStatus: + title: Account status 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.' + - Active + - Archived + - Pending + type: string + description: Status of the account + example: Active 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' + AccountMappingInfo: + title: Account mapping info x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/CommerceProduct' - - $ref: '#/components/schemas/PagingInfo' - CommerceRecordRef: - title: Record Ref + type: object + additionalProperties: false + x-examples: + Example AccountInfo: + id: 313a4dbe-b3a4-42f0-a5f5-43e382e62db9 + nominalCode: '720' + name: Travel + currency: GBP + accountType: Expense + fullyQualifiedCategory: Expense.Overhead + isBankAccount: false + validTransactionTypes: + - Payment + - Refund + validFor: + - expense-transactions.Payment + - expense-transactions.Refund + - reimbursable-expense-transactions + properties: + id: + type: string + description: Unique identifier of account. + example: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b + nullable: false + nominalCode: + type: string + description: Code used to identify each nominal account in the accounting software. + example: '300' + nullable: true + name: + type: string + description: Name of the account as it appears in the company's accounting software. + example: Purchases + nullable: false + currency: + type: string + description: Currency of the account. + example: GBP + nullable: false + accountType: + type: string + description: Type of the account. + example: Expense + enum: + - Asset + - Liability + - Income + - Expense + - Equity + nullable: false + fullyQualifiedCategory: + type: string + description: Full account type and category of the account + example: Expense.DirectCosts + nullable: false + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validTransactionTypes: + $ref: '#/components/schemas/validTransactionTypes' + description: Supported transaction types for the account. + validFor: + $ref: '#/components/schemas/validFor' + description: Supported endpoints for the account. + AdjustmentTransactionLine: x-internal: true + title: Adjustment transaction line + type: object + properties: + amount: + type: number + format: decimal + example: 50 + description: Amount of the line. A positive line represents a debit; a negative line represents a credit. + accountRef: + $ref: '#/components/schemas/RecordRef' + description: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + trackingRefs: + type: array + minItems: 1 + maxItems: 10 + nullable: true + items: + $ref: '#/components/schemas/TrackingRefAdjustmentTransaction' + invoiceTo: + $ref: '#/components/schemas/InvoiceTo' + required: + - amount + - accountRef + AdjustmentTransactionRequest: + title: Adjustment transaction type: object properties: id: - 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. + format: uuid + description: Your unique identifier for the transaction. + date: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction. + currency: + type: string + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + reference: type: string + nullable: true + description: User-friendly reference for the adjustment transaction. + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/AdjustmentTransactionLine' required: - id - - type - description: '' - CommerceReport: - title: Commerce report + - date + - currency + - lines + AdjustmentTransactionResponse: + title: Adjustment response + x-internal: true + type: object + properties: + syncId: + type: string + example: cd937d46-8e41-43a9-9477-a79158ffd98a + format: uuid + description: Unique id of sync created + apAccountRef: + x-internal: true + type: object + title: Accounts Payable account reference + nullable: true + properties: + id: + type: string + example: 8000004C-1724173136 + description: Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. + Attachment: + title: Attachment + type: object + x-examples: + Attachment Example: + companyId: bf1e0242-5b7a-418b-a307-9e09dbf9f39a + id: '1400000000122699154' + transactionId: f8f00edd-ddb0-4ca5-b36b-8f932e6b5160 + properties: + companyId: + type: string + format: uuid + description: Unique ID of company in Codat + id: + type: string + description: Unique identifier of attachment + transactionId: + type: string + description: Unique identifier of transaction + AttachmentUpload: + title: Attachment upload + type: object + x-internal: true + required: + - file + properties: + file: + $ref: '#/components/schemas/AttachmentUpload/definitions/codatFile' + definitions: + codatFile: + type: string + description: The file to be uploaded as an attachment. + format: binary + BankAccount: + title: 'Accounting: Bank account' description: |- - ## Structure - - Assess reports follow a consistent structure. Reports contain four sections of information: - - ### 1. Report definition - - Information such as: - - 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 - - Information about the dimension contained in the reports such as: - - 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:"..."). - - ### 3. Measure info - - 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): + > **Accessing Bank Accounts through Banking API** + > + > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. + > + > To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type. - ![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png) + ## Overview - # Data model + A list of bank accounts associated with a company and a specific data connection. - ## Dimensions + 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 - 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: + allOf: + - properties: + id: 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 + description: 'Identifier for the account, unique for the company in the accounting software.' + - $ref: '#/components/schemas/BankAccount/definitions/bankAccountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Account/allOf/2/properties/metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/Account/allOf/3' + definitions: + bankAccountPrototype: + title: Bank account prototype type: object properties: - index: - type: integer - description: The dimension's index. - displayName: + accountName: type: string - description: The dimension's display name. - type: + 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 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: + 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 - description: The component's display name. - item: - type: integer - description: The component's item number. - itemDisplayName: + nullable: true + description: Code used to identify each nominal account for a business. + sortCode: 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: + 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 - description: The measure's display name. - value: + nullable: true + description: |- + Account number for the bank account. + + Xero integrations + Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated. + + FreeAgent integrations + For Credit accounts, only the last four digits are required. For other types, the field is optional. + iBan: + type: string + nullable: true + description: International bank account number of the account. Often used when making or receiving international payments. + currency: + $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' + description: Base currency of the bank account. + balance: type: number format: decimal - 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: + nullable: true + description: Balance of the bank account. + institution: 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). + nullable: true + description: The institution of the bank account. + availableBalance: 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. + 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 - taxComponentRef: + description: |- + Pre-arranged overdraft limit of the account. + + The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. + status: + $ref: '#/components/schemas/BankAccount/definitions/bankAccountStatus' + bankAccountCreateResponse: + title: Create bank account response + allOf: + - properties: + data: + allOf: + - $ref: '#/components/schemas/BankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + bankAccountRef: + title: Bank account reference type: object - 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 + description: Bank account 'id' for the account transaction. 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 + description: bank account 'name' for the account transaction. + description: Links to the Account transactions data type. + bankAccounts: + title: 'Accounting: Bank accounts' 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. + results: + type: array + items: + $ref: '#/components/schemas/BankAccount' + - $ref: '#/components/schemas/PagingInfo' + bankAccountStatus: + title: Account status 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. + - Active + - Archived + - Pending type: string - enum: - - Payment - - Refund - - Payout - - FailedPayout - - Transfer - - PaymentFee - - PaymentFeeRefund - - Unknown - examples: [] - CommerceTransactions: - title: 'Commerce: Transactions' - x-internal: true - allOf: - - type: object + description: Status of the bank account. + example: Active + 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/TransferTransactionRequest/properties/date/allOf/1' + 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: - results: - type: array - items: - $ref: '#/components/schemas/CommerceTransaction' - - $ref: '#/components/schemas/PagingInfo' + 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/TransferTransactionRequest/properties/date/allOf/1' + description: The date time in UTC when your daily quota is reset. Companies: title: Companies x-internal: true @@ -85140,8 +10696,7 @@ components: - $ref: '#/components/schemas/PagingInfo' Company: title: Company - description: "\uFEFFIn Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.\n\nTypically each company is one of your customers.\n\nWhen you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company." - description: "\uFEFFIn Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/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." + description: "\uFEFFIn Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.\n\nTypically each company is one of your customers.\n\nWhen you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company." type: object allOf: - $ref: '#/components/schemas/Company/definitions/companyDetails' @@ -85157,7 +10712,6 @@ components: type: object properties: id: - $ref: '#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId' $ref: '#/components/parameters/companyId/schema' name: type: string @@ -85172,10 +10726,10 @@ components: description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' lastSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' nullable: true created: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' createdByUserName: type: string description: Name of user that created the company in Codat. @@ -85215,7 +10769,6 @@ components: type: object properties: id: - $ref: '#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId' $ref: '#/components/parameters/companyId/schema' name: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' @@ -85255,36 +10808,234 @@ components: products: - spend-insights - lending - CompanyAccessToken: - title: Company access token - description: Details of the access token provisioned for a company. + CompanyConfiguration: + required: + - bankAccount + - supplier + - customer + title: Company configuration type: object - allOf: - - $ref: '#/components/schemas/CompanyAccessToken/definitions/accessToken' + x-examples: + Config Example: + bankAccount: + id: '89' + supplier: + id: '124' + customer: + id: '140' + properties: + bankAccount: + $ref: '#/components/schemas/CompanyConfiguration/definitions/BankAccountDetails' + supplier: + $ref: '#/components/schemas/CompanyConfiguration/definitions/SupplierDetails' + customer: + $ref: '#/components/schemas/CompanyConfiguration/definitions/CustomerDetails' definitions: - accessToken: - title: Access token + BankAccountDetails: + title: Bank account details + type: object + properties: + id: + type: string + description: The id of the account from which purchases are made + example: '32' + SupplierDetails: + title: Supplier details + type: object + properties: + id: + $ref: '#/components/schemas/Supplier/allOf/0/properties/id' + CustomerDetails: + title: Customer details + type: object + properties: + id: + $ref: '#/components/schemas/Customer/allOf/0/properties/id' + CompanyInformation: + title: 'Accounting: Company information' + description: |- + Company info provides standard details about a linked company such as their address, phone number, and company registration. + + > **Company information or companies?** + > + > Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. + type: object + properties: + companyName: + type: string + nullable: true + description: Name of the linked company. + accountingPlatformRef: + type: string + nullable: true + description: Identifier or reference for the company in the accounting software. + companyLegalName: + type: string + nullable: true + description: Registered legal name of the linked company. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + title: 'Accounting: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items/definitions/accountingAddressType' + line1: + type: string + nullable: true + description: Line 1 of the customer address. + line2: + type: string + nullable: true + description: Line 2 of the customer address. + city: + type: string + nullable: true + description: City of the customer address. + region: + type: string + nullable: true + description: Region of the customer address. + country: + type: string + nullable: true + description: Country of the customer address. + postalCode: + type: string + nullable: true + description: Postal code or zip code. + required: + - type + definitions: + accountingAddressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + phoneNumbers: + type: array + nullable: true + description: An array of phone numbers. + items: + title: Phone + type: object + x-internal: true + properties: + number: + type: string + nullable: true + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + description: A phone number. + type: + description: The type of phone number + type: string + enum: + - Primary + - Landline + - Mobile + - Fax + - Unknown + required: + - type + webLinks: + type: array + nullable: true + description: An array of weblinks. + items: + title: Weblink + description: Weblink associated with the company. + type: object + properties: + type: + description: The type of the weblink. + type: string + enum: + - Website + - Social + - Unknown + url: + description: The full URL for the weblink. + type: string + format: url + example: + type: Website + url: 'https://codat.io' + ledgerLockDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: 'If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end.' + registrationNumber: + type: string + nullable: true + description: Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + taxNumber: + type: string + nullable: true + description: Company tax number. + financialYearStartDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Start date of the financial year for the company. + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. + sourceUrls: type: object - properties: - expiresIn: - type: integer - description: The number of seconds until the access token expires. - example: 86400 - accessToken: - type: string - description: The access token for the company. - tokenType: - type: string - description: The type of token. - example: Bearer - required: - - expiresIn - - accessToken - - tokenType + additionalProperties: + type: string + nullable: true + nullable: true + description: |- + URL addresses for the accounting source. + + For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + createdDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date the linked company was created in the accounting software. + supplementalData: + $ref: '#/components/schemas/SupplementalData' examples: - - expiresIn: 86400 - accessToken: string - tokenType: Bearer + - companyName: ACME Corporation + accountingPlatformRef: 4444e827-401b-4925-92cb-d79086bf3b6b + companyLegalName: ACME Corporation Ltd. + addresses: + - type: Billing + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalcode: WC1X 8WB + - type: Unknown + line1: 123 Sierra Way + line2: '' + city: San Pablo + region: CA + country: '' + postalCode: '87999' + phoneNumbers: + - number: 010 1234 5678 + type: Landline + webLinks: + - type: Website + url: 'https://www.wbsl.com/' + ledgerLockDate: '2019-03-04T12:08:01.881Z' + registrationNumber: '1234567890' + taxNumber: GB 123456789 + financialYearStartDate: '2019-04-01T00:00:00Z' + baseCurrency: USD + sourceUrls: + url1: 'https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q' + url2: 'https://reporting.xero.com/!rxs0Q' + createdDate: '2020-02-03T16:42:02Z' CompanyRequestBody: title: Create company request x-internal: true @@ -85304,6 +11055,70 @@ components: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' required: - name + CompanySyncStatus: + title: Company sync status + type: object + additionalProperties: false + x-examples: + Success Data Pushed: + companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 + syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 + syncStatusCode: 2000 + syncStatus: Complete + errorMessage: '' + syncExceptionMessage: '' + syncUtc: '2023-01-24T14:15:22Z' + dataPushed: true + Success No Data Pushed: + companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 + syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 + syncStatusCode: 2040 + syncStatus: Complete + errorMessage: '' + syncExceptionMessage: '' + syncUtc: '2023-01-24T14:15:22Z' + dataPushed: false + properties: + companyId: + type: string + description: Unique identifier for your SMB in Codat. + example: d4d73051-ed31-42b6-99f6-d288cd940992 + nullable: true + syncId: + type: string + description: Unique identifier of the sync. + example: a6a22aff-a43a-411d-a910-2dae73217cce + nullable: true + syncStatusCode: + type: integer + format: int32 + description: Status code of the sync. + example: 2000 + syncStatus: + type: string + description: Text status of the sync. + examples: + - Complete + - PushError + - Started + - NotStarted + - Pushing + nullable: true + errorMessage: + type: string + description: Error message of the sync. + nullable: true + syncExceptionMessage: + type: string + description: Exception message of the sync. + nullable: true + syncUtc: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Datetime of the sync. + nullable: true + dataPushed: + type: boolean + description: Boolean of whether the sync resulted in data being pushed. CompanyUpdateRequest: title: Update company request x-internal: true @@ -85319,45 +11134,9 @@ components: $ref: '#/components/schemas/CompanyRequestBody/properties/description' tags: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - CompanySyncSettings: - title: Company sync settings - type: object - properties: - companyId: - $ref: '#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId' - settings: - type: array - items: - $ref: '#/components/schemas/SyncSetting' - overridesDefaults: - type: boolean - description: 'Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).' - CompanyWebhook: - title: Company 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: - - company.created - - company.deleted - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/Company/definitions/companyDetails' Connection: title: Connection - description: "\uFEFFA connection represents a [company's](https://docs.codat.io/platform-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)." - 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)." + description: "\uFEFFA connection represents a [company's](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.\n\nA company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:\n\n- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.\n- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.\n- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.\nAny combination of accounting, banking, and commerce data connections is allowed.\n\nBefore you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview)." type: object properties: id: @@ -85371,9 +11150,6 @@ components: 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: - $ref: '#/components/schemas/Branding/properties/sourceId' - sourceType: - $ref: '#/components/schemas/Integration/definitions/sourceType' type: string format: uuid example: 35b92968-9851-4095-ad60-395c95cbcba4 @@ -85402,10 +11178,10 @@ components: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' nullable: true created: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' dataConnectionErrors: type: array nullable: true @@ -85430,275 +11206,65 @@ components: 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 - ConnectionManagementAccessToken: - title: Access token - type: object - properties: - accessToken: - type: string - nullable: false - description: Access token that allows SMBs to manage connections that have access to their data. - example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c - ConnectionManagementAllowedOrigins: - title: Allowed origins - type: object - properties: - allowedOrigins: - type: array - description: 'An array of allowed origins (i.e. your domains) to permit cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).n resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).' - items: - type: string - format: uri - description: A domain you want to allow CORS with Codat. - example: - allowedOrigins: - - 'https://www.bank-of-dave.com' - Connections: - title: Connections - x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Connection' - - $ref: '#/components/schemas/PagingInfo' - ConnectionWebhook: - title: Connection webhook - DataIntegrityDetail: - title: Data integrity detail - 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: - - connection.created - - connection.connected - - connection.disconnected - - connection.reconnected - - connection.deleted - - connection.failed - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ConnectionWebhook/definitions/connectionWebhookPayload' - definitions: - connectionWebhookPayload: - title: Connection webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - connection: - $ref: '#/components/schemas/Connection' - CreateApiKey: - title: Create API key - description: Details about the newly created API key. - x-internal: true - type: object - properties: - name: - $ref: '#/components/schemas/ApiKeyDetails/allOf/0/properties/name' - CustomDataTypeConfiguration: - title: Custom data type configuration - type: object - description: Client's configuration details for a specific custom data type and platform pair. - properties: - dataSource: - type: string - description: Underlying endpoint of the source platform that will serve as a data source for the custom data type. This value is not validated by Codat. - requiredData: - type: object - description: Properties required to be fetched from the underlying platform for the custom data type that is being configured. This value is not validated by Codat. - additionalProperties: - type: string - description: The client's defined name for the property with the value being the source system's property name which the mapping is targeting. - keyBy: - type: array - description: An array of properties from the source system that can be used to uniquely identify the records returned for the custom data type. This value is not validated by Codat. - items: - type: string - minLength: 1 - sourceModifiedDate: - type: array - nullable: true - items: - type: string - description: Property in the source platform nominated by the client that defines the date when a record was last modified there. This value is not validated by Codat. - examples: - - dataSource: api/purchaseOrders?$filter=currencyCode eq 'NOK' - requiredData: - currencyCode: '$[*].currencyCode' - id: '$[*].id' - number: '$[*].number' - orderDate: '$[*].orderDate' - totalAmountExcludingTax: '$[*].totalAmountExcludingTax' - totalTaxAmount: '$[*].totalTaxAmount' - vendorName: '$[*].number' - keyBy: - - '$[*].id' - sourceModifiedDate: - - '$[*].lastModifiedDateTime' - CustomDataTypeRecords: - title: Custom data type records - type: object - description: Resulting records pulled from the source platform for a specific custom data type. - properties: - results: - type: array - items: - $ref: '#/components/schemas/CustomDataTypeRecords/definitions/customDataTypeRecord' - pageNumber: - $ref: '#/components/schemas/PagingInfo/properties/pageNumber' - pageSize: - $ref: '#/components/schemas/PagingInfo/properties/pageSize' - totalResults: - $ref: '#/components/schemas/PagingInfo/properties/totalResults' - definitions: - customDataTypeRecord: - title: Custom data type record - 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: string + enum: + - PendingAuth + - Linked + - Unlinked + - Deauthorized + dataConnectionError: + title: Data connection error type: object properties: - id: - type: string - nullable: false - description: Unique identifier of the record. - content: - type: object - description: Values from the source system for the properties defined in the custom data type configuration. - additionalProperties: - type: object - modifiedDate: - 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. - 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: + statusCode: type: string - description: ID GUID representing the connection of the accounting or banking platform. - format: uuid - date: + description: The HTTP status code returned by the source platform when the error occurred. + statusText: type: string - description: The date of the transaction. - description: + description: A non-numeric status code/text returned by the source platform when the error occurred. + errorMessage: type: string - description: The transaction description. - amount: + description: A message about a error returned by Codat. + erroredOnUtc: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + status: + title: Error status + description: The current status of a transient error. Null statuses indicate that the error is not transient. type: string - description: The transaction value. - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - description: The currency of the transaction. - DataIntegrityDetails: - title: Data integrity details + nullable: true + enum: + - Active + - Resolved + resolvedOnUtc: + description: The datetime in Utc that the error was resolved. + nullable: true + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + dataConnectionSourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + example: + id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + Connections: + title: Connections x-internal: true allOf: - type: object @@ -85706,192 +11272,210 @@ components: results: type: array items: - $ref: '#/components/schemas/DataIntegrityDetail' + $ref: '#/components/schemas/Connection' - $ref: '#/components/schemas/PagingInfo' - DataIntegrityStatus: - title: Data integrity status - type: object + CreateAccountResponse: + title: Create account response + x-internal: true 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.' + data: + allOf: + - $ref: '#/components/schemas/Account' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + CreateAdjustmentRequest: + title: Create adjustment request + x-internal: true + type: array + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/AdjustmentTransactionRequest' + CreateBankAccountResponse: + title: Create bank account response + x-internal: true + allOf: + - type: object properties: - 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.' + data: + allOf: + - $ref: '#/components/schemas/BankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + CreateCustomerResponse: + title: Create customer response + x-internal: true + allOf: + - type: object 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 + data: + allOf: + - $ref: '#/components/schemas/Customer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + CreateExpenseRequest: + title: Create expense request + x-internal: true + type: array + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/ExpenseTransaction' + CreateExpenseResponse: + title: Create expense response x-internal: true type: object properties: - metadata: - type: array - items: - $ref: '#/components/schemas/DataIntegrityStatus' - DataIntegritySummaries: - title: Data integrity summaries + syncId: + type: string + example: cd937d46-8e41-43a9-9477-a79158ffd98a + format: uuid + description: Unique id of sync created + CreateReimbursableExpenseResponse: + title: Create reimbursable expense response x-internal: true type: object properties: - summaries: - type: array - items: - $ref: '#/components/schemas/DataIntegritySummary' - DataIntegritySummary: - title: Data integrity summary + syncId: + type: string + example: cd937d46-8e41-43a9-9477-a79158ffd98a + format: uuid + description: Unique id of sync created + CreateSupplierResponse: + title: Create supplier response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Supplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + Customer: + title: 'Accounting: Customer' + description: | + ## Overview + + A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). + + Customers' data links to accounts receivable [invoices](https://docs.codat.io/sync-for-expenses-api#/schemas/Invoice). type: object allOf: - - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' - type: object properties: - byAmount: - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByAmount' - byCount: - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByCount' + id: + type: string + description: 'Identifier for the customer, unique to the company in the accounting software.' + customerName: + type: string + nullable: true + description: 'Name of the customer as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the identified customer. + emailAddress: + type: string + nullable: true + description: Email address the customer can be contacted by. + defaultCurrency: + $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' + description: Default currency the transactional data of the customer is recorded in. + phone: + type: string + nullable: true + description: Phone number the customer can be contacted by. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' + contacts: + type: array + nullable: true + description: An array of Contacts. + items: + $ref: '#/components/schemas/Customer/definitions/contact' + registrationNumber: + type: string + nullable: true + description: 'Company number. In the UK, this is typically the Companies House company registration number.' + taxNumber: + type: string + nullable: true + description: Company tax number. + status: + $ref: '#/components/schemas/Customer/definitions/customerStatus' + description: Current state of the customer. + metadata: + $ref: '#/components/schemas/Account/allOf/2/properties/metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/Account/allOf/3' + required: + - status definitions: - dataIntegrityType: + accountingCustomerRef: type: object properties: - type: + id: + minLength: 1 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 + 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: - 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. + name: + type: string + nullable: true + description: Name of a contact for a customer. + email: + type: string + nullable: true + description: Email of a contact for a customer. + phone: + type: array + nullable: true + description: An array of Phone numbers. + items: + $ref: '#/components/schemas/CompanyInformation/properties/phoneNumbers/items' + address: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' + description: An object of Address information. + status: + $ref: '#/components/schemas/Customer/definitions/customerStatus' + modifiedDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + required: + - status + Customers: + title: Customers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Customer' + - $ref: '#/components/schemas/PagingInfo' DataStatus: title: Data status description: Describes the state of data in the Codat cache for a company and data type @@ -85951,7 +11535,7 @@ components: - commerce-transactions example: invoices lastSuccessfulSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' currentStatus: $ref: '#/components/schemas/PullOperation/properties/status' latestSyncId: @@ -85970,216 +11554,6 @@ components: currentStatus: string latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 - DataStatuses: - 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 - DataType: - x-internal: true - $ref: '#/components/schemas/DataStatus/properties/dataType' - DataTypeWriteWebhook: - title: Write data type 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: - - bills.write.successful - - bills.write.unsuccessful - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/dataTypeWriteWebhookPayload' - definitions: - dataTypeWriteWebhookPayload: - title: Payload - type: object - properties: - id: - type: string - description: Unique identifier of the write request. This is also known as the push operation ID. - type: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/writeType' - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - connectionId: - $ref: '#/components/parameters/connectionId/schema' - requestedOnDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the write request was submitted. - completedOnDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the write request completed. - status: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/writeStatus' - record: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/dataTypeWriteWebhookRecord' - nullable: true - attachmentId: - type: string - nullable: true - description: 'Unique identifier for the uploaded attachment, null if no attachment uploaded.' - dataTypeWriteWebhookRecord: - type: object - properties: - id: - type: string - description: 'The unique identifier of the data type created, updated, deleted, or had an attachment uploaded in the accounting platform.' - writeType: - title: Write type - description: Type of write request. - type: string - enum: - - Create - - Update - - Delete - - UploadAttachment - writeStatus: - title: Write request status - type: string - enum: - - Pending - - Failed - - Success - - TimedOut - description: 'The current status of the write request, which is the same as the push operation status.' DataStatusResponse: x-internal: true title: Data status response @@ -86187,556 +11561,8 @@ components: 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: - dataSource: - type: object - properties: - 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 - 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 - 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: - 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: 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: - lendingCustomerRef: - type: object - properties: - id: - minLength: 1 - type: string - description: '`id` from the Customers data type.' - customerName: - type: string - nullable: true - 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' - paymentType: - type: string - 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 - items: - $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/bankingTransactionRef' - bankingTransactionRef: - title: Banking transaction reference - type: object - properties: - id: - 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: - 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' + x-internal: true + $ref: '#/components/schemas/DataStatus/properties/dataType' ErrorMessage: title: Error message type: object @@ -86795,498 +11621,319 @@ components: type: string nullable: true description: Name of validator. - Integration: - title: Integration - description: An integration that Codat supports - examples: - - key: gbol - logoUrl: 'http://example.com' - name: Xero - enabled: true - sourceId: accounting - sourceType: 8193a927-ab7a-45a3-9dc2-d357a4932dfe - integrationId: 497a18ca-284e-40c0-985d-f72be35d468e - isOfflineConnector: true - isBeta: true - dataProvidedBy: string - datatypeFeatures: - - datatype: invoices - supportedFeatures: - - featureType: get - featureState: release - type: object - properties: - key: - $ref: '#/components/parameters/platformKey/schema' - logoUrl: - type: string - format: uri - description: Static url for integration's logo. - name: - type: string - example: Xero - description: Name of integration. - enabled: - type: boolean - description: Whether this integration is enabled for your customers to use. - sourceId: - $ref: '#/components/schemas/Branding/properties/sourceId' - sourceType: - $ref: '#/components/schemas/Integration/definitions/sourceType' - integrationId: - $ref: '#/components/schemas/Connection/properties/integrationId' - isOfflineConnector: - type: boolean - description: '`True` if the integration is to an application installed and run locally on an SMBs computer.' - isBeta: - type: boolean - description: '`True` if the integration is currently in beta release.' - dataProvidedBy: - type: string - description: The name of the data provider. - datatypeFeatures: - type: array - items: - $ref: '#/components/schemas/Integration/definitions/dataTypeFeature' - required: - - key - - logoUrl - - name - - enabled - definitions: - sourceType: - title: Source Type - description: The type of platform of the connection. - ExcelStatus: + ExpenseContactRef: type: object - title: Excel status + title: Supplier/customer reference + x-internal: true properties: - 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 - description: The date and time of when a successful request was queued for the most recent report. - success: - type: boolean - 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: Error details in case the report generation request was unsuccessful. - lastInvocationId: + id: type: string - 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: + example: 40e3e57c-2322-4898-966c-ca41adfd23fd + description: Identifier of supplier or customer. + type: type: string + description: The type of contact. + example: Supplier + default: Supplier enum: - - 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 + - Supplier + required: + - id + ExpensesSyncWebhook: + title: Expenses sync webhook type: object properties: - fileName: - type: string - nullable: true - description: The file's name. - displayName: - type: string - nullable: true - description: An optional display name for the file. - sourceType: + id: type: string - nullable: true - description: The source of the file uploaded. - uploaded: - $ref: '#/components/schemas/DateTime' - additionalProperties: false - Files: - title: Files - type: array - items: - $ref: '#/components/schemas/File' - FileUpload: - title: Attachment upload - type: object - x-internal: true - required: - - file - properties: - file: - $ref: '#/components/schemas/FileUpload/definitions/codatFile' - definitions: - codatFile: + format: uuid + example: ba29118f-5406-4e59-b05c-ba307ca38d01 + description: Unique identifier of the event. + eventType: type: string - 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: - date: - type: string - 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' + description: The type of event. + examples: + - expenses.sync.successful + - expenses.sync.unsuccessful + generatedDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/expensesSyncWebhookPayload' definitions: - loanSummaryReportInfo: - title: Loan Summary Report Info - type: object - properties: - 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. urns the YYYY-MM-DD datetime of report generation. - loanRef: - title: Loan Reference + transaction: + title: Transaction 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. - 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: + description: Unique identifier of the transaction. + status: type: string - description: The id of the object being referred to. - dataConnectionId: + enum: + - Unknown + - PushError + - Completed + - Failed + - Pending + description: Status of transaction. + errorMessage: 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: + nullable: true + description: Error message for failed transaction. + expensesSyncWebhookPayload: + title: Expenses sync webhook payload 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' - 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: + referenceCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + syncId: 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 - dataTypeFeature: - title: Data type feature - description: Describes support for a given datatype and associated operations - type: object - properties: - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - supportedFeatures: + description: Unique identifier of the sync. + transactions: type: array items: - $ref: '#/components/schemas/Integration/definitions/supportedFeature' - required: - - datatype - - supportedFeatures - examples: - - datatype: invoices - supportedFeatures: - - featureType: Get - featureState: Release - supportedFeature: - type: object - x-internal: true - properties: - featureType: - $ref: '#/components/schemas/Integration/definitions/featureType' - featureState: - $ref: '#/components/schemas/Integration/definitions/featureState' - required: - - featureType - - featureState - featureState: - title: Feature state + $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/transaction' + ExpenseTransaction: + title: Expense transaction + type: object + properties: + id: type: string - example: Release - description: The current release state of the feature. - enum: - - Release - - Alpha - - Beta - - Deprecated - - NotSupported - - NotImplemented - featureType: + example: 4d7c6929-7770-412b-91bb-44d3bc71d111 + format: uuid + description: Your unique identifier for the transaction. + type: type: string - x-internal: true - description: The type of feature. + example: Payment + description: The type of transaction. enum: - - Get - - Post - - Categorization - - Delete - - Put - - GetAsPdf - - DownloadAttachment - - GetAttachment - - GetAttachments - - UploadAttachment - example: Get - Integrations: - title: Integrations - x-internal: true - allOf: - - type: object + - Payment + - Refund + - Reward + - Chargeback + issueDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction was recorded. + currency: + type: string + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + title: Currency rate + type: number + format: decimal + nullable: true + description: |- + Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. + + Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. + + It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR. + + Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). + + For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places. + + ## Examples with base currency of GBP + + | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) | + | :--------------- | :------------- | :------------ | :------------------------- | + | **USD** | $20 | 0.781 | £15.62 | + | **EUR** | €20 | 0.885 | £17.70 | + | **RUB** | ₽20 | 0.011 | £0.22 | + + ## Examples with base currency of USD + + | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) | + | :--------------- | :------------- | :------------ | :------------------------- | + | **GBP** | £20 | 1.277 | $25.54 | + | **EUR** | €20 | 1.134 | $22.68 | + | **RUB** | ₽20 | 0.015 | $0.30 | + + + ### Integration-specific details + + | Integration | Scenario | System behavior | + |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. | + contactRef: + description: Supplier or customer for the purchase to be associated to. + $ref: '#/components/schemas/ExpenseContactRef' + bankAccountRef: + type: object + title: Bank account reference properties: - results: - type: array - items: - $ref: '#/components/schemas/Integration' - - $ref: '#/components/schemas/PagingInfo' - - Commerce - description: The integration type begin referred to. - loanSummaryRecordRefType: - title: Record reference type + id: + type: string + example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea + description: Identifier of the bank account. + reference: type: string - enum: - - accounts - - banking-accounts - - commerce-transactions - description: The datatype being referred to. + nullable: true + description: User-friendly reference for the expense transaction. + merchantName: + type: string + example: Amazon UK + description: Name of the merchant where the purchase took place + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ExpenseTransactionLine' + notes: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + postAsDraft: + type: boolean + nullable: true + description: 'This optional property, when set to true, posts the transaction to a drafted state. Note that postAsDraft is only supported in Microsoft Dynamics 365 Business Central.' + required: + - id + - type + - issueDate + - currency examples: - - 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 + - id: a44135b0-6882-489a-83fe-a0c57a4afb19 + type: Payment + issueDate: '2024-05-21T00:00:00+00:00' + currency: GBP + currencyRate: 1 + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: amazon purchase + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_3 + - dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + ExpenseTransactionLine: + x-internal: true + title: Expense transaction line type: object + x-examples: + ExpenseTransactionLine: + netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 08d37c46-8d5d-441b-8bad-76286c43047e + accountRef: + id: 16989b16-96d4-401a-9054-f5c620c655a6 + trackingRefs: + - id: e9a1b63d-9ff0-40e7-8038-016354b987e6 + invoiceTo: + id: 80000002-1674552702 + type: customer properties: - reportInfo: - $ref: '#/components/schemas/LoanTransactions/definitions/loanTransactionsReportInfo' - reportItems: + netAmount: + type: number + format: decimal + example: 100 + description: 'Amount of the line, exclusive of tax.' + taxAmount: + type: number + format: decimal + example: 20 + description: Amount of tax for the line. + taxRateRef: + $ref: '#/components/schemas/RecordRef' + accountRef: + description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. + $ref: '#/components/schemas/RecordRef' + itemRef: + $ref: '#/components/schemas/ItemRef' + trackingRefs: type: array - description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + minItems: 1 + maxItems: 10 + nullable: true 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 + $ref: '#/components/schemas/TrackingRef' + invoiceTo: + $ref: '#/components/schemas/InvoiceTo' + required: + - netAmount + IntegrationType: + title: Integration type + x-internal: true + type: string + description: Type of transaction that has been processed e.g. Expense or Bank Feed. + enum: + - expenses + - bankfeeds + default: expenses + example: expenses + nullable: true + InvoiceTo: + title: Billable customer reference + x-internal: true type: object + nullable: true + description: Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. + properties: + id: + type: string + example: 80000002-1674552702 + description: identifier of customer. + type: + type: string + example: customer + description: The type of contact. + enum: + - customer + ItemRef: x-internal: true + type: object + title: Item reference + nullable: true + properties: + id: + type: string + example: 80000002-1675158984 + description: 'Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both.' + MappingOptions: + title: Mapping options + type: object + additionalProperties: false + x-examples: {} properties: - isDeleted: - type: boolean - description: Indicates whether the record has been deleted in the third-party system this record originated from. + expenseProvider: + type: string + description: Name of the expense integration. + example: Partner Expense + nullable: true + accounts: + type: array + description: Array of available accounts for mapping. + nullable: true + items: + $ref: '#/components/schemas/AccountMappingInfo' + trackingCategories: + type: array + description: Array of available tracking categories for mapping. + nullable: true + items: + $ref: '#/components/schemas/TrackingCategoryMappingInfo' + taxRates: + type: array + description: Array of available tax rates for mapping. nullable: true + items: + $ref: '#/components/schemas/TaxRateMappingInfo' PagingInfo: type: object title: Pagination information @@ -87347,113 +11994,6 @@ components: href: '/companies/{id}/data/{dataType}' current: href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' - Profile: - title: Profile - description: Describes your Codat client instance - examples: - - name: Bob's Burgers - logoUrl: 'https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png' - iconUrl: 'https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico' - redirectUrl: 'https://bobs-burgers.{countrySuffix}/{companyId}' - whiteListUrls: - - 'https://bobs-burgers.com' - - 'https://bobs-burgers.co.uk' - confirmCompanyName: true - type: object - properties: - name: - type: string - example: Bob's Burgers - description: The name given to the instance. - logoUrl: - type: string - description: Static url to your organization's logo. - example: 'https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png' - iconUrl: - type: string - description: Static url to your organization's icon. - example: 'https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico' - redirectUrl: - type: string - example: 'https://bobs-burgers.{countrySuffix}/{companyId}' - description: 'The redirect URL pasted on to the SMB once Codat''s [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB.' - whiteListUrls: - type: array - description: A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. - items: - type: string - format: uri - example: 'https://bobs-burgers.com' - description: A url that is allowed to communicate with Codat. - apiKey: - type: string - deprecated: true - example: sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB - description: The API key for this Codat instance. - confirmCompanyName: - type: boolean - deprecated: true - description: '`True` if the company name has been confirmed.' - required: - - name - - redirectUrl - x-stoplight: - id: b1fyq05edangf - 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: - 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: |- @@ -87517,9 +12057,9 @@ components: nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' completed: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' progress: type: integer description: An integer signifying the progress of the pull operation. @@ -87576,7 +12116,6 @@ components: $ref: '#/components/schemas/DataStatus/properties/dataType' description: 'The type of data being pushed, eg invoices, customers.' companyId: - $ref: '#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId' $ref: '#/components/parameters/companyId/schema' pushOperationKey: type: string @@ -87585,10 +12124,10 @@ components: dataConnectionKey: $ref: '#/components/parameters/connectionId/schema' requestedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' description: The datetime when the push was requested. completedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' description: 'The datetime when the push was completed, null if Pending.' timeoutInMinutes: type: integer @@ -87832,977 +12371,886 @@ components: $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' required: $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' - ReadCompletedWebhook: - title: Read completed webhook - ReportLine: + RecordRef: + x-internal: true + type: object + title: Record reference + properties: + id: + type: string + example: 40e3e57c-2322-4898-966c-ca41adfd23fd + description: Identifier of linked reference from mapping options. + ReimbursableExpenseTransactionLine: + x-internal: true + title: Reimbursable expense transaction line + type: object + properties: + description: + type: string + example: 2-night hotel stay + description: line description + netAmount: + type: number + format: decimal + example: 100 + description: 'Amount of the line, exclusive of tax.' + taxAmount: + type: number + format: decimal + example: 20 + description: Amount of tax for the line. + taxRateRef: + $ref: '#/components/schemas/RecordRef' + accountRef: + description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. + $ref: '#/components/schemas/RecordRef' + itemRef: + $ref: '#/components/schemas/ItemRef' + trackingRefs: + type: array + minItems: 1 + maxItems: 10 + nullable: true + items: + $ref: '#/components/schemas/TrackingRef' + invoiceTo: + $ref: '#/components/schemas/InvoiceTo' + required: + - netAmount + ReimbursableExpenseTransactionRequest: + title: Reimbursable expense transaction request + type: array + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/ReimbursableExpenseTransactionRequest/definitions/reimbursableExpenseTransaction' + definitions: + reimbursableExpenseTransaction: + title: Reimbursable expense transaction + type: object + properties: + id: + type: string + example: 4d7c6929-7770-412b-91bb-44d3bc71d111 + format: uuid + description: Your unique identifier for the transaction. + reference: + type: string + nullable: true + description: User-friendly reference for the reimbursable expense. + contactRef: + $ref: '#/components/schemas/ReimbursementContactRef' + apAccountRef: + $ref: '#/components/schemas/apAccountRef' + issueDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction was recorded. + dueDate: + description: Date the supplier is due to be paid. + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + currency: + type: string + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + notes: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' + required: + - id + - contactRef + - issueDate + - dueDate + - currency + ReimbursementContactRef: + type: object + title: Contact reference + x-internal: true + properties: + id: + type: string + example: 40e3e57c-2322-4898-966c-ca41adfd23fd + description: Identifier of contact. + required: + - id + SupplementalData: + title: Supplemental data + type: object + x-internal: true + description: |- + Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + properties: + content: + type: object + additionalProperties: + type: object + additionalProperties: true + nullable: true + Supplier: + title: 'Accounting: Supplier' + description: |- + ## Overview + + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: + type: string + nullable: true + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the supplier. + emailAddress: + type: string + nullable: true + description: Email address that the supplier may be contacted on. + phone: + type: string + nullable: true + description: Phone number that the supplier may be contacted on. + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' + registrationNumber: + type: string + nullable: true + description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' + taxNumber: + type: string + nullable: true + description: Supplier's company tax number. + status: + $ref: '#/components/schemas/Supplier/definitions/supplierStatus' + defaultCurrency: + type: string + nullable: true + description: Default currency the supplier's transactional data is recorded in. + metadata: + $ref: '#/components/schemas/Account/allOf/2/properties/metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/Account/allOf/3' + required: + - status + definitions: + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. + type: object + properties: + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. + type: string + enum: + - Unknown + - Active + - Archived + examples: + - id: C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F + supplierName: Kelly's Industrial Supplies + contactName: Kelly's Industrial Supplies + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + line2: Bakersfield Industrial Estate + city: Bakersfield + region: California + country: USA + postalcode: '93308' + registrationNumber: string + taxNumber: string + status: Unknown + defaultCurrency: string + metadata: + isDeleted: true + supplementalData: + content: + property1: + property1: null + property2: null + property2: + property1: null + property2: null + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + Suppliers: + title: Suppliers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Supplier' + - $ref: '#/components/schemas/PagingInfo' + SyncCompleteWebhook: + title: Sync complete webhook + x-internal: true + description: Webhook request body used to notify that a sync has completed. + type: object + properties: + ClientId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' + ClientName: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' + CompanyId: + $ref: '#/components/parameters/companyId/schema' + RuleId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' + RuleType: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' + AlertId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' + Message: + $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' + Data: + $ref: '#/components/schemas/SyncCompleteWebhook/definitions/SyncCompleteWebhookData' + definitions: + SyncCompleteWebhookData: + type: object + title: Sync complete webhook data + properties: + syncId: + $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncId' + syncType: + $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncType' + examples: + - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e + ClientName: Expense Sync + CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 + AlertId: 33a4f8e9-09ae-4334-9b00-7bbe83024672 + RuleId: 5c27631d-3b63-4b50-8228-ee502fd113eb + RuleType: Sync Completed + Message: Sync 321363b4-efa9-4fbc-b71c-0b58d62f3248 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense completed successfully. + Data: + syncId: 321363b4-efa9-4fbc-b71c-0b58d62f3248 + syncType: Expense + SyncFailedWebhook: + title: Sync failed webhook x-internal: true + description: Webhook request body used to notify that a sync has failed. type: object - title: 'Accounting: Report line' properties: - accountId: + ClientId: + title: Client ID type: string - nullable: true - description: 'Identifier for the account, unique for the company in the accounting software.' - name: + format: uuid + description: Unique identifier for your client in Codat. + ClientName: 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: + description: Name of your client in Codat. + CompanyId: + $ref: '#/components/parameters/companyId/schema' + RuleId: type: string format: uuid - example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - description: Unique identifier of the event. - eventType: + description: Unique identifier for the rule. + deprecated: true + RuleType: type: string - description: The type of event. - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/readCompletedWebhookPayload' + x-stoplight: + id: 34d52a089f08a + description: The type of rule. + AlertId: + type: string + format: uuid + description: Unique identifier of the webhook event. + Message: + type: string + description: A human-readable message about the webhook. + Data: + $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData' definitions: - readCompletedWebhookPayload: - title: Read result webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - modifiedFromDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC when the data types were last fetched and input into Codat's cache. - nullable: true - dataTypes: - type: array - items: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/dataTypeReadSummary' - dataTypeReadSummary: - title: Summary of data type reads - type: object - properties: - connectionId: - $ref: '#/components/parameters/connectionId/schema' - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - recordsModified: - type: boolean - example: false - description: '`True` if records have been created, updated or deleted in Codat''s cache.' - status: - $ref: '#/components/schemas/PullOperation/properties/status' - issues: - type: array - nullable: true - description: A array of issues encountered during a data read. - items: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/issue' - customProductReadCompleteWebhook: - title: Read completed webhook - type: object - properties: - id: - $ref: '#/components/schemas/ReadCompletedWebhook/properties/id' - eventType: - $ref: '#/components/schemas/ReadCompletedWebhook/properties/eventType' - generatedDate: - $ref: '#/components/schemas/ReadCompletedWebhook/properties/generatedDate' - payload: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/customProductReadCompleteWebhookPayload' - customProductReadCompleteWebhookPayload: - title: Read result webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - modifiedFromDate: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/readCompletedWebhookPayload/properties/modifiedFromDate' - dataTypes: - type: array - description: Contains all data types configured for the product or a subset of data types defined in the manual refresh call. - items: - type: object - title: Summary of data type reads - properties: - connectionId: - $ref: '#/components/parameters/connectionId/schema' - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - recordsModified: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/dataTypeReadSummary/properties/recordsModified' - status: - $ref: '#/components/schemas/PullOperation/properties/status' - issues: - type: array - nullable: true - description: A array of issues encountered during a data read. - items: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/issue' - issue: - title: Issue + SyncFailedWebhookData: type: object - description: Details of a problem encountered during a data read. + title: Sync failed webhook data properties: - type: + syncId: type: string - description: The type of issue. - example: warning.validation - message: + format: uuid + example: a9367074-b5c3-42c4-9be4-be129f43577e + description: Unique identifier for the failed sync. + syncType: type: string - description: A message describing the issue. - example: Something doesn't look right about these accounts from Xero. You can see more information in the logs. - links: - title: Links - type: object - properties: - logs: - type: string - description: 'A link to the validation logs, providing details on any errors or warnings encountered.' - example: 'https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation' - portal: - type: string - description: A link to the company's past data read history in the Codat portal. - example: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history' - readMore: - type: string - description: A link to Codat's documentation with additional information on how to troubleshoot this issue. - example: 'https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation' - SupplementalDataConfiguration: - description: '' - title: Supplemental data configuration - type: object - properties: - supplementalDataConfig: - type: object - additionalProperties: - type: object - title: Supplemental data source configuration - description: The client's defined name for the object. - properties: - dataSource: - type: string - description: 'The underlying endpoint of the source system which the configuration is targeting. ' - pullData: - type: object - description: The additional properties that are required when pulling records. - additionalProperties: - type: string - description: The client's defined name for the property with the value being the source system's property name which the mapping is targeting. - pushData: - type: object - description: The additional properties that are required to create and/or update records. - additionalProperties: - type: string - description: The client's defined name for the property with the value being the source system's property name which the mapping is targeting. - examples: - - supplementalDataConfig: - orders-supplemental-data: - dataSource: /orders - pullData: - orderNumber: order_num - pushData: - orderNumber: order_num - SyncSetting: - title: SyncSetting - description: 'Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued.' + description: The type of sync being performed. + FailureStage: + type: string + description: The stage of the job the sync failed. examples: - - dataType: invoices - fetchOnFirstLink: true - syncSchedule: 24 - syncOrder: 0 - syncFromUtc: '2020-01-01T12:00:00.000Z' - syncFromWindow: 24 - monthsToSync: 24 - isLocked: true + - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e + ClientName: Expense Sync + CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 + RuleId: 289c80dc-2aee-4b71-afff-9acd8d051080 + RuleType: Sync Failed + AlertId: 72c1103b-7f17-4a3a-8db5-67c2d360a516 + Message: Sync 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense has failed at step Pushing. + Data: + syncId: 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 + syncType: Expense + FailureStage: Pushing + SyncInitiated: + title: Sync initiated type: object properties: - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - fetchOnFirstLink: - type: boolean - description: Whether this data type should be queued after a company has authorized a connection. - syncSchedule: - type: integer - example: 24 - description: Number of hours after which this data type should be refreshed. - syncOrder: - type: integer - description: The sync in which data types are queued for a sync. - syncFromUtc: - $ref: '#/components/schemas/DateTime' - description: Date from which data should be fetched. Set this *or* `syncFromWindow`. - syncFromWindow: - type: integer - example: 24 - description: Number of months of data to be fetched. Set this *or* `syncFromUTC`. - monthsToSync: - type: integer - example: 24 - description: 'Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only.' - isLocked: - type: boolean - description: '`True` if the [sync setting](https://docs.codat.io/knowledge-base/advanced-sync-settings) is locked.' - required: - - dataType - - fetchOnFirstLink - - syncSchedule - - syncOrder - SyncSettings: - title: Sync settings + syncId: + type: string + format: uuid + description: Unique identifier for the sync initiated. + additionalProperties: false + TaxRateMappingInfo: + title: Tax rate mapping info x-internal: true type: object + additionalProperties: false + x-examples: + UK Tax Rate: + id: 23_Bills + name: 20% Bill tax Bills + code: 20% Bill tax + effectiveTaxRate: 20 + totalTaxRate: 20 + validTransactionTypes: + - Payment + - Reward properties: - clientId: - $ref: '#/components/schemas/ClientId' - settings: - type: array - items: - $ref: '#/components/schemas/SyncSetting' - overridesDefaults: - type: boolean - description: 'Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).' - UpdateConnectionStatus: - title: Update connection + id: + type: string + description: Unique identifier of tax rate. + example: 23_Bills + nullable: false + name: + type: string + description: Name of the tax rate in the accounting software. + example: 20% Bill tax Bills + nullable: false + code: + type: string + description: Code for the tax rate from the accounting software. + example: 20% Bill tax + nullable: true + effectiveTaxRate: + type: number + format: decimal + description: Effective tax rate. + example: 20 + totalTaxRate: + type: number + format: decimal + description: Total (not compounded) sum of the components of a tax rate. + example: 20 + validTransactionTypes: + $ref: '#/components/schemas/validTransactionTypes' + description: Supported transaction types for the tax rate. + TrackingCategoryMappingInfo: + title: Tracking category mapping info x-internal: true type: object - properties: - status: - $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' - description: The current authorization status of the data connection. - nullable: true additionalProperties: false - ValidationResult: - title: Validation result - type: object - properties: - errors: - type: array - items: - $ref: '#/components/schemas/ValidationResult/definitions/validationItem' - warnings: - type: array - items: - $ref: '#/components/schemas/ValidationResult/definitions/validationItem' - definitions: - validationItem: - title: Validation item - type: object - properties: - ruleId: - type: string - description: The unique identifier of the rule that wasn't met. - itemId: - type: string - description: The unique identifier of the item that was validated. - message: - type: string - description: The message that describes the validation warning or error. - validatorName: - type: string - description: The name of the validator that was used to validate the item. - WebhookConsumer: - title: Webhook consumer - type: object - description: "\uFEFFA webhook consumer is an HTTP endpoint that developers can configure to subscribe to Codat's supported event types.\n\nSee our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).\n" + x-examples: + Tracking Category with parentId: + id: DEPARTMENT_1 + name: TestLocation + hasChildren: false + parentId: DEPARTMENTS + Parent Tracking Category: + id: DEPARTMENTS + name: Departments + hasChildren: true properties: id: type: string - format: uuid - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for the webhook consumer. - url: + description: Unique identifier of the tracking category. + example: DEPARTMENT_2 + nullable: false + name: type: string - format: uri - description: The URL that will consume webhook events dispatched by Codat. - disabled: + description: Name of the tracking category as it appears in the accounting software. + example: New York + nullable: false + hasChildren: type: boolean - description: Flag that enables or disables the endpoint from receiving events. Disabled when set to `true`. - nullable: true - default: false - eventTypes: - type: array - description: An array of event types the webhook consumer subscribes to. - items: - type: string - companyTags: - type: array + description: Boolean of whether the tracking category has child categories. + parentId: + type: string + description: ID of the parent tracking category + example: DEPARTMENTS nullable: true - description: 'Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format `tagKey:tagValue`.' - items: - type: string - maxLength: 128 - maxItems: 10 - definitions: - webhookConsumerPrototype: - title: Create webhook consumer - type: object - properties: - url: - $ref: '#/components/schemas/WebhookConsumer/properties/url' - disabled: - $ref: '#/components/schemas/WebhookConsumer/properties/disabled' - eventTypes: - $ref: '#/components/schemas/WebhookConsumer/properties/eventTypes' - companyTags: - $ref: '#/components/schemas/WebhookConsumer/properties/companyTags' - webhookConsumers: - title: Webhook consumers - type: object - properties: - results: - type: array - maxItems: 50 - items: - $ref: '#/components/schemas/WebhookConsumer' - WebhookZapierKey: - title: Zapier integration key + TrackingRef: type: object + title: Tracking reference + x-internal: true properties: - key: - type: string - description: Integration key used to authorize Zapier's HTTP requests with Codat. - example: sk_integ_WM4dfoK1nKZnDE_kceze6hWDjbRwOZwG.us - examples: - - key: sk_integ_WM4dfoK1nKZnDE_kceze6hWDjbRwOZwG.us - responses: - Bad-Request: - description: Unique identifier of the report - example: 52c0f26b-051a-43ff-b02a-258eec67f5ef - status: + id: type: string - enum: - - InProgress - - Complete - - Error - description: The status of the report generation. - type: + example: e9a1b63d-9ff0-40e7-8038-016354b987e6 + description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. + dataType: type: string + example: trackingCategories + default: trackingCategories + description: The type of the linked reference enum: - - 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) + - trackingCategories + - customers + TrackingRefAdjustmentTransaction: type: object - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false + title: Tracking reference + x-internal: true properties: id: type: string - description: Unique ID for the bank account. - accountName: - type: string - nullable: true - description: The bank account name. - accountType: + example: e9a1b63d-9ff0-40e7-8038-016354b987e6 + description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. + dataType: type: string - nullable: true - description: The type of bank account e.g. Credit. - accountNumber: + example: trackingCategories + default: trackingCategories + description: The type of the linked reference + enum: + - trackingCategories + - customers + - suppliers + Transaction: + title: Transaction + type: object + additionalProperties: false + properties: + transactionId: type: string + description: Your unique idenfier of the transaction. + example: aa02271d-ed5f-47f5-be76-778d5905225a nullable: true - description: The account number. - sortCode: + status: + $ref: '#/components/schemas/TransactionStatus' + message: type: string + description: Metadata such as validation errors or the resulting record created in the accounting software. nullable: true - description: The sort code. - currency: - title: Currency - x-internal: true + integrationType: + $ref: '#/components/schemas/IntegrationType' + x-examples: + Successful Transaction: + transactionId: 8fdba4ed-e327-4925-be1a-b7a2b04627f7 + status: Completed + integrationType: expense + Unsuccessful Transaction: + transactionId: 3d694cd1-4cd9-4136-91db-32408195c6fc + status: ValidationError + message: The line item total -208.10((-195.01 + -1.09) + (-10.01 + -1.99)) must equal the transaction total -1.1 + integrationType: string + TransactionResponse: + title: Transaction response + x-internal: true + type: array + items: + $ref: '#/components/schemas/Transaction' + Transactions: + title: Transactions + x-internal: true + additionalProperties: false + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Transaction' + - $ref: '#/components/schemas/PagingInfo' + x-examples: + Example 1: + results: + - transactionId: aa02271d-ed5f-47f5-be76-778d5905225a + status: Completed + integrationType: expenses + - transactionId: 730177a2-8505-410a-9ebc-c2dd52e4bea9 + status: Completed + integrationType: expenses + pageNumber: 1 + pageSize: 100 + totalResults: 2 + links: + self: + href: string + current: + href: string + TransactionStatus: + title: Transaction status + x-internal: true + type: string + description: Status of the transaction. + enum: + - Unknown + - Pending + - ValidationError + - Completed + - PushError + example: Completed + nullable: true + TransferTransactionRequest: + title: Transfer + type: object + properties: + description: type: string - description: |- - The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. + description: 'Any private, company notes about the transaction.' + example: Transfer from bank account Y to bank account Z + date: + allOf: + - description: Date of the transfer transaction as recorded in the accounting software. + - title: Date time + type: string + examples: + - '2022-10-23T00:00:00Z' + - '2022-10-23' + description: |- + In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - ## Unknown currencies + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` - In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - There are only a very small number of edge cases where this currency code is returned by the Codat system. - format: ISO4217 - examples: - - GBP - - USD - - EUR - balance: - type: number - format: decimal - nullable: true - description: The latest balance for the bank account. - modifiedDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The last date the bank account was modified. - status: - type: string - nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - required: - - id - definitions: - sourceAccountPrototype: - title: Source account (v1) + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + from: type: object properties: - id: - $ref: '#/components/schemas/SourceAccount/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccount/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccount/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccount/properties/accountNumber' - sortCode: - $ref: '#/components/schemas/SourceAccount/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - $ref: '#/components/schemas/SourceAccount/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccount/properties/modifiedDate' + accountRef: + type: object + title: Account reference + description: Reference of the account you are transferring money from. + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + required: + - id + amount: + type: number + format: decimal + description: Amount that has been transferred from the account in the native currency of the account. required: - - id - sourceAccounts: - title: Source accounts - type: array - items: - $ref: '#/components/schemas/SourceAccount' - examples: - - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - - id: acc-003 - accountName: account-095 - sortCode: '123456' - accountType: Credit - accountNumber: '12345671' - currency: USD - balance: 0 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - SourceAccountV2: - title: Source account (v2) + - accountRef + - amount + to: + type: object + properties: + accountRef: + type: object + title: Account reference + description: Reference of the account you are transferring money to. + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + required: + - id + amount: + type: number + format: decimal + description: Amount that has been transferred to the account in the native currency of the account. + required: + - accountRef + - amount + required: + - date + - from + - to + TransferTransactionResponse: + title: Create transfer response + x-internal: true type: object - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false properties: - id: + syncId: type: string - description: Unique ID for the bank account. - accountName: - type: string - description: The bank account name. - accountType: + example: cd937d46-8e41-43a9-9477-a79158ffd98a + format: uuid + description: Unique id of sync created + UpdateCustomerResponse: + title: Update customer response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Customer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + UpdateExpenseRequest: + title: Updating expense transaction request + type: object + properties: + type: type: string - description: 'The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.' + example: Payment + description: The type of transaction. enum: - - checking - - savings - - loan - - creditCard - - prepaidCard - accountNumber: - type: string - description: The account number. - sortCode: + - Payment + - Refund + - Reward + - Chargeback + issueDate: type: string - nullable: true - description: The sort code. - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' + description: Date the transaction was recorded. + example: '2022-06-28T00:00:00.000Z' currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - type: number - format: decimal - description: The latest balance for the bank account. - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' - modifiedDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The last date the bank account was modified. - status: - type: string - nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - nullable: true - title: Date type: string - example: '2022-10-23' - description: |- - In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example: - ``` - 2020-10-08 - ``` - required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance - definitions: - sourceAccountV2Prototype: - title: Source account (v2) + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + contactRef: + description: Supplier or Customer for the purchase to be associated to. + $ref: '#/components/schemas/ExpenseContactRef' + bankAccountRef: type: object + title: Bank account reference properties: id: - $ref: '#/components/schemas/SourceAccountV2/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccountV2/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccountV2/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccountV2/properties/accountNumber' - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' - sortCode: - $ref: '#/components/schemas/SourceAccountV2/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - $ref: '#/components/schemas/SourceAccountV2/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccountV2/properties/modifiedDate' - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' - required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance - accountInfo: - title: Account Info - type: object - nullable: true - properties: - description: - type: string - nullable: true - description: Description of the account. - nickname: type: string - nullable: true - description: Name given to the account by the user. Used in UIs to assist in account selection. - accountOpenDate: - $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' - nullable: true - description: Date when the account was opened or created at the provider - availableBalance: - type: number - format: decimal - nullable: true - description: Balance of funds available for use. This includes pending activity. - sourceAccounts: - title: Source accounts + example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea + description: Identifier of the bank account. + merchantName: + type: string + description: Name of the merchant where the purchase took place + example: Amazon UK + lines: type: array + description: Array of transaction lines. items: - $ref: '#/components/schemas/SourceAccountV2' - routingInfo: - title: Routing Info - type: object - description: Routing information for the bank. This does not include account number. - properties: - bankCode: - type: string - nullable: true - description: The numeric identifier of the routing number - type: - type: string - nullable: true - default: bankcode - enum: - - rtn - - aba - - swift - - bsb - - iban - - nz2 - - trno - - sortcode - - blz - - ifsc - - bankcode - - apca - - clabe - description: The type of routing number. - examples: - - id: acc-001 - accountName: account-081 - accountType: checking - accountNumber: '12345670' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 99.99 - accountInfo: - description: account description 1 - nickname: account 123 - accountOpenDate: '2023-05-06' - availableBalance: 10 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - - id: acc-002 - accountName: account-083 - accountType: savings - accountNumber: '23456789' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 400 - accountInfo: - description: account description 2 - nickname: account 1290 - accountOpenDate: '2023-05-23' - availableBalance: 400 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - StartUploadSessionRequest: - title: Upload session start request + $ref: '#/components/schemas/ExpenseTransactionLine' + notes: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + required: + - type + - issueDate + - currency + UpdateExpenseResponse: + title: Update expense response + x-internal: true type: object properties: - dataType: + syncId: type: string - enum: - - banking-accounts - - banking-transactions - description: A key for a Codat data type. - SupplementalData: - title: Supplemental data + description: Unique identifier for the update expense sync. + example: 1ad0695c-4566-4715-918c-adbb03eac81e + UpdateReimbursableExpenseTransactionRequest: + title: Updating reimbursable expense transaction request 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 + reference: + type: string nullable: true - 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. + description: User-friendly reference for the reimbursable expense. + contactRef: + $ref: '#/components/schemas/ReimbursementContactRef' + apAccountRef: + $ref: '#/components/schemas/apAccountRef' + issueDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction was recorded. + dueDate: + description: Date the supplier is due to be paid. + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + currency: type: string - enum: - - Website - - Social - - Unknown - url: - description: The full URL for the weblink. + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + notes: type: string - format: url - example: - type: Website - url: 'https://codat.io' - parameters: - page: - name: page - in: query - schema: - type: integer - format: int32 - minimum: 1 - example: 1 - default: 1 - description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' - pageSize: - name: pageSize - in: query - schema: - type: integer - format: int32 - default: 100 - example: 100 - minimum: 1 - maximum: 5000 - description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' - query: - name: query - in: query - required: false - schema: - type: string - example: id=e3334455-1aed-4e71-ab43-6bccf12092ee - description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' - orderBy: - name: orderBy - in: query - required: false - schema: - type: string - example: '-modifiedDate' - description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' - companyId: - name: companyId - in: path - required: true - schema: + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' + required: + - contactRef + - issueDate + - dueDate + - currency + UpdateSupplierResponse: + title: Update supplier response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Supplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + validFor: + title: Valid endpoints + x-internal: true + type: array + description: Supported endpoints for the account. + nullable: false + items: type: string - 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: + enum: + - expense-transactions.Payment + - expense-transactions.Refund + - expense-transactions.Reward + - expense-transactions.Chargeback + - reimbursable-expense-transactions + - transfer-transactions + - adjustment-transactions + example: expense-transactions.Payment + validTransactionTypes: + title: Valid transaction types + x-internal: true + type: array + description: Supported transaction types for the account. + nullable: false + items: type: string - 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: A key for a Codat data type. - in: path - required: true - schema: - $ref: '#/components/schemas/DataType' - datasetId: - name: datasetId + enum: + - Payment + - Refund + - Reward + - Chargeback + example: Payment + parameters: + syncId: + name: syncId in: path required: true schema: type: string format: uuid - description: Unique identifier for the dataset that completed its sync. - description: Unique identifier for the dataset that completed its sync. - dataIntegrityDataType: - name: dataType + example: 6fb40d5e-b13e-11ed-afa1-0242ac120002 + description: Unique identifier for a sync. + transactionId: + name: transactionId 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 + format: uuid + example: 336694d8-2dca-4cb5-a28d-3ccb83e55eee + description: The unique identifier for your SMB's transaction. + page: + name: page 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 + format: int32 + minimum: 1 + example: 1 + default: 1 + description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' + pageSize: + name: pageSize in: query - required: true schema: type: integer - description: The number of periods to return. There will be no pagination as a query parameter. - periodUnit: - name: periodUnit + format: int32 + default: 100 + example: 100 + minimum: 1 + maximum: 5000 + description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' + query: + name: query in: query - required: true + required: false 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 + example: id=e3334455-1aed-4e71-ab43-6bccf12092ee + description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' + orderBy: + name: orderBy in: query - 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 + required: false schema: type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for a bill. - attachmentId: - name: attachmentId + 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 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 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId 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 + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. + dataType: + name: dataType + description: The key of a Codat data type in: path required: true schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for an invoice. - accountingSupplierId: + $ref: '#/components/schemas/DataType' + supplierId: name: supplierId in: path required: true @@ -88814,54 +13262,6 @@ components: - 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 @@ -88895,79 +13295,6 @@ components: 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. @@ -88984,15 +13311,6 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - ConnectionManagementAllowedOrigins: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionManagementAllowedOrigins' - examples: - Allowed origins: - $ref: '#/components/examples/connectionManagementAllowedOriginsResponse' Malformed-Query: description: Your `query` parameter was not correctly formed content: @@ -89114,8 +13432,8 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - Too-Many-Requests: - description: Too many requests were made in a given amount of time. Wait a short period and then try again. + Unprocessable-Content: + description: The requests made can't be processed. This may be due to differences in platform support. content: application/json: schema: @@ -89123,14 +13441,14 @@ components: examples: Conflict: value: - statusCode: 429 - service: PublicApi - error: You have made too many requests in a given amount of time; please retry later. - correlationId: bc997528a9d7abb9161ef45f05d38599 + statusCode: 422 + service: ExpenseSyncApi + error: Expense transaction updates are not supported for platforms other than Xero. + correlationId: 7c8e23841d211c87f49f30b248f70c93 canBeRetried: Unknown detailedErrorCode: 0 - Legal-Reasons: - description: Not currently available due to compliance limitations. Reach out to your Codat contact for further assistance. + Too-Many-Requests: + description: Too many requests were made in a given amount of time. Wait a short period and then try again. content: application/json: schema: @@ -89138,10 +13456,10 @@ components: examples: Conflict: value: - statusCode: 451 - service: StdznCustomData - error: Platform 'qudb' is not currently available for compliance purposes. - correlationId: f63017dabb9b87865573bea95a51e55d + statusCode: 429 + service: PublicApi + error: You have made too many requests in a given amount of time; please retry later. + correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 Internal-Server-Error: @@ -89174,121 +13492,6 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - parameters: - companyId: - name: companyId - in: path - required: true - schema: - $ref: '#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId' - 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. - customDataIdentifier: - name: customDataIdentifier - in: path - required: true - schema: - type: string - example: DynamicsPurchaseOrders - description: Unique identifier for a custom data type. - page: - name: page - in: query - schema: - type: integer - format: int32 - minimum: 1 - example: 1 - default: 1 - description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' - pageSize: - name: pageSize - in: query - schema: - type: integer - format: int32 - default: 100 - example: 100 - minimum: 1 - maximum: 5000 - description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' - productIdentifier: - name: productIdentifier - in: path - required: true - schema: - type: string - examples: - - bank-feeds - - lending - - payables - - expenses - description: Human-readable product identifier for a product. - query: - name: query - in: query - required: false - schema: - type: string - example: id=e3334455-1aed-4e71-ab43-6bccf12092ee - description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' - orderBy: - name: orderBy - in: query - required: false - schema: - type: string - example: '-modifiedDate' - description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' - dataType: - name: dataType - description: The key of a Codat data type. - in: path - required: true - schema: - $ref: '#/components/schemas/DataType' - datasetId: - name: datasetId - in: path - required: true - schema: - type: string - format: uuid - description: Unique identifier for the dataset that completed its sync. - description: Unique identifier for the dataset that completed its sync. - platformKey: - name: platformKey - in: path - required: true - schema: - type: string - minLength: 4 - maxLength: 4 - pattern: '[a-z]{4}' - example: gbol - description: 'A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.' - description: A unique 4-letter key to represent a platform in each integration. - webhookId: - name: webhookId - in: path - required: true - schema: - $ref: '#/components/schemas/WebhookConsumer/properties/id' - description: Unique identifier for the webhook consumer. - examples: - connectionManagementAllowedOriginsResponse: - value: - allowedOrigins: - - 'https://www.bank-of-dave.com' securitySchemes: auth_header: name: Authorization @@ -89296,270 +13499,3 @@ 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 5c57c1e8f..7a8bc7ccf 100644 --- a/.speakeasy/logs/changes/old.openapi.yaml +++ b/.speakeasy/logs/changes/old.openapi.yaml @@ -1,22 +1,23 @@ openapi: 3.1.0 -x-stoplight: - id: 466k6ayziv9at -servers: - - description: Production - url: 'https://api.codat.io' info: - title: Platform API - version: 3.0.0 - summary: Platform API - description: "An API for the common components of all of Codat's products.\n\nThese end points cover creating and managing your companies, data connections, and integrations.\n\n[Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) \n\n---\n\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Companies | Create and manage your SMB users' companies. |\n| Connections | Create new and manage existing data connections for a company. |\n| Connection management | Configure connection management UI and retrieve access tokens for authentication. |\n| Webhooks | Create and manage webhooks that listen to Codat's events. |\n| Integrations | Get a list of integrations supported by Codat and their logos. |\n| Refresh data | Initiate data refreshes, view pull status and history. |\n| Settings | Manage company profile configuration, sync settings, and API keys. |\n| Push data | Initiate and monitor Create, Update, and Delete operations. |\n| Supplemental data | Configure and pull additional data you can include in Codat's standard data types. |\n| Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. |\n" - title: Lending + title: Sync for Expenses + version: prealpha + contact: + name: Codat + url: 'https://www.codat.io/' + email: expenses@codat.io description: |- - 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. + The API for Sync for Expenses. + + Sync for Expenses is an API and a set of supporting tools. It has been built to + enable corporate card and expense management platforms to provide high-quality + integrations with multiple accounting software through a standardized API. - 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 product](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) - [Explore solution](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + Not seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). + --- ## Endpoints @@ -24,24 +25,19 @@ info: | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | - | 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. | + | Configuration | View and manage mapping configuration and defaults for expense transactions. | + | Sync | Monitor the status of data syncs. | + | Expenses | Create and update transactions that represent your customers' spend. | + | Transfers | Create and update transactions that represent the movement of your customers' money. | + | Reimbursements | Create and update transactions that represent your customers' repayable spend. | + | Attachments | Attach receipts to a transaction for a complete audit trail. | + | Transaction status | Monitor the status of individual transactions in data syncs. | + | Manage data | Control and monitor the retrieval of data from an integration. | + | Push operations | View historic push operations. | + | Accounts | Create accounts and view account schemas. | + | Customers | Get, create, and update customers. | + | Suppliers | Get, create, and update suppliers. | - version: 3.0.0 - contact: - name: Codat - email: support@codat.io termsOfService: 'https://www.codat.io/legals/' security: - auth_header: [] @@ -82,8 +78,7 @@ x-speakeasy-name-override: methodNameOverride: download-attachment - operationId: ^upload-.*?-attachment methodNameOverride: upload-attachment -x-codat-docs-path: platform-api -x-codat-docs-path: lending-api +x-codat-docs-path: sync-for-expenses-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -96,60 +91,42 @@ x-codat-speakeasy-pagination: tags: - name: Companies description: Create and manage your SMB users' companies. - - name: Connection management - description: Configure UI and retrieve access tokens for authentication used by **Connections SDK**. - - name: Connections - description: Create new and manage existing data connections for a company. - - name: Webhooks - description: Create and manage webhooks that listen to Codat's events. - - name: Integrations - description: Get a list of integrations supported by Codat and their logos. - - name: Refresh data - description: 'Initiate data refreshes, view pull status and history.' - - name: Settings - description: 'Manage company profile configuration, sync settings, and API keys.' - - name: Push data - description: 'Initiate and monitor Create, Update, and Delete operations.' - - name: Read data - description: View validation outcomes for completed read data operations. - - name: Supplemental data - description: Configure and pull additional data you can include in Codat's standard data types. - - name: Custom data type - description: Configure and pull additional data types that are not included in Codat's standardized data model. - name: Connections description: Create new and manage existing data connections for a company. - - 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: 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. + description: View the company information of your customers' linked accounting software. - 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.' + description: Control and monitor the retrieval of data from an integration. + - name: Mapping options + description: 'Get accounts, trackingCategories and taxRates that can be used in your create and update requests.' + - name: Accounts + description: Create accounts and view create account options. + - name: Bank accounts + description: Create bank accounts and view create bank account options. + - name: Customers + description: 'Get, create, and update customers.' + - name: Suppliers + description: 'Get, create, and update suppliers.' + - name: Push operations + description: View historic push operations. + - name: Configuration + description: View and manage mapping configuration and defaults for expense transactions. + - name: Expenses + description: Create and update transactions that represent your customers' spend. + - name: Reimbursements + description: Create and update transactions that represent your customers' repayable spend. + - name: Transfers + description: Create and update transactions that represent the movement of your customers' money. + - name: Adjustments + description: Create transactions that represent your adjustments to your customers' spend. + - name: Attachments + description: Attach receipts to a transaction for a complete audit trail. + - name: Sync + description: Monitor the status of data syncs. + - name: Transaction status + description: Monitor the status of individual transactions in data syncs. +servers: + - url: 'https://api.codat.io' paths: /companies: get: @@ -186,11 +163,6 @@ paths: sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Mike Smith - products: - - spend-insights - - lending - - expenses-v1 - - commerce referenceSubsidiaryCompanies: [] pageNumber: 1 pageSize: 100 @@ -222,10 +194,6 @@ paths: sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Joe Bloggs - products: - - spend-insights - - lending - - payables-v2 referenceSubsidiaryCompanies: [] - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -233,8 +201,6 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar - products: - - spend-insights referenceSubsidiaryCompanies: - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d name: Toft stores UK @@ -260,10 +226,6 @@ paths: sourceType: Accounting created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar - products: - - lending - - spend-insights - - payables referenceParentCompany: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -286,8 +248,6 @@ paths: sourceType: Accounting created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar - products: - - spend-insights referenceParentCompany: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -319,19 +279,12 @@ 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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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" + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x61\x73\x73\x6F\x63\x69\x61\x74\x65\x64\x20\x74\x6F\x20\x79\x6F\x75\x72\x20\x69\x6E\x73\x74\x61\x6E\x63\x65\x73\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/orderBy' - - name: tags - in: query - schema: - type: string - example: region=uk && team=invoice-finance - description: 'Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying).' post: summary: Create company tags: @@ -356,8 +309,6 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar - products: - - spend-insights referenceSubsidiaryCompanies: [] With a description: value: @@ -369,8 +320,6 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar - products: - - spend-insights referenceSubsidiaryCompanies: [] With a tag: value: @@ -382,13 +331,10 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar - products: - - spend-insights tags: region: us referenceSubsidiaryCompanies: [] '400': - $ref: '#/components/responses/Bad-Request' $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' @@ -402,8 +348,7 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x6E\x65\x77\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x49\x66\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x28\x73\x65\x65\x20\x60\x6E\x61\x6D\x65\x60\x20\x70\x61\x74\x74\x65\x72\x6E\x29\x20\x61\x72\x65\x20\x70\x72\x65\x73\x65\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x71\x75\x65\x73\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x72\x65\x6D\x6F\x76\x65\x64\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x28\x43\x6F\x64\x61\x74\x5B\x31\x5D\x29\x60\x20\x77\x69\x74\x68\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x61\x73\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x43\x6F\x64\x61\x74\x31\x60\x2E" - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x6E\x65\x77\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\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" + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x6E\x65\x77\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x74\x68\x61\x74\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x69\x6E\x20\x43\x6F\x64\x61\x74\x2E\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x49\x66\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x28\x73\x65\x65\x20\x60\x6E\x61\x6D\x65\x60\x20\x70\x61\x74\x74\x65\x72\x6E\x29\x20\x61\x72\x65\x20\x70\x72\x65\x73\x65\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x71\x75\x65\x73\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x72\x65\x6D\x6F\x76\x65\x64\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x28\x43\x6F\x64\x61\x74\x5B\x31\x5D\x29\x60\x20\x77\x69\x74\x68\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x61\x73\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x43\x6F\x64\x61\x74\x31\x60\x2E" requestBody: content: application/json: @@ -418,15 +363,10 @@ paths: name: Technicalium description: 'Technology services, including web and app design and development' '/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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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" 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\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 + summary: Update company + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x75\x70\x64\x61\x74\x65\x20\x62\x6F\x74\x68\x20\x74\x68\x65\x20\x6E\x61\x6D\x65\x20\x61\x6E\x64\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" + operationId: update-company parameters: - $ref: '#/components/parameters/companyId' tags: @@ -465,54 +405,12 @@ paths: value: name: Same name description: Additional documents required - patch: - summary: Update company - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x75\x70\x64\x61\x74\x65\x20\x74\x68\x65\x20\x6E\x61\x6D\x65\x2C\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x2C\x20\x6F\x72\x20\x74\x61\x67\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x64\x6F\x65\x73\x6E\x27\x74\x20\x68\x61\x76\x65\x20\x61\x6E\x79\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x66\x69\x65\x6C\x64\x73\x2E\x20\x49\x66\x20\x61\x6E\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x66\x69\x65\x6C\x64\x73\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x61\x72\x65\x20\x60\x6E\x75\x6C\x6C\x60\x20\x6F\x72\x20\x6E\x6F\x74\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2C\x20\x74\x68\x65\x79\x20\x77\x6F\x6E\x27\x74\x20\x62\x65\x20\x69\x6E\x63\x6C\x75\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x70\x64\x61\x74\x65\x2E\x20\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\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' - tags: - - Companies - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Company' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyUpdateRequest' - examples: - Update tags: - value: - tags: - refrence: new reference - Update name: - value: - name: New Name delete: summary: Delete a company operationId: delete-company parameters: - $ref: '#/components/parameters/companyId' - description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x65\x6C\x65\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x65\x72\x6D\x61\x6E\x65\x6E\x74\x6C\x79\x20\x64\x65\x6C\x65\x74\x65\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\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" + description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x65\x6C\x65\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x65\x72\x6D\x61\x6E\x65\x6E\x74\x6C\x79\x20\x64\x65\x6C\x65\x74\x65\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x2C\x20\x69\x74\x73\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x61\x6E\x64\x20\x61\x6E\x79\x20\x63\x61\x63\x68\x65\x64\x20\x64\x61\x74\x61\x2E\x20\x54\x68\x69\x73\x20\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x20\x69\x73\x20\x69\x72\x72\x65\x76\x65\x72\x73\x69\x62\x6C\x65\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" tags: - Companies responses: @@ -535,7 +433,7 @@ paths: get: summary: Get company operationId: get-company - description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x60\x63\x6F\x6D\x70\x61\x6E\x79\x49\x64\x60\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\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" + description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x60\x63\x6F\x6D\x70\x61\x6E\x79\x49\x64\x60\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" parameters: - $ref: '#/components/parameters/companyId' tags: @@ -558,11 +456,6 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar - products: - - spend-insights - - lending - - expenses-v1 - - commerce referenceSubsidiaryCompanies: [] Parent multi-entity company: value: @@ -574,11 +467,6 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar - products: - - spend-insights - - lending - - expenses-v1 - - commerce referenceSubsidiaryCompanies: - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d name: Toft stores UK @@ -608,11 +496,6 @@ paths: sourceType: Accounting created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar - products: - - spend-insights - - lending - - expenses-v1 - - commerce referenceParentCompany: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -633,232 +516,6 @@ paths: $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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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' - 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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" - operationId: replace-company - x-speakeasy-name-override: replace - parameters: - - $ref: '#/components/parameters/companyId' - tags: - - Companies - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Company' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyRequestBody' - examples: - Update name: - value: - name: New Name - Update description: - value: - name: Same name - description: Additional documents required - 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\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E" - operationId: update-company - parameters: - - $ref: '#/components/parameters/companyId' - tags: - - Companies - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Company' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyUpdateRequest' - examples: - Update tags: - value: - tags: - refrence: new reference - Update name: - value: - name: New Name - '/companies/{companyId}/products/{productIdentifier}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/productIdentifier' - put: - summary: Add product - operationId: add-product - x-speakeasy-name-override: add-product - description: |- - Use the *Add product* endpoint to enable a product for the company specified by `companyId`. - - > Note: This feature is currently in alpha and available only to participants in the development program. - tags: - - Companies - responses: - '204': - description: OK - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - delete: - summary: Remove product - operationId: remove-product - x-speakeasy-name-override: remove-product - description: |- - Use the *Remove product* endpoint to disable a product for the company specified by `companyId`. - - > Note: This feature is currently in alpha and available only to participants in the development program. - tags: - - Companies - responses: - '204': - description: OK - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/products/{productIdentifier}/refresh': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/productIdentifier' - post: - summary: Refresh product data - operationId: refresh-product-data - x-speakeasy-name-override: refresh-product-data - description: |- - Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company. - - ### Tips and traps - - - This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead. - - If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response. - - If a company has multiple custom products enabled, you can refresh data for each product individually. - tags: - - Companies - responses: - '202': - description: OK - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - examples: - Standard product not supported: - value: - statusCode: 400 - service: PublicApi - error: 'Bank Feeds doesn''t support data refreshing. For more information, refer to your solution’s documentation [here](https://docs.codat.io).' - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - Read in progress: - value: - statusCode: 400 - service: PublicApi - error: Data cannot be refreshed while a read operation is in progress. Allow the read to complete before attempting to refresh. - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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 @@ -936,7 +593,6 @@ paths: type: object properties: platformKey: - $ref: '#/components/parameters/platformKey/schema' type: string minLength: 4 maxLength: 4 @@ -1082,7 +738,6 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateConnectionStatus' title: Update connection x-internal: true type: object @@ -1097,24 +752,26 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/connections/{connectionId}/authorization': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - put: - summary: Update authorization - operationId: update-connection-authorization - x-speakeasy-name-override: update-authorization - description: Update data connection's authorization. + '/companies/{companyId}/sync/expenses/connections/partnerExpense': + post: tags: - Connections + description: Creates a partner expense data connection + summary: Create partner expense connection + operationId: create-partner-expense-connection + x-speakeasy-name-override: create-partner-expense-connection + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - description: OK + description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1129,37 +786,60 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: - type: string - description: '' - '/companies/{companyId}/accessToken': + '/companies/{companyId}/data/info': 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." + tags: + - Company info + summary: Get company info + description: Gets the latest basic info for a company. + operationId: get-company-info parameters: - $ref: '#/components/parameters/companyId' - tags: - - Companies responses: '200': - description: OK + description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyAccessToken' + $ref: '#/components/schemas/CompanyInformation' examples: - Simple company: + Example 1: value: - expiresIn: 86400 - accessToken: string - tokenType: Bearer + 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': @@ -1168,38 +848,28 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connectionManagement/accessToken': - parameters: - - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/config': get: - summary: Get access token (old) - operationId: get-connection-management-access-token - deprecated: true - x-speakeasy-deprecation-message: | - The endpoint for generating company-specific connection management access tokens has been deprecated. - Codat now supports a global company access token, providing seamless access across multiple products. - Update your integration to use the global token for improved efficiency and consistency. - x-speakeasy-deprecation-replacement: get-company-access-token tags: - - Connection management - description: "\uFEFF\x54\x68\x65\x20\x6E\x65\x77\x20\x5B\x47\x65\x74\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x6B\x65\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\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x63\x6F\x6D\x70\x61\x6E\x79\x2D\x61\x63\x63\x65\x73\x73\x2D\x74\x6F\x6B\x65\x6E\x29\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x70\x6C\x61\x63\x65\x73\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x61\x6E\x64\x20\x69\x6E\x63\x6C\x75\x64\x65\x73\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x66\x75\x6E\x63\x74\x69\x6F\x6E\x61\x6C\x69\x74\x79\x2E" + - Configuration + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ConnectionManagementAccessToken' - examples: - Access token: - value: - accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + $ref: '#/components/schemas/CompanyConfiguration' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1214,22 +884,29 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - /connectionManagement/corsSettings: - get: - summary: Get CORS settings (old) - operationId: get-connection-management-cors-settings - x-speakeasy-group: cors - deprecated: true - x-speakeasy-deprecation-message: | - The new [Get CORS settings](https://docs.codat.io/platform-api#/operations/get-cors-settings) endpoint replaces this endpoint and includes additional functionality. - Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release. - x-speakeasy-deprecation-replacement: get-cors-settings + summary: Get company configuration + description: Gets a company's expense sync configuration + operationId: get-company-configuration + post: tags: - - Settings - description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x43\x4F\x52\x53\x20\x73\x65\x74\x74\x69\x6E\x67\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x74\x68\x65\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x6F\x72\x69\x67\x69\x6E\x73\x20\x28\x69\x2E\x65\x2E\x20\x79\x6F\x75\x72\x20\x64\x6F\x6D\x61\x69\x6E\x73\x29\x20\x79\x6F\x75\x20\x77\x61\x6E\x74\x20\x74\x6F\x20\x61\x6C\x6C\x6F\x77\x20\x63\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x20\x72\x65\x73\x6F\x75\x72\x63\x65\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x28\x5B\x43\x4F\x52\x53\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x65\x6E\x2E\x77\x69\x6B\x69\x70\x65\x64\x69\x61\x2E\x6F\x72\x67\x2F\x77\x69\x6B\x69\x2F\x43\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x5F\x72\x65\x73\x6F\x75\x72\x63\x65\x5F\x73\x68\x61\x72\x69\x6E\x67\x29\x29\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x2E\x20\n\n\x45\x6E\x61\x62\x6C\x69\x6E\x67\x20\x43\x4F\x52\x53\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x20\x69\x73\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x62\x79\x20\x6F\x75\x72\x20\x65\x6D\x62\x65\x64\x64\x61\x62\x6C\x65\x20\x55\x49\x73\x20\x28\x73\x75\x63\x68\x20\x61\x73\x20\x5B\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x53\x44\x4B\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\x70\x74\x69\x6D\x69\x7A\x65\x2F\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2D\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x29\x20\x61\x6E\x64\x20\x5B\x4C\x69\x6E\x6B\x20\x53\x44\x4B\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\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x2D\x65\x6D\x62\x65\x64\x64\x65\x64\x2D\x6C\x69\x6E\x6B\x29\x29\x20\x74\x6F\x20\x61\x63\x63\x65\x73\x73\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x41\x50\x49\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2E" + - Configuration + parameters: + - $ref: '#/components/parameters/companyId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyConfiguration' + examples: {} responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyConfiguration' + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1244,30 +921,26 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - post: - summary: Set CORS settings (old) - operationId: set-connection-management-cors-settings + summary: Set company configuration + description: Sets a company's expense sync configuration + operationId: set-company-configuration x-speakeasy-name-override: set - x-speakeasy-group: cors - deprecated: true - x-speakeasy-deprecation-message: | - The new [Set CORS settings](https://docs.codat.io/platform-api#/operations/set-cors-settings) endpoint replaces this endpoint and includes additional functionality. - Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release. - x-speakeasy-deprecation-replacement: set-cors-settings + parameters: + - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/mappingOptions': + get: tags: - - Settings - description: "\uFEFF\x54\x68\x65\x20\x2A\x53\x65\x74\x20\x43\x4F\x52\x53\x20\x73\x65\x74\x74\x69\x6E\x67\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x72\x65\x67\x69\x73\x74\x65\x72\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x6F\x72\x69\x67\x69\x6E\x73\x20\x28\x69\x2E\x65\x2E\x20\x79\x6F\x75\x72\x20\x64\x6F\x6D\x61\x69\x6E\x73\x29\x20\x66\x6F\x72\x20\x75\x73\x65\x20\x69\x6E\x20\x63\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x20\x72\x65\x73\x6F\x75\x72\x63\x65\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x28\x5B\x43\x4F\x52\x53\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x65\x6E\x2E\x77\x69\x6B\x69\x70\x65\x64\x69\x61\x2E\x6F\x72\x67\x2F\x77\x69\x6B\x69\x2F\x43\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x5F\x72\x65\x73\x6F\x75\x72\x63\x65\x5F\x73\x68\x61\x72\x69\x6E\x67\x29\x29\x2E\n\x20\n\x45\x6E\x61\x62\x6C\x69\x6E\x67\x20\x43\x4F\x52\x53\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x20\x69\x73\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x62\x79\x20\x6F\x75\x72\x20\x65\x6D\x62\x65\x64\x64\x61\x62\x6C\x65\x20\x55\x49\x73\x20\x28\x73\x75\x63\x68\x20\x61\x73\x20\x5B\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x53\x44\x4B\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\x70\x74\x69\x6D\x69\x7A\x65\x2F\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2D\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x29\x20\x61\x6E\x64\x20\x5B\x4C\x69\x6E\x6B\x20\x53\x44\x4B\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\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x2D\x65\x6D\x62\x65\x64\x64\x65\x64\x2D\x6C\x69\x6E\x6B\x29\x29\x20\x74\x6F\x20\x61\x63\x63\x65\x73\x73\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x41\x50\x49\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2E\x20" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionManagementAllowedOrigins' - examples: - Allowed origins: - $ref: '#/components/examples/connectionManagementAllowedOriginsResponse' + - Mapping options + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MappingOptions' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1282,16 +955,26 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - /corsSettings: + description: 'Gets the mapping options (accounts, trackingCategories and taxRates) for a company''s accounting software' + summary: Mapping options + operationId: get-mapping-options + x-speakeasy-name-override: get-mapping-options + parameters: + - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/syncs/lastSuccessful/status': get: - summary: Get CORS settings - operationId: get-cors-settings tags: - - Settings - description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x43\x4F\x52\x53\x20\x73\x65\x74\x74\x69\x6E\x67\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x74\x68\x65\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x6F\x72\x69\x67\x69\x6E\x73\x20\x28\x69\x2E\x65\x2E\x20\x79\x6F\x75\x72\x20\x64\x6F\x6D\x61\x69\x6E\x73\x29\x20\x79\x6F\x75\x20\x77\x61\x6E\x74\x20\x74\x6F\x20\x61\x6C\x6C\x6F\x77\x20\x63\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x20\x72\x65\x73\x6F\x75\x72\x63\x65\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x28\x5B\x43\x4F\x52\x53\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x65\x6E\x2E\x77\x69\x6B\x69\x70\x65\x64\x69\x61\x2E\x6F\x72\x67\x2F\x77\x69\x6B\x69\x2F\x43\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x5F\x72\x65\x73\x6F\x75\x72\x63\x65\x5F\x73\x68\x61\x72\x69\x6E\x67\x29\x29\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x2E\x20\n\n\x45\x6E\x61\x62\x6C\x69\x6E\x67\x20\x43\x4F\x52\x53\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x20\x69\x73\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x62\x79\x20\x6F\x75\x72\x20\x65\x6D\x62\x65\x64\x64\x61\x62\x6C\x65\x20\x55\x49\x73\x20\x28\x73\x75\x63\x68\x20\x61\x73\x20\x5B\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x53\x44\x4B\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\x70\x74\x69\x6D\x69\x7A\x65\x2F\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2D\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x29\x20\x61\x6E\x64\x20\x5B\x4C\x69\x6E\x6B\x20\x53\x44\x4B\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\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x2D\x65\x6D\x62\x65\x64\x64\x65\x64\x2D\x6C\x69\x6E\x6B\x29\x29\x20\x74\x6F\x20\x61\x63\x63\x65\x73\x73\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x41\x50\x49\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2E" + - Sync + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1306,24 +989,26 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - post: - summary: Set CORS settings - operationId: set-cors-settings - x-speakeasy-name-override: set + description: Gets the status of the last successful sync + summary: Last successful sync + operationId: get-last-successful-sync + x-speakeasy-name-override: get-last-successful-sync + parameters: + - $ref: '#/components/parameters/companyId' + '/companies/{companyId}/sync/expenses/syncs/latest/status': + get: tags: - - Settings - description: "\uFEFF\x54\x68\x65\x20\x2A\x53\x65\x74\x20\x43\x4F\x52\x53\x20\x73\x65\x74\x74\x69\x6E\x67\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x72\x65\x67\x69\x73\x74\x65\x72\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x6F\x72\x69\x67\x69\x6E\x73\x20\x28\x69\x2E\x65\x2E\x20\x79\x6F\x75\x72\x20\x64\x6F\x6D\x61\x69\x6E\x73\x29\x20\x66\x6F\x72\x20\x75\x73\x65\x20\x69\x6E\x20\x63\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x20\x72\x65\x73\x6F\x75\x72\x63\x65\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x28\x5B\x43\x4F\x52\x53\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x65\x6E\x2E\x77\x69\x6B\x69\x70\x65\x64\x69\x61\x2E\x6F\x72\x67\x2F\x77\x69\x6B\x69\x2F\x43\x72\x6F\x73\x73\x2D\x6F\x72\x69\x67\x69\x6E\x5F\x72\x65\x73\x6F\x75\x72\x63\x65\x5F\x73\x68\x61\x72\x69\x6E\x67\x29\x29\x2E\n\x20\n\x45\x6E\x61\x62\x6C\x69\x6E\x67\x20\x43\x4F\x52\x53\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x20\x69\x73\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x62\x79\x20\x6F\x75\x72\x20\x65\x6D\x62\x65\x64\x64\x61\x62\x6C\x65\x20\x55\x49\x73\x20\x28\x73\x75\x63\x68\x20\x61\x73\x20\x5B\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x53\x44\x4B\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\x70\x74\x69\x6D\x69\x7A\x65\x2F\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2D\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x29\x20\x61\x6E\x64\x20\x5B\x4C\x69\x6E\x6B\x20\x53\x44\x4B\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\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x2D\x65\x6D\x62\x65\x64\x64\x65\x64\x2D\x6C\x69\x6E\x6B\x29\x29\x20\x74\x6F\x20\x61\x63\x63\x65\x73\x73\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x41\x50\x49\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2E" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionManagementAllowedOrigins' - examples: - Allowed origins: - $ref: '#/components/examples/connectionManagementAllowedOriginsResponse' + - Sync + parameters: + - $ref: '#/components/parameters/companyId' responses: '200': - $ref: '#/components/responses/ConnectionManagementAllowedOrigins' + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1338,21 +1023,28 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/all': + description: Gets the latest sync status + summary: Latest sync status + operationId: get-latest-sync + x-speakeasy-name-override: get-latest-sync parameters: - $ref: '#/components/parameters/companyId' - post: - summary: Refresh all data - operationId: refresh-company-data - x-speakeasy-name-override: all - operationId: refresh-all-data-types - x-speakeasy-group: manage-data.refresh - x-speakeasy-name-override: all-data-types + '/companies/{companyId}/sync/expenses/syncs/list/status': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Sync responses: - '204': - description: No Content - '400': - $ref: '#/components/responses/Malformed-Query' + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CompanySyncStatus' + examples: {} '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1367,42 +1059,59 @@ paths: $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`. + summary: List sync statuses + description: Gets a list of sync statuses + operationId: list-syncs + '/companies/{companyId}/sync/expenses/syncs/{syncId}/status': + get: tags: - - Refresh data - '/companies/{companyId}/data/queue/{dataType}': + - Sync + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CompanySyncStatus' + 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 sync status + description: Get the sync status for a specified sync + operationId: get-sync-by-id parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/dataType' - post: - summary: Refresh data type - operationId: refresh-data-type - x-speakeasy-name-override: by-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: - - Refresh data + - $ref: '#/components/parameters/syncId' + '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions': + get: parameters: - - schema: - type: string - format: uuid - in: query - name: connectionId - description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' responses: '200': - description: OK + description: Success content: application/json: schema: - $ref: '#/components/schemas/PullOperation' + $ref: '#/components/schemas/Transactions' + examples: {} '400': $ref: '#/components/responses/Malformed-Query' '401': @@ -1419,423 +1128,74 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - - Manage data - '/companies/{companyId}/dataStatus': + tags: + - Transaction status + summary: List sync transactions + description: Gets the transactions and status for a sync + operationId: list-sync-transactions parameters: - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}': get: - summary: Get data status - operationId: get-company-data-status - description: Get the state of each data type for a company + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/transactionId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionResponse' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' tags: - - Refresh data - 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 + - Transaction status + summary: Get sync transaction + description: Gets the status of a transaction for a sync + operationId: get-sync-transaction + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/transactionId' + '/companies/{companyId}/sync/expenses/expense-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Create expense transaction + operationId: create-expense-transaction + description: "The *Create expense* endpoint creates an [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) in the accounting software for a given company's connection. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. \n\n### Supported Integrations\n\n| Integration | Supported |\n|-------------------------------|-----------|\n| Dynamics 365 Business Central | Yes |\n| FreeAgent | Yes |\n| QuickBooks Desktop | Yes |\n| QuickBooks Online | Yes |\n| Oracle NetSuite | Yes |\n| Xero | Yes |" tags: - - Manage data + - Expenses responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/DataStatuses' - 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 + $ref: '#/components/schemas/CreateExpenseResponse' examples: - Example: + Example 1: 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 + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1850,37 +1210,78 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/queue/{dataType}': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExpenseRequest' + examples: + Payment: + value: + - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 + type: Payment + issueDate: '2024-05-21T00:00:00+00:00' + currency: GBP + currencyRate: 1 + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + Refund: + value: + - id: 7008d3f2-aeb4-11ed-afa1-0242ac120002 + type: Refund + issueDate: '2024-02-17T00:00:00+00:00' + currency: GBP + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '42' + trackingRefs: + - id: DEPARTMENT_6 + '/companies/{companyId}/sync/expenses/expense-transactions/{transactionId}': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/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. + - $ref: '#/components/parameters/transactionId' + put: + summary: Update expense transactions tags: - - Manage data - parameters: - - schema: - type: string - format: uuid - in: query - name: connectionId - description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + - Expenses responses: - '200': - description: OK + '202': + description: Accepted content: application/json: schema: - $ref: '#/components/schemas/PullOperation' + $ref: '#/components/schemas/UpdateExpenseResponse' '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1889,56 +1290,72 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '422': + $ref: '#/components/responses/Unprocessable-Content' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/history': + operationId: update-expense-transaction + description: "The *Update expense* endpoint updates an existing [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) in the accounting software for a given company's connection. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. \n\n### Supported Integrations\nThe following integrations are supported for the [Payment](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) transaction `type` only: \n| Integration | Supported |\n|-----------------------|-----------|\n| FreeAgent | Yes |\n| QuickBooks Online | Yes |\n| Oracle NetSuite | Yes |\n| Xero | Yes |" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExpenseRequest' + examples: + Payment: + value: + type: Payment + issueDate: '2024-05-21T00:00:00+00:00' + currency: GBP + currencyRate: 1 + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + '/companies/{companyId}/sync/expenses/transfer-transactions/{transactionId}': parameters: - $ref: '#/components/parameters/companyId' - get: - summary: List pull operations + - $ref: '#/components/parameters/transactionId' + put: + summary: Create transfer transaction + operationId: create-transfer-transaction + description: "Use the *Create transfer* endpoint to create or update a [transfer transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/TransferTransactionRequest) in the accounting software for a given company's connection. \r\n\r\nTransfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card.\r\n\r\nThe `from.amount` and `to.amount` fields are in the native currency of the account.\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Xero | Yes |" tags: - - Refresh data - operationId: list-pull-operations - x-speakeasy-name-override: list-pull-operations - - Manage data - operationId: list-pull-operations - x-speakeasy-group: manage-data.pull-operations + - Transfers responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/PullOperations' + $ref: '#/components/schemas/TransferTransactionResponse' examples: - Example: + Example 1: value: - results: - - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b - companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 - connectionId: 51baa045-4836-4317-a42e-3542e991e581 - dataType: invoices - status: Initial - requested: '2022-11-14T11:18:37.2798351Z' - progress: 10 - isCompleted: false - isErrored: false - _links: - current: - href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 - self: - href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history - next: - href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 - pageNumber: 0 - pageSize: 0 - totalResults: 0 + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1953,33 +1370,47 @@ paths: $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}': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferTransactionRequest' + examples: + Create transfer: + value: + description: Sample transfer description + date: '2021-05-21T00:00:00+00:00' + from: + accountRef: + id: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea + amount: 100 + to: + accountRef: + id: 777dfb37-5506-3dc0-6g86-8d34z4cc78ea + amount: 100 + '/companies/{companyId}/sync/expenses/adjustment-transactions': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/datasetId' - get: - summary: Get pull operation - operationId: get-pull-operation - x-speakeasy-name-override: get-pull-operation - tags: - - Refresh data - x-speakeasy-group: manage-data.pull-operations + post: + summary: Create adjustment transaction + operationId: create-adjustment-transaction + description: "Use the *Create adjustment expense* endpoint to create an [adjustment](https://docs.codat.io/sync-for-expenses-api#/schemas/AdjustmentTransactionRequest) in the accounting software for a given company's connection. \n\nAdjustments represent write-offs and transaction alterations, such as foreign exchange adjustments, in the form of a journal entry. \n\n### Supported Integrations\n\n| Integration | Supported |\n|-----------------------|-----------|\n| QuickBooks Desktop | Yes |" tags: - - Manage data + - Adjustments responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/PullOperation' - examples: {} + $ref: '#/components/schemas/AdjustmentTransactionResponse' + examples: + Example 1: + value: + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1994,252 +1425,191 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: Retrieve information about a single dataset or pull operation. - /webhooks: - get: - summary: List webhook consumers - operationId: list-webhook-consumers - x-speakeasy-name-override: list-consumers - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x72\x65\x74\x75\x72\x6E\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x73\x20\x74\x68\x61\x74\x20\x63\x75\x72\x72\x65\x6E\x74\x6C\x79\x20\x65\x78\x69\x73\x74\x20\x66\x6F\x72\x20\x79\x6F\x75\x72\x20\x63\x6C\x69\x65\x6E\x74\x2E\n\n\x5B\x57\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x57\x65\x62\x68\x6F\x6F\x6B\x43\x6F\x6E\x73\x75\x6D\x65\x72\x29\x20\x69\x73\x20\x61\x6E\x20\x48\x54\x54\x50\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x68\x61\x74\x20\x79\x6F\x75\x20\x63\x6F\x6E\x66\x69\x67\x75\x72\x65\x20\x74\x6F\x20\x73\x75\x62\x73\x63\x72\x69\x62\x65\x20\x74\x6F\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x65\x76\x65\x6E\x74\x73\x2E\x20\x53\x65\x65\x20\x6F\x75\x72\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x64\x65\x74\x61\x69\x6C\x73\x20\x6F\x6E\x20\x5B\x43\x6F\x64\x61\x74\x27\x73\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x73\x65\x72\x76\x69\x63\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\x77\x65\x62\x68\x6F\x6F\x6B\x73\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E" - tags: - - Webhooks - '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status': + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAdjustmentRequest' + examples: + Create adjustment: + value: + - id: 3357b3df-5f2e-465d-b9ba-226519dbb8f1 + date: '2024-05-21T00:00:00+00:00' + currency: USD + currencyRate: 1 + reference: test reference + lines: + - amount: 50 + accountRef: + id: 80000018-1671793811 + description: debit line + trackingRefs: + - id: 80000003-1674553958 + dataType: trackingCategories + invoiceTo: + id: 80000002-1674552702 + type: customer + - amount: -50 + accountRef: + id: 80000028-1671794219 + description: credit line + trackingRefs: + - id: 80000003-1674553958 + dataType: trackingCategories + '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/dataIntegrityDataType' - get: - summary: Get data integrity status + post: + summary: Create reimbursable expense transaction + operationId: create-reimbursable-expense-transaction + description: "Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.\r\n\r\n[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |" tags: - - Data integrity + - Reimbursements responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/WebhookConsumer/definitions/webhookConsumers' + $ref: '#/components/schemas/CreateReimbursableExpenseResponse' examples: - Webhook consumers: + Example 1: value: - results: - - id: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - url: 'https://example.com/webhoook-consumers/sync-complete' - eventTypes: - - DataSyncCompleted - disabled: false - - id: ca3cac86-7925-4759-abc2-96405780fdfa - url: 'https://example.com/webhoook-consumers/dataset-changed' - eventTypes: - - DatasetDataChanged - disabled: true + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Bad-Request' + $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: - summary: Create webhook consumer - operationId: create-webhook-consumer - x-speakeasy-name-override: create-consumer - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\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\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x20\x74\x68\x61\x74\x20\x77\x69\x6C\x6C\x20\x6C\x69\x73\x74\x65\x6E\x20\x74\x6F\x20\x6D\x65\x73\x73\x61\x67\x65\x73\x20\x77\x65\x20\x73\x65\x6E\x64\x20\x79\x6F\x75\x2E\n\n\x5B\x57\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x57\x65\x62\x68\x6F\x6F\x6B\x43\x6F\x6E\x73\x75\x6D\x65\x72\x29\x20\x69\x73\x20\x61\x6E\x20\x48\x54\x54\x50\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x68\x61\x74\x20\x79\x6F\x75\x20\x63\x6F\x6E\x66\x69\x67\x75\x72\x65\x20\x74\x6F\x20\x73\x75\x62\x73\x63\x72\x69\x62\x65\x20\x74\x6F\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x65\x76\x65\x6E\x74\x73\x2E\x20\x53\x65\x65\x20\x6F\x75\x72\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x64\x65\x74\x61\x69\x6C\x73\x20\x6F\x6E\x20\x5B\x43\x6F\x64\x61\x74\x27\x73\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x73\x65\x72\x76\x69\x63\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\x77\x65\x62\x68\x6F\x6F\x6B\x73\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E\n\n\x23\x23\x23\x20\x54\x69\x70\x73\x20\x61\x6E\x64\x20\x74\x72\x61\x70\x73\n\x2D\x20\x54\x68\x65\x20\x6E\x75\x6D\x62\x65\x72\x20\x6F\x66\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x73\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x63\x72\x65\x61\x74\x65\x20\x69\x73\x20\x6C\x69\x6D\x69\x74\x65\x64\x20\x74\x6F\x20\x35\x30\x2E\x20\x49\x66\x20\x79\x6F\x75\x20\x68\x61\x76\x65\x20\x72\x65\x61\x63\x68\x65\x64\x20\x74\x68\x65\x20\x6D\x61\x78\x69\x6D\x75\x6D\x20\x6E\x75\x6D\x62\x65\x72\x20\x6F\x66\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x73\x2C\x20\x75\x73\x65\x20\x74\x68\x65\x20\x5B\x2A\x44\x65\x6C\x65\x74\x65\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x2A\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x64\x65\x6C\x65\x74\x65\x2D\x77\x65\x62\x68\x6F\x6F\x6B\x2D\x63\x6F\x6E\x73\x75\x6D\x65\x72\x29\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x64\x65\x6C\x65\x74\x65\x20\x61\x6E\x20\x75\x6E\x75\x73\x65\x64\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x20\x66\x69\x72\x73\x74\x2E" - tags: - - Webhooks requestBody: content: application/json: schema: - $ref: '#/components/schemas/WebhookConsumer/definitions/webhookConsumerPrototype' + $ref: '#/components/schemas/ReimbursableExpenseTransactionRequest' examples: - Subscribe consumer to one or more event types: - value: - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - - Dataset data changed - Subscribe consumer with disabled endpoint: + Create reimbursable expense: value: - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - disabled: true + - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 + reference: expenses w/c 01/07 + contactRef: + id: '752' + issueDate: '2024-05-21' + dueDate: '2024-05-21' + currency: GBP + currencyRate: 1 + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - description: Hotel + netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/transactionId' + put: + summary: Update reimbursable expense transaction + operationId: update-reimbursable-expense-transaction + description: "The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection. \r\n\r\nUpdating an existing [reimbursable expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateReimbursableExpenseTransactionRequest) will update the existing **bill** against an employee (who exists as a supplier in the accounting software).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |" + tags: + - Reimbursements responses: - '201': + '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/WebhookConsumer' + $ref: '#/components/schemas/CreateReimbursableExpenseResponse' examples: - Subscribe consumer to one or more event types: - value: - id: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - - DatasetDataChanged - disabled: false - Subscribe consumer with disabled endpoint: + Example 1: value: - id: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - url: 'https://example.com/webhoook-consumer' - eventTypes: - - DataSyncCompleted - disabled: true + syncId: cd937d46-8e41-43a9-9477-a79158ffd98a '400': - $ref: '#/components/responses/Bad-Request' + $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/{webhookId}': - parameters: - - $ref: '#/components/parameters/webhookId' - delete: - summary: Delete webhook consumer - operationId: delete-webhook-consumer - x-speakeasy-name-override: delete-consumer - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x44\x65\x6C\x65\x74\x65\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x64\x65\x6C\x65\x74\x65\x20\x61\x6E\x20\x65\x78\x69\x73\x74\x69\x6E\x67\x20\x77\x65\x62\x68\x6F\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x2C\x20\x70\x72\x6F\x76\x69\x64\x69\x6E\x67\x20\x69\x74\x73\x20\x76\x61\x6C\x69\x64\x20\x60\x69\x64\x60\x20\x61\x73\x20\x61\x20\x70\x61\x72\x61\x6D\x65\x74\x65\x72\x2E\n\n\x5B\x57\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x57\x65\x62\x68\x6F\x6F\x6B\x43\x6F\x6E\x73\x75\x6D\x65\x72\x29\x20\x69\x73\x20\x61\x6E\x20\x48\x54\x54\x50\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x68\x61\x74\x20\x79\x6F\x75\x20\x63\x6F\x6E\x66\x69\x67\x75\x72\x65\x20\x74\x6F\x20\x73\x75\x62\x73\x63\x72\x69\x62\x65\x20\x74\x6F\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x65\x76\x65\x6E\x74\x73\x2E\x20\x53\x65\x65\x20\x6F\x75\x72\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x64\x65\x74\x61\x69\x6C\x73\x20\x6F\x6E\x20\x5B\x43\x6F\x64\x61\x74\x27\x73\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x73\x65\x72\x76\x69\x63\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\x77\x65\x62\x68\x6F\x6F\x6B\x73\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E" - tags: - - Webhooks - responses: - '204': - description: No content - $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' - /webhooks/integrationKeys/zapier: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReimbursableExpenseTransactionRequest' + examples: + Update reimbursable expense: + value: + reference: expenses w/c 01/07 + contactRef: + id: '752' + issueDate: '2024-05-21' + dueDate: '2024-05-21' + currency: GBP + currencyRate: 1 + notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + - description: Hotel + netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_5 + dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/syncId' + - $ref: '#/components/parameters/transactionId' post: - summary: Rotate Zapier key - operationId: rotate-zapier-key - x-speakeasy-ignore: true - description: "\uFEFF\x54\x68\x65\x20\x2A\x52\x6F\x74\x61\x74\x65\x20\x5A\x61\x70\x69\x65\x72\x20\x6B\x65\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x74\x68\x65\x20\x5A\x61\x70\x69\x65\x72\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6B\x65\x79\x20\x6E\x65\x65\x64\x65\x64\x20\x74\x6F\x20\x63\x6F\x6E\x66\x69\x67\x75\x72\x65\x20\x5A\x61\x70\x73\x20\x74\x72\x69\x67\x67\x65\x72\x65\x64\x20\x62\x79\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x77\x65\x62\x68\x6F\x6F\x6B\x73\x2E\x20\n\n\x49\x66\x20\x61\x20\x6B\x65\x79\x20\x68\x61\x73\x20\x61\x6C\x72\x65\x61\x64\x79\x20\x62\x65\x65\x6E\x20\x63\x72\x65\x61\x74\x65\x64\x2C\x20\x63\x61\x6C\x6C\x69\x6E\x67\x20\x74\x68\x69\x73\x20\x77\x69\x6C\x6C\x20\x72\x65\x76\x6F\x6B\x65\x20\x74\x68\x61\x74\x20\x65\x78\x69\x73\x74\x69\x6E\x67\x20\x6B\x65\x79\x2E\n\n\x54\x68\x65\x20\x6B\x65\x79\x20\x63\x68\x61\x6E\x67\x65\x73\x20\x65\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\x2E\x20\x49\x66\x20\x79\x6F\x75\x20\x61\x72\x65\x20\x61\x6C\x72\x65\x61\x64\x79\x20\x75\x73\x69\x6E\x67\x20\x6F\x75\x72\x20\x5A\x61\x70\x69\x65\x72\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x61\x6E\x64\x20\x63\x61\x6C\x6C\x65\x64\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x61\x67\x61\x69\x6E\x2C\x20\x79\x6F\x75\x20\x6E\x65\x65\x64\x20\x74\x6F\x20\x72\x65\x61\x75\x74\x68\x65\x6E\x74\x69\x63\x61\x74\x65\x20\x75\x73\x69\x6E\x67\x20\x74\x68\x65\x20\x6C\x61\x74\x65\x73\x74\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6B\x65\x79\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\n\n\x4F\x75\x72\x20\x5A\x61\x70\x69\x65\x72\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6D\x61\x6B\x65\x73\x20\x69\x74\x20\x73\x69\x6D\x70\x6C\x65\x20\x66\x6F\x72\x20\x79\x6F\x75\x20\x74\x6F\x20\x73\x65\x74\x20\x75\x70\x20\x61\x6E\x64\x20\x72\x65\x63\x65\x69\x76\x65\x20\x75\x73\x65\x72\x20\x6E\x6F\x74\x69\x66\x69\x63\x61\x74\x69\x6F\x6E\x73\x20\x69\x6E\x20\x79\x6F\x75\x72\x20\x70\x72\x65\x66\x65\x72\x72\x65\x64\x20\x77\x61\x79\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x76\x69\x61\x20\x65\x6D\x61\x69\x6C\x20\x6F\x72\x20\x53\x6C\x61\x63\x6B\x2E\x20\x53\x65\x65\x20\x6F\x75\x72\x20\x5B\x5A\x61\x70\x69\x65\x72\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\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\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x77\x65\x62\x68\x6F\x6F\x6B\x73\x2F\x7A\x61\x70\x69\x65\x72\x2D\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x29\x20\x66\x6F\x72\x20\x64\x65\x74\x61\x69\x6C\x65\x64\x20\x69\x6E\x73\x74\x72\x75\x63\x74\x69\x6F\x6E\x73\x20\x6F\x6E\x20\x73\x65\x74\x74\x69\x6E\x67\x20\x75\x70\x20\x74\x68\x69\x73\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2E\n\n" - tags: - - Webhooks - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/WebhookZapierKey' - examples: - Integration key: - value: - key: sk_integ_WM4dfoK1nKZnDE_kceze6hWDjbRwOZwG.us - '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' - /integrations: - get: - summary: List integrations - description: List your available integrations - tags: - - Integrations - operationId: list-integrations - 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/Integrations' - $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 + summary: Upload attachment + operationId: upload-expense-attachment + x-speakeasy-name-override: upload responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/DataIntegrityDetails' + $ref: '#/components/schemas/Attachment' examples: {} '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2254,375 +1624,23 @@ paths: $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': + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/AttachmentUpload' + tags: + - Attachments + description: "The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations.\n\n**Integration-specific behaviour**\n\nEach accounting software supports different file formats and sizes.\n\n| Integration | File size | File extension |Supported transaction type\n|-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------|\n| **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types |\n| **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` |\n| **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` |\n| **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types\n| **QuickBooks Desktop** | NA | Does not support attachment upload | N/A |\n| **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF " + '/companies/{companyId}/data/all': parameters: - $ref: '#/components/parameters/companyId' - 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 + post: + summary: Refresh all data + operationId: refresh-all-data-types 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' + '204': + description: No Content '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2637,80316 +1655,8309 @@ paths: $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. + Refreshes all data types with `fetch on first link` set to `true` for a given company. - 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" + 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: - - 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': + - Manage data + '/companies/{companyId}/dataStatus': parameters: - $ref: '#/components/parameters/companyId' get: - summary: List reconciled invoices + summary: Get data status + operationId: get-data-status + description: Get the state of each data type for a company 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' + - Manage data 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' - '/integrations/{platformKey}': - parameters: - - $ref: '#/components/parameters/platformKey' - get: - summary: Get integration - tags: - - Integrations - operationId: get-integration - description: 'Get single integration, by platformKey' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Integration' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/integrations/{platformKey}/branding': - parameters: - - $ref: '#/components/parameters/platformKey' - get: - summary: Get branding - tags: - - Integrations - operationId: get-integrations-branding - x-speakeasy-name-override: get-branding - description: Get branding for platform. - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Branding' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - /profile: - get: - summary: Get profile - tags: - - Settings - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Profile' - examples: {} - '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' - operationId: get-profile - x-speakeasy-name-override: get-profile - description: Fetch your Codat profile. - put: - summary: Update profile - operationId: update-profile - x-speakeasy-name-override: update-profile - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Profile' - examples: {} - '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' - tags: - - Settings - description: Update your Codat profile - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Profile' - examples: {} - description: All fields should be included when updating your profile. - /profile/syncSettings: - get: - summary: Get sync settings - tags: - - Settings - operationId: get-profile-syncSettings - x-speakeasy-name-override: get-sync-settings - description: 'Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SyncSettings' - examples: - Example: - value: - clientId: 367f7975-267b-439b-90c6-a6040ee680f3 - settings: - - dataType: invoices - fetchOnFirstLink: true - syncSchedule: 24 - syncOrder: 0 - syncFromUtc: '2020-01-01T12:00:00.000Z' - syncFromWindow: 24 - monthsToSync: 24 - isLocked: true - overridesDefaults: true - '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' - post: - summary: Update all sync settings - description: Update sync settings for all data types. - tags: - - Settings - operationId: update-profile-syncSettings - x-speakeasy-name-override: update-sync-settings - responses: - '204': - description: No Content - '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' - requestBody: - content: - application/json: - schema: - allOf: - - properties: - clientId: - $ref: '#/components/schemas/ClientId' - settings: - type: array - items: - $ref: '#/components/schemas/SyncSetting' - overridesDefaults: - type: boolean - default: true - description: 'Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).' - required: - - clientId - - settings - - overridesDefaults - type: object - description: |- - Include a `syncSetting` object for each data type. - `syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them. - /apiKeys: - get: - summary: List API keys - description: |- - Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint. - - [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - - You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - operationId: list-api-keys - x-speakeasy-name-override: list-api-keys - tags: - - Settings - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ApiKeys' - examples: - Example: - value: - results: - - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-11T13:49:37Z' - - id: c438836a-61fe-443f-8a19-24cc18be21e4 - name: azure-invoice-finance-processor - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-23T09:43:48Z' - '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' - post: - summary: Create API key - operationId: create-api-key - x-speakeasy-name-override: create-api-key - description: "Use the *Create API keys* endpoint to generate a new API key for your client.\n\n[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key.\n\nYou can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.\n\n### Tips and pitfalls\n\n* Your first API key is created for you. Access this key via [Codat's Portal](https://app.codat.io/developers/api-keys).\n* If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint. \n* The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first." - tags: - - Settings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateApiKey' - examples: - Create API key with name: - value: - name: azure-invoice-finance-processor - responses: - '201': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ApiKeyDetails' - examples: - API key details: - value: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-11T13:49:37Z' - API key details with name: - value: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: azure-invoice-finance-processor - apiKey: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - createdDate: '2022-04-11T13:49:37Z' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - examples: - Max length for name reached: - value: - statusCode: 400 - service: PublicApi - error: Max string length (50) for `name` reached. - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '409': - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - examples: - Max length for name reached: - value: - statusCode: 400 - service: PublicApi - error: 'Maximum number of API keys reached. To create a new API key, delete an unused key and try again.' - correlationId: bc997528a9d7abb9161ef45f05d38599 - canBeRetried: Unknown - detailedErrorCode: 0 - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/apiKeys/{apiKeyId}': - delete: - summary: Delete API key - operationId: delete-api-key - x-speakeasy-name-override: delete-api-key - parameters: - - name: apiKeyId - in: path - required: true - schema: - type: string - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for api key. - description: |- - Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible. - - [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - - You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - - ### Tips and pitfalls - - * It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal. - * It is possible to delete the API key used to authenticate the *Delete API key* request. - tags: - - Settings - responses: - '204': - description: No Content - $ref: '#/components/responses/Too-Many-Requests' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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}/sync/{datasetId}/validation': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/datasetId' - get: - summary: Get validation results - tags: - - Read data - operationId: get-read-validation-results - x-speakeasy-name-override: get-validation-results - description: |- - Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase. - - The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays: - - - **`warnings`** array lists potential issues with the data type that may require attention but don't block usage. - - **`errors`** array contains critical issues that must be resolved before the data type can be used. - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationResult' - examples: - Validation result: - value: - errors: - - ruleId: accounting-bill-030 - itemId: fc2f2d1a-ff4d-40c6-a7fb-4bd7d04f4008 - message: A bill's lines summed (69.99) should be the same as TotalAmount (70.00). - validatorName: BillValidator - warnings: - - ruleId: accounting-bill-032 - itemId: 1d3979e5-7c28-432e-b562-04e9013c1ea0 - message: A bill's lines sub total amount summed (3201.20) should be the same as SubTotal (3201.25) - validatorName: BillValidator - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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/{dataType}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/dataType' - get: - summary: Get push options - tags: - - Push data - operationId: get-create-update-model-options-by-data-type - x-speakeasy-name-override: get-model-options - 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: - 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' - description: "This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information. \n\nBefore pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear.\n\nCodat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented \"options\" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field." - '/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 - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: false - validation: - warnings: [] - information: - - field: IssueDate - details: 'If the issue date is not supplied, the current date on the server is used.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: - - field: Reference - details: Must be less than 22 characters. - information: [] - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company. - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: false - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: false - validation: - warnings: - - field: Allocation.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: false - validation: - warnings: - - field: Allocation.Currency - details: Must match the Currency of the company - information: [] - required: false - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: false - validation: - warnings: - - field: Payment.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency for the payment - required: false - validation: - warnings: - - field: Payment.Currency - details: Must match the Currency of the company - information: [] - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: [] - information: - - field: AccountRef.Id - details: 'Must be Bank, Cash or Asset account' - required: true - required: true - required: true - validation: - warnings: - - field: PaymentAllocations - details: Must have exactly one payment allocation. - information: [] - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - validation: - warnings: - - field: TrackingCategoryRefs.TrackingCategoryRefs - details: Must be a valid Id - information: [] - required: false - validation: - warnings: - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type CLASS can be provided per item. - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type DEPARTMENT can be provided per invoice. - - field: LineItems.TrackingCategoryRefs - details: All DEPARTMENT tracking categories must be the same - information: [] - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be an Expense or Income account - information: [] - required: false - validation: - warnings: - - field: LineItems.AccountRef - details: Must be set if ItemRef is not - information: [] - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: true - required: false - validation: - warnings: - - field: LineItems.ItemRef - details: Must be set if AccountRef is not - information: [] - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: false - validation: - warnings: - - field: LineItems.Description - details: Must be less than 4000 characters. - information: [] - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: false - validation: - warnings: - - field: LineItems.TaxAmount - details: Must be specified on all line items or none. If specified will override QBO tax calculations. - information: [] - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - validation: - warnings: [] - information: - - field: TaxRateRef.Id - details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' - required: false - validation: - warnings: - - field: LineItems.TaxRateRef - details: Required for all companies except QuickBooks Online France companies. - information: [] - required: true - required: true - QuickBooks Online: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - options: - - value: Suppliers - type: String - displayName: Suppliers - required: false - required: true - required: true - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: false - validation: - warnings: [] - information: - - field: IssueDate - details: 'If the issue date is not supplied, the current date on the server is used.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: - - field: Reference - details: Must be less than 22 characters. - information: [] - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company. - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: false - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: false - validation: - warnings: - - field: Allocation.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: false - validation: - warnings: - - field: Allocation.Currency - details: Must match the Currency of the company - information: [] - required: false - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: false - validation: - warnings: - - field: Payment.TotalAmount - details: Must match the sum of the line items - information: [] - currency: - type: String - displayName: Currency - description: The currency for the payment - required: false - validation: - warnings: - - field: Payment.Currency - details: Must match the Currency of the company - information: [] - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: [] - information: - - field: AccountRef.Id - details: 'Must be Bank, Cash or Asset account' - required: true - required: true - required: true - validation: - warnings: - - field: PaymentAllocations - details: Must have exactly one payment allocation. - information: [] - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - validation: - warnings: - - field: TrackingCategoryRefs.TrackingCategoryRefs - details: Must be a valid Id - information: [] - required: false - validation: - warnings: - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type CLASS can be provided per item. - - field: LineItems.TrackingCategoryRefs - details: Only one tracking category of type DEPARTMENT can be provided per invoice. - - field: LineItems.TrackingCategoryRefs - details: All DEPARTMENT tracking categories must be the same - information: [] - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be an Expense or Income account - information: [] - required: false - validation: - warnings: - - field: LineItems.AccountRef - details: Must be set if ItemRef is not - information: [] - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: true - required: false - validation: - warnings: - - field: LineItems.ItemRef - details: Must be set if AccountRef is not - information: [] - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: false - validation: - warnings: - - field: LineItems.Description - details: Must be less than 4000 characters. - information: [] - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: false - validation: - warnings: - - field: LineItems.TaxAmount - details: Must be specified on all line items or none. If specified will override QBO tax calculations. - information: [] - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - validation: - warnings: [] - information: - - field: TaxRateRef.Id - details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' - required: false - validation: - warnings: - - field: LineItems.TaxRateRef - details: Required for all companies except QuickBooks Online France companies. - information: [] - required: true - required: true - Sage 50 (UK): - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - reference: - type: String - displayName: Reference - description: The user reference for this direct cost. - required: false - issueDate: - type: Number - displayName: Issue Date - description: The date this payment was issued. - required: true - currency: - type: String - displayName: Currency - description: The currency in which the direct cost is issued in. - required: true - validation: - warnings: - - field: currency - details: This must match the target account's default currency. - information: [] - currencyRate: - type: Number - displayName: Currency Rate - description: The currency rate associated with this transaction. - required: true - accountRef: - type: Object - displayName: Bank Account - description: The bank account to pay this direct cost from. - properties: - id: - type: String - displayName: Account Id - description: Nominal code of the bank account. - required: true - validation: - warnings: - - field: accountRef.id - details: Must match the ID of an existing bank account and have a max length of 8 characters. - information: [] - required: true - subTotal: - type: Number - displayName: Sub Total - description: The net amount being paid in this direct cost. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line net amounts - taxAmount: - type: Number - displayName: Tax Amount - description: The tax amount being paid in this direct cost. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line tax amounts - totalAmount: - type: Number - displayName: Total Amount - description: The total amount being paid in this direct cost. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line amounts - lineItems: - type: Array - displayName: Line Items - description: Line items of the direct cost. - properties: - description: - type: String - displayName: description - description: Description of the direct cost line item. - required: false - accountRef: - type: Object - displayName: Nominal Code - description: Target bank account for the direct cost line item. - properties: - id: - type: String - displayName: Id - description: The ID of the Account the line is linked to. - required: true - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: Unit amount for the direct cost line item. - required: true - validation: - warnings: - - field: LineItems.unitAmount - details: Cannot equal 0 and will be set to Net amount if not provided accordingly. - information: [] - quantity: - type: Number - displayName: Quantity - description: Quantity for the direct cost line item. - required: true - validation: - warnings: - - field: LineItems.quantity - details: Must be 1 or -1. - information: [] - subTotal: - type: Number - displayName: Net Amount - description: 'Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.' - required: true - validation: - warnings: - - field: LineItems.subTotal - details: Cannot have both subtotal and tax amount as 0 for line item. - information: [] - taxAmount: - type: Number - displayName: Tax Amount - description: Tax amount for the direct cost line item. - required: false - validation: - warnings: - - field: LineItems.taxAmount - details: Cannot have both tax amount and subtotal as 0 for line item. - information: [] - totalAmount: - type: Number - displayName: Total Amount - description: Total amount for the direct cost line item. - required: false - validation: - warnings: [] - information: - - field: LineItems.totalAmount - details: Will be auto populated using tax amount and net amount. - taxCode: - type: Number - displayName: Tax Code Id - description: The tax code ID associated with this transaction. - required: true - trackingCategoryRefs: - type: Object - displayName: Tracking Category References - description: Tracking categories associated with this transaction. - properties: - id: - type: String - displayName: Id - description: The ID of the tracking category associated with the transaction - required: true - validation: - warnings: - - field: id - details: 'A department is required. If a project reference is provided, the cost code for that project must also be provided.' - information: [] - required: true - required: true - required: true - validation: - warnings: [] - information: - - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' - Sage Intacct: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: true - validation: - warnings: [] - information: - - field: Note - details: Must be used to provide payee's name and contain no more than 80 characters. - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - validation: - warnings: [] - information: - - field: TaxRateRef.Id - details: Must be an existing tax rate in Sage Intacct. - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: false - validation: - warnings: [] - information: - - field: LineItems.Description - details: Must not contain no more than 1000 characters. - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: false - subTotal: - type: Number - displayName: Sub Total Amount - description: 'The amount of the line, inclusive of discounts but exclusive of tax' - required: false - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: false - name: - type: String - displayName: Tracking Category Name - description: The name of the category referenced by the identifier - required: false - required: false - required: true - validation: - warnings: [] - information: - - field: LineItems - details: Must contain at least one line item. - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - paidOnDate: - type: DateTime - displayName: Paid On Date - description: The date the payment was paid - required: true - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: false - validation: - warnings: [] - information: - - field: Payment.TotalAmount - details: 'If provided, must match the sum of the line items.' - required: true - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: false - validation: - warnings: [] - information: - - field: Allocation.TotalAmount - details: 'If provided, must match the sum of the line items.' - required: true - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations - details: Must contain a single allocation. - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: - - field: Currency - details: When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail. - information: [] - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: [] - information: - - field: Reference - details: Must not contain no more than 45 characters. - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The amount of the direct transaction, inclusive of tax' - required: false - validation: - warnings: [] - information: - - field: TotalAmount - details: 'If provided, must match the sum of the line items.' - required: true - Sandbox: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: true - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: true - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - required: true - required: true - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: true - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: true - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - required: true - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: true - name: - type: String - displayName: Name - description: The name of the tax rate referenced by the identifier - required: true - effectiveTaxRate: - type: Number - displayName: Effective Tax Rate - description: 'The total applied tax percentage, including compounding details' - required: true - required: true - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - discountAmount: - type: Number - displayName: Discount Amount - description: 'The value, in the given currency, of any discounts applied' - required: true - discountPercentage: - type: Number - displayName: Discount Percentage - description: The percentage rate of any discount that has been applied - required: true - subTotal: - type: Number - displayName: Sub Total Amount - description: 'The amount of the line, inclusive of discounts but exclusive of tax' - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: true - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: true - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: true - name: - type: String - displayName: Name - description: The name of the item referenced by the identifier - required: true - required: true - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - name: - type: String - displayName: Tracking Category Name - description: The name of the category referenced by the identifier - required: true - required: true - tracking: - type: Object - displayName: Tracking - description: Information this item is being tracked against - properties: - recordRefs: - type: Array - displayName: Record References - description: A collection of records this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - required: true - required: true - invoiceTo: - type: Object - displayName: Invoice To - description: The entity the record should be invoiced to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - dataType: - type: String - displayName: DataType - description: The name of the data type for which the ID is valid. - required: true - required: true - required: true - required: true - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - id: - type: String - displayName: Identifier - description: The identifier for the allocated payment - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the allocated payment - required: true - reference: - type: String - displayName: Reference - description: Reference associated with the allocated payment - required: true - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - required: true - currency: - type: String - displayName: Currency - description: The currency for the payment - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the allocated payment and the currency of the base company - required: true - paidOnDate: - type: DateTime - displayName: Paid On Date - description: The date the payment was paid - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been paid - required: true - required: true - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the allocated payment and the currency of the transaction - required: true - allocatedOnDate: - type: DateTime - displayName: Allocated On Date - description: The date the payment was allocated - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: true - required: true - required: true - subTotal: - type: Number - displayName: Sub Total Amount - description: The total amount of the direct transaction excluding any taxes - required: true - taxAmount: - type: Number - displayName: Tax Amount - description: The total amount of tax on the direct transaction - required: true - totalAmount: - type: Number - displayName: Total Amount - description: 'The amount of the direct transaction, inclusive of tax' - required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item - properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted - required: true - required: true - required: true - Xero: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: true - validation: - warnings: [] - information: - - field: IssueDate - details: Must be provided. - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - validation: - warnings: [] - information: - - field: Reference - details: Must not exceed 255 characters. - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: true - validation: - warnings: [] - information: - - field: Currency - details: Must be provided. - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - taxAmount: - type: Number - displayName: Tax Amount - description: The total amount of tax on the direct transaction - required: true - validation: - warnings: [] - information: - - field: TaxAmount - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The amount of the direct transaction, inclusive of tax' - required: true - validation: - warnings: [] - information: - - field: TotalAmount - details: Must be provided. - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: true - validation: - warnings: - - field: ContactRef.Id - details: Must be a valid GUID. - - field: ContactRef.Id - details: Must match the ID of an existing contact. - information: - - field: ContactRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: ContactRef - details: Must be provided. - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a bank account. - - field: AccountRef.Id - details: Must match the ID of an existing bank account. - information: - - field: AccountRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Payment.AccountRef - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations.Payment - details: Must be provided. - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - totalAmount: - type: Number - displayName: Total Amount - description: The total amount that has been allocated - required: true - validation: - warnings: - - field: Allocation.TotalAmount - details: Must be equal to the sum of line items. - information: - - field: Allocation.TotalAmount - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations.Allocation - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: PaymentAllocations - details: Must be provided. - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - description: - type: String - displayName: Description - description: Friendly name of the goods or services purchased - required: true - validation: - warnings: [] - information: - - field: LineItems.Description - details: Must not be longer than 4000 characters long. - quantity: - type: Number - displayName: Quantity - description: The number of units of goods or services purchased - required: true - validation: - warnings: [] - information: - - field: LineItems.Quantity - details: Must be provided. - unitAmount: - type: Number - displayName: Unit Amount - description: The price of each unit of goods or services - required: true - validation: - warnings: [] - information: - - field: LineItems.UnitAmount - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: false - validation: - warnings: - - field: LineItems.TotalAmount - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' - information: - - field: LineItems.TotalAmount - details: 'When one line is negative, all lines must be negative.' - taxAmount: - type: Number - displayName: Tax Amount - description: The amount of tax for the line - required: true - validation: - warnings: [] - information: - - field: LineItems.TaxAmount - details: Must be provided. - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a valid GUID. - - field: AccountRef.Id - details: Must match the ID of an existing account. - information: - - field: AccountRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: LineItems.AccountRef - details: Must be provided. - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - properties: - id: - type: String - displayName: Identifier - description: 'The identifier for the item, unique per tracking category' - required: true - validation: - warnings: [] - information: - - field: TrackingCategoryRefs.Id - details: Must be provided. - required: false - validation: - warnings: [] - information: - - field: LineItems.TrackingCategoryRefs - details: Tracking categories must not have the same parent tracking category. - - field: LineItems.TrackingCategoryRefs - details: Maximum of 2 Tracking Categories. - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: false - validation: - warnings: - - field: TaxRateRef.Id - details: Must match the ID of an existing tax rate. - information: - - field: TaxRateRef.Id - details: 'If not provided, will be set to the default tax rate for the line''s account.' - required: false - itemRef: - type: Object - displayName: Item Reference - description: 'Reference to the product or service type, or inventory item' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the item - required: false - validation: - warnings: - - field: ItemRef.Id - details: Must be a valid GUID. - - field: ItemRef.Id - details: Must match the ID of an existing item. - information: [] - required: false - required: true - validation: - warnings: [] - information: - - field: LineItems - details: Must be provided. - required: true - validation: - warnings: - - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' - information: [] - Zoho Books: - value: - type: Object - displayName: Direct Cost - description: Direct Cost - properties: - reference: - type: String - displayName: Reference - description: User friendly reference for the direct transaction - required: false - note: - type: String - displayName: Note - description: The note attached to the direct transaction - required: false - issueDate: - type: DateTime - displayName: Issue Date - description: The date the direct transaction was issued - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the direct transaction and the base currency of the company - required: false - contactRef: - type: Object - displayName: Contact Ref - description: 'The contact associated with the direct transaction, if known' - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the record - required: false - required: false - validation: - warnings: [] - information: - - field: ContactRef - details: Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided - lineItems: - type: Array - displayName: Direct Transaction Lines - description: A collection of lines that detail items related to the direct transaction - properties: - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the line, inclusive of discounts and tax' - required: false - validation: - warnings: [] - information: - - field: LineItems.TotalAmount - details: Should be provided when SubTotal is not provided - subTotal: - type: Number - displayName: Sub Total Amount - description: 'The amount of the line, inclusive of discounts but exclusive of tax' - required: false - validation: - warnings: [] - information: - - field: LineItems.SubTotal - details: Should be provided when TotalAmount is not provided - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the line item is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - taxRateRef: - type: Object - displayName: Tax Rate Reference - description: Reference to the tax rate code the line item is linked to - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the tax rate - required: false - required: false - trackingCategoryRefs: - type: Array - displayName: Tracking Category References - description: A collection of categories this item is being tracked against - required: false - required: true - currency: - type: String - displayName: Currency - description: The currency of the direct transaction - required: false - validation: - warnings: [] - information: - - field: Currency - details: Is required when pushing a negative direct cost - paymentAllocations: - type: Array - displayName: Payment Allocations - description: A collection of payments allocated to the direct transaction - properties: - payment: - type: Object - displayName: Payment - description: The payment to be allocated - properties: - currency: - type: String - displayName: Currency - description: The currency for the payment - required: false - validation: - warnings: [] - information: - - field: Payment.Currency - details: Is required when pushing a negative direct cost - accountRef: - type: Object - displayName: Account Reference - description: Reference to the account associated with the allocated payment - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: true - required: true - allocation: - type: Object - displayName: Allocation - description: The allocation information - properties: - currency: - type: String - displayName: Currency - description: The currency of the transaction - required: false - validation: - warnings: [] - information: - - field: Allocation.Currency - details: Is required when pushing a negative direct cost - required: true - required: true - required: true - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: get-create-directCosts-model - 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: TotalAmount - details: Must match the sum of the line amounts. - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: Must match the sum of the link amounts. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: CreditNote - required: false - - value: Other - type: String - displayName: Other - required: false - required: true - required: true - required: true - validation: - warnings: - - field: Lines - details: Only one line may be specified - information: [] - required: true - FreshBooks: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - required: true - required: true - validation: - warnings: - - field: Lines.Links - details: Payment Amount must not exceed Invoice Amount Due or available Customer Credit - - field: Lines.Links - details: Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount - information: [] - required: true - validation: - warnings: - - field: Lines - details: Only one line is supported - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - options: - - value: AED - type: Array - displayName: AED - required: false - - value: AFN - type: Array - displayName: AFN - required: false - - value: ALL - type: Array - displayName: ALL - required: false - - value: AMD - type: Array - displayName: AMD - required: false - - value: ANG - type: Array - displayName: ANG - required: false - - value: AOA - type: Array - displayName: AOA - required: false - - value: ARS - type: Array - displayName: ARS - required: false - - value: AUD - type: Array - displayName: AUD - required: false - - value: AWG - type: Array - displayName: AWG - required: false - - value: AZN - type: Array - displayName: AZN - required: false - - value: BAM - type: Array - displayName: BAM - required: false - - value: BBD - type: Array - displayName: BBD - required: false - - value: BDT - type: Array - displayName: BDT - required: false - - value: BGN - type: Array - displayName: BGN - required: false - - value: BHD - type: Array - displayName: BHD - required: false - - value: BIF - type: Array - displayName: BIF - required: false - - value: BMD - type: Array - displayName: BMD - required: false - - value: BND - type: Array - displayName: BND - required: false - - value: BOB - type: Array - displayName: BOB - required: false - - value: BRL - type: Array - displayName: BRL - required: false - - value: BSD - type: Array - displayName: BSD - required: false - - value: BTN - type: Array - displayName: BTN - required: false - - value: BWP - type: Array - displayName: BWP - required: false - - value: BYR - type: Array - displayName: BYR - required: false - - value: BZD - type: Array - displayName: BZD - required: false - - value: CAD - type: Array - displayName: CAD - required: false - - value: CDF - type: Array - displayName: CDF - required: false - - value: CHF - type: Array - displayName: CHF - required: false - - value: CLP - type: Array - displayName: CLP - required: false - - value: CNY - type: Array - displayName: CNY - required: false - - value: COP - type: Array - displayName: COP - required: false - - value: CRC - type: Array - displayName: CRC - required: false - - value: CUC - type: Array - displayName: CUC - required: false - - value: CUP - type: Array - displayName: CUP - required: false - - value: CVE - type: Array - displayName: CVE - required: false - - value: CZK - type: Array - displayName: CZK - required: false - - value: DJF - type: Array - displayName: DJF - required: false - - value: DKK - type: Array - displayName: DKK - required: false - - value: DOP - type: Array - displayName: DOP - required: false - - value: DZD - type: Array - displayName: DZD - required: false - - value: EGP - type: Array - displayName: EGP - required: false - - value: ERN - type: Array - displayName: ERN - required: false - - value: ETB - type: Array - displayName: ETB - required: false - - value: EUR - type: Array - displayName: EUR - required: false - - value: FJD - type: Array - displayName: FJD - required: false - - value: FKP - type: Array - displayName: FKP - required: false - - value: GBP - type: Array - displayName: GBP - required: false - - value: GEL - type: Array - displayName: GEL - required: false - - value: GGP - type: Array - displayName: GGP - required: false - - value: GHS - type: Array - displayName: GHS - required: false - - value: GIP - type: Array - displayName: GIP - required: false - - value: GMD - type: Array - displayName: GMD - required: false - - value: GNF - type: Array - displayName: GNF - required: false - - value: GTQ - type: Array - displayName: GTQ - required: false - - value: GYD - type: Array - displayName: GYD - required: false - - value: HKD - type: Array - displayName: HKD - required: false - - value: HNL - type: Array - displayName: HNL - required: false - - value: HRK - type: Array - displayName: HRK - required: false - - value: HTG - type: Array - displayName: HTG - required: false - - value: HUF - type: Array - displayName: HUF - required: false - - value: IDR - type: Array - displayName: IDR - required: false - - value: ILS - type: Array - displayName: ILS - required: false - - value: IMP - type: Array - displayName: IMP - required: false - - value: INR - type: Array - displayName: INR - required: false - - value: IQD - type: Array - displayName: IQD - required: false - - value: IRR - type: Array - displayName: IRR - required: false - - value: ISK - type: Array - displayName: ISK - required: false - - value: JEP - type: Array - displayName: JEP - required: false - - value: JMD - type: Array - displayName: JMD - required: false - - value: JOD - type: Array - displayName: JOD - required: false - - value: JPY - type: Array - displayName: JPY - required: false - - value: KES - type: Array - displayName: KES - required: false - - value: KGS - type: Array - displayName: KGS - required: false - - value: KHR - type: Array - displayName: KHR - required: false - - value: KMF - type: Array - displayName: KMF - required: false - - value: KPW - type: Array - displayName: KPW - required: false - - value: KRW - type: Array - displayName: KRW - required: false - - value: KWD - type: Array - displayName: KWD - required: false - - value: KYD - type: Array - displayName: KYD - required: false - - value: KZT - type: Array - displayName: KZT - required: false - - value: LAK - type: Array - displayName: LAK - required: false - - value: LBP - type: Array - displayName: LBP - required: false - - value: LKR - type: Array - displayName: LKR - required: false - - value: LRD - type: Array - displayName: LRD - required: false - - value: LSL - type: Array - displayName: LSL - required: false - - value: LYD - type: Array - displayName: LYD - required: false - - value: MAD - type: Array - displayName: MAD - required: false - - value: MDL - type: Array - displayName: MDL - required: false - - value: MGA - type: Array - displayName: MGA - required: false - - value: MKD - type: Array - displayName: MKD - required: false - - value: MMK - type: Array - displayName: MMK - required: false - - value: MNT - type: Array - displayName: MNT - required: false - - value: MOP - type: Array - displayName: MOP - required: false - - value: MRO - type: Array - displayName: MRO - required: false - - value: MUR - type: Array - displayName: MUR - required: false - - value: MVR - type: Array - displayName: MVR - required: false - - value: MWK - type: Array - displayName: MWK - required: false - - value: MXN - type: Array - displayName: MXN - required: false - - value: MYR - type: Array - displayName: MYR - required: false - - value: MZN - type: Array - displayName: MZN - required: false - - value: NAD - type: Array - displayName: NAD - required: false - - value: NGN - type: Array - displayName: NGN - required: false - - value: NIO - type: Array - displayName: NIO - required: false - - value: NOK - type: Array - displayName: NOK - required: false - - value: NPR - type: Array - displayName: NPR - required: false - - value: NZD - type: Array - displayName: NZD - required: false - - value: OMR - type: Array - displayName: OMR - required: false - - value: PAB - type: Array - displayName: PAB - required: false - - value: PEN - type: Array - displayName: PEN - required: false - - value: PGK - type: Array - displayName: PGK - required: false - - value: PHP - type: Array - displayName: PHP - required: false - - value: PKR - type: Array - displayName: PKR - required: false - - value: PLN - type: Array - displayName: PLN - required: false - - value: PYG - type: Array - displayName: PYG - required: false - - value: QAR - type: Array - displayName: QAR - required: false - - value: RON - type: Array - displayName: RON - required: false - - value: RSD - type: Array - displayName: RSD - required: false - - value: RUB - type: Array - displayName: RUB - required: false - - value: RWF - type: Array - displayName: RWF - required: false - - value: SAR - type: Array - displayName: SAR - required: false - - value: SBD - type: Array - displayName: SBD - required: false - - value: SCR - type: Array - displayName: SCR - required: false - - value: SDG - type: Array - displayName: SDG - required: false - - value: SEK - type: Array - displayName: SEK - required: false - - value: SGD - type: Array - displayName: SGD - required: false - - value: SHP - type: Array - displayName: SHP - required: false - - value: SLL - type: Array - displayName: SLL - required: false - - value: SOS - type: Array - displayName: SOS - required: false - - value: SPL - type: Array - displayName: SPL - required: false - - value: SRD - type: Array - displayName: SRD - required: false - - value: STD - type: Array - displayName: STD - required: false - - value: SVC - type: Array - displayName: SVC - required: false - - value: SYP - type: Array - displayName: SYP - required: false - - value: SZL - type: Array - displayName: SZL - required: false - - value: THB - type: Array - displayName: THB - required: false - - value: TJS - type: Array - displayName: TJS - required: false - - value: TMT - type: Array - displayName: TMT - required: false - - value: TND - type: Array - displayName: TND - required: false - - value: TOP - type: Array - displayName: TOP - required: false - - value: TRY - type: Array - displayName: TRY - required: false - - value: TTD - type: Array - displayName: TTD - required: false - - value: TVD - type: Array - displayName: TVD - required: false - - value: TWD - type: Array - displayName: TWD - required: false - - value: TZS - type: Array - displayName: TZS - required: false - - value: UAH - type: Array - displayName: UAH - required: false - - value: UGX - type: Array - displayName: UGX - required: false - - value: USD - type: Array - displayName: USD - required: false - - value: UYU - type: Array - displayName: UYU - required: false - - value: UZS - type: Array - displayName: UZS - required: false - - value: VEF - type: Array - displayName: VEF - required: false - - value: VND - type: Array - displayName: VND - required: false - - value: VUV - type: Array - displayName: VUV - required: false - - value: WST - type: Array - displayName: WST - required: false - - value: XAF - type: Array - displayName: XAF - required: false - - value: XCD - type: Array - displayName: XCD - required: false - - value: XDR - type: Array - displayName: XDR - required: false - - value: XOF - type: Array - displayName: XOF - required: false - - value: XPF - type: Array - displayName: XPF - required: false - - value: YER - type: Array - displayName: YER - required: false - - value: ZAR - type: Array - displayName: ZAR - required: false - - value: ZMW - type: Array - displayName: ZMW - required: false - - value: ZWD - type: Array - displayName: ZWD - required: false - required: false - validation: - warnings: - - field: Currency - details: Can be used for Payments on Account only - information: [] - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - required: true - MYOB AccountRight and Essentials: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must be a valid GUID. - - field: CustomerRef.Id - details: Must match the ID of an existing customer. - information: - - field: CustomerRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: Must be provided. - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a valid GUID. - - field: AccountRef.Id - details: Must match the ID of an existing account. - information: - - field: AccountRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: AccountRef - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Precision must be maximum of two decimal places. - - field: TotalAmount - details: Must be greater than zero. - information: - - field: TotalAmount - details: Must be provided and must equal the sum of the link items amount. - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must be provided. - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: [] - information: - - field: Reference - details: Must not be greater than 8 characters long. - currency: - type: String - displayName: Currency - description: Currency of the payment - options: - - value: AUD - type: String - displayName: Australian Dollar - required: false - required: true - validation: - warnings: [] - information: - - field: Currency - details: Must be provided. - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: Must be provided. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: [] - information: - - field: Links.Id - details: Must be provided. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: [] - information: - - field: Links.Amount - details: Precision must be maximum of two decimal places. - - field: Links.Amount - details: Must be provided. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - required: false - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines - details: Must be provided. - required: true - Oracle NetSuite: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense') - information: [] - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Must be greater than zero - - field: TotalAmount - details: Must be provided and must be equal to the sum of the lines amounts - information: [] - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: - - field: Currency - details: If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency - information: [] - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: - - field: Reference - details: The id format should be 'location-' - information: - - field: Reference - details: This field can be used to provide a tracking category id (Location only) - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: - - field: Links.Id - details: If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted' - information: [] - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: true - required: true - QuickBooks Desktop: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must match the ID of an existing supplier. - information: [] - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must match the ID of an existing 'Bank' or 'Other Current Asset' account. - information: - - field: AccountRef.Id - details: Not required if total amount of the payment is 0. - required: true - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: - - field: Reference - details: Max length of 20 characters. - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: - - field: Currency - details: Must be a three letter ISO code that matches the currency of the customer. - - field: Currency - details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. - information: - - field: Currency - details: 'If not set, will default to the default currency of the customer.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - validation: - warnings: [] - information: - - field: CurrencyRate - details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' - - field: CurrencyRate - details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Must match the sum of amounts in the lines - information: [] - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: - - field: Lines.Amount - details: Amount plus the sum of amounts in the links must equal 0 - information: [] - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - validation: - warnings: - - field: Links.Type - details: 'Only 1 link with type ''PaymentOnAccount'' may be specified per line, this line may contain no other links' - - field: Links.Type - details: Only 1 link with type 'Invoice' may be specified per line - information: [] - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: true - required: true - QuickBooks Online Sandbox: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: false - validation: - warnings: [] - information: - - field: AccountRef - details: Must match the ID of an existing Account. - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - required: true - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: false - required: true - QuickBooks Online: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - required: false - validation: - warnings: [] - information: - - field: AccountRef - details: Must match the ID of an existing Account. - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - required: true - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: [] - information: - - field: Currency - details: Required if multi-currency is enabled for the company - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - required: true - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - required: true - required: false - required: true - Sage 50 (UK): - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - accountRef: - type: Object - displayName: Bank Account - description: The bank account to pay this invoice from. - properties: - id: - type: String - displayName: Account Id - description: Nominal code of the bank account. - required: true - validation: - warnings: - - field: accountRef.id - details: Must match the ID of an existing bank account and have a max length of 8 characters. - information: [] - required: true - customerRef: - type: Object - displayName: Customer - description: Customer to be paid. - properties: - id: - type: String - displayName: Customer Id - description: Identifier of the customer. - required: true - validation: - warnings: - - field: customerRef.id - details: Must match the ID of an existing customer and have a max length of 8 characters. - information: [] - required: true - totalAmount: - type: Number - displayName: Total Amount - description: The total amount being paid to the customer. - required: true - validation: - warnings: [] - information: - - details: This must equal the sum of the line amounts - reference: - type: Number - displayName: Reference - description: The user reference for this invoice payment. - required: false - date: - type: Number - displayName: Issue Date - description: The date this payment was issued. - required: true - note: - type: Number - displayName: Note - description: A description of the payment. - required: false - lines: - type: Array - displayName: Line Items - description: Line items of the payment. - properties: - amount: - type: Number - displayName: Amount - description: The amount of this line item - required: true - validation: - warnings: [] - information: - - details: this must equal the negative of the sum of the link amounts - links: - type: Array - displayName: Links - description: Links to the invoice being paid. - properties: - amount: - type: Number - displayName: Amount - description: The amount to be added to the value of the invoice - required: true - validation: - warnings: [] - information: - - details: 'When paying off an invoice, this value will be negative' - id: - type: String - displayName: Invoice Id - description: The ID of the invoice to pay - required: true - type: - type: String - displayName: Payment Link Type - description: The type of the item to be paid - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: PaymentOnAccount - type: String - displayName: Payment On Account - required: false - - value: Refund - type: String - displayName: Refund - required: false - - value: CreditNote - type: String - displayName: Credit Note - required: false - - value: Payment - type: String - displayName: Payment - required: false - required: true - required: true - required: true - validation: - warnings: [] - information: - - details: Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response. - required: true - validation: - warnings: [] - information: - - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' - Sage Business Cloud Accounting: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must match the ID of an existing Account. - information: - - field: AccountRef.Id - details: Must be provided. - required: false - validation: - warnings: - - field: AccountRef - details: Required unless the Payment is only allocating a Credit Note. - information: [] - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must match the ID of an existing Customer. - information: - - field: CustomerRef.Id - details: Must be provided. - required: true - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: Must be zero when allocating against Invoices using a Credit Note only. - - field: TotalAmount - details: Must equal the sum of the link items amount. - information: - - field: TotalAmount - details: Must be provided. - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - validation: - warnings: - - field: Note - details: Should not be longer than 25 characters. - information: [] - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - validation: - warnings: [] - information: - - field: Currency - details: 'If supplied, must match the currency of the customer.' - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: [] - information: - - field: Links.Id - details: Must be provided. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: - - field: Links.Amount - details: Must be greater than zero except when Type is Invoice - information: - - field: Links.Amount - details: Must be provided. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: PaymentOnAccount - type: String - displayName: PaymentOnAccount - required: false - - value: Refund - type: String - displayName: Refund - required: false - - value: CreditNote - type: String - displayName: CreditNote - required: false - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: Must be provided. - required: true - required: true - Sage Intacct: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: [] - information: - - field: TotalAmount - details: Must equal the sum of Lines.Amount. - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - validation: - warnings: [] - information: - - field: Note - details: Must be less than 1000 characters. - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - options: - - value: '1' - type: String - displayName: Printed Check - required: false - - value: '3' - type: String - displayName: Credit Card - required: false - - value: '5' - type: String - displayName: EFT - required: false - - value: '6' - type: String - displayName: Cash - required: false - required: true - required: true - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - validation: - warnings: [] - information: - - field: Reference - details: Can be used to set the Document/Check No. in Sage Intacct. - currency: - type: String - displayName: Currency - description: Currency of the payment - required: false - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - validation: - warnings: [] - information: - - field: CurrencyRate - details: Is required if currency is provided. - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must occur after the date the invoice was created. - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: [] - information: - - field: CustomerRef.Id - details: Must be an existing customer ID in Sage Intacct. - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: [] - information: - - field: AccountRef.Id - details: For undeposited payments use the GL account record number to charge. - - field: AccountRef.Id - details: 'To charge either a savings, checking or credit card account use its associated GL account number.' - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: When added together with the sum of the Links.Amount the total must be zero. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: [] - information: - - field: Links.Id - details: 'Must be a valid Record No. from accounts receivable of either an invoice for an ''Invoice'', adjustment for a ''CreditNote'' or an advance for a ''PaymentOnAccount'' in Sage Intacct.' - - field: Links.Id - details: Must be an integer. - - field: Links.Id - details: Must related to CustomerRef.Id in Sage Intacct. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be one of Invoiceor CreditNoteor PaymentOnAccount. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: [] - information: - - field: Links.Amount - details: Must not be more than the total amount due for an invoice or the available funds in the account to be charged. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount. - - field: Lines.Links - details: Must contain only one Invoice. - required: true - validation: - warnings: [] - information: - - field: Lines - details: Must contain at least one payment line. - required: true - validation: - warnings: [] - information: - - details: Sage Intacct handles allocated payments only. - Sandbox: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - companyName: - type: String - displayName: Name - description: The name of the customer referenced by the identifier - required: true - required: true - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - required: true - paymentMethodRef: - type: Object - displayName: Payment Method Reference - description: Reference to the method of this payment - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the payment method - required: true - name: - type: String - displayName: Name - description: The name of the payment method referenced by the identifier - required: true - required: true - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: true - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: true - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - required: true - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the currency of the linked transaction - required: true - required: true - allocatedOnDate: - type: DateTime - displayName: Allocated On Date - description: The date the payment was allocated - required: true - required: true - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item - properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted - required: true - required: true - required: true - Xero: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - validation: - warnings: - - field: CustomerRef.Id - details: Must be a valid GUID. - - field: CustomerRef.Id - details: Must match the ID of an existing account. - information: - - field: CustomerRef.Id - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: CustomerRef - details: Must be provided. - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: Must be a valid GUID. - - field: AccountRef.Id - details: Must match the ID of an existing account. - information: - - field: AccountRef.Id - details: Must be either a type of BANK account or enable payments must be switched on. - required: true - validation: - warnings: [] - information: - - field: AccountRef - details: Must be provided. - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: 'Must be greater than 0, unless the payment is a credit note allocation.' - information: - - field: TotalAmount - details: Must be provided and must equal the sum of the link items amount. - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - validation: - warnings: [] - information: - - field: Date - details: Must be provided. - reference: - type: String - displayName: Reference - description: A user friendly reference for the payment - required: false - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: false - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - validation: - warnings: [] - information: - - field: Currency - details: Must be provided. - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - amount: - type: Number - displayName: Amount - description: The total amount for the line in the payment currency - required: true - validation: - warnings: [] - information: - - field: Lines.Amount - details: Must be provided. - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - validation: - warnings: - - field: Links.Id - details: Must be a valid GUID. - information: - - field: Links.Id - details: Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice. - - field: Links.Id - details: Must be provided. - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: [] - information: - - field: Links.Amount - details: Must be provided. - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - value: Invoice - type: String - displayName: Invoice - required: false - - value: CreditNote - type: String - displayName: CreditNote - required: false - - value: Payment - type: String - displayName: Payment - required: false - required: true - validation: - warnings: [] - information: - - field: Links.Type - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines.Links - details: Must be provided. - required: true - validation: - warnings: [] - information: - - field: Lines - details: Must be provided. - required: true - Zoho Books: - value: - type: Object - displayName: Payment - description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) - properties: - accountRef: - type: Object - displayName: Nominal Account Reference - description: Reference to the nominal account the payment is linked to - properties: - id: - type: String - displayName: Account ID - description: The identifier for the account - required: true - validation: - warnings: - - field: AccountRef.Id - details: AccountRef.ID is required when making a payment to an invoice and/or a payment on account - information: [] - required: true - customerRef: - type: Object - displayName: Customer Reference - description: Reference to the customer the payment has been sent by - properties: - id: - type: String - displayName: Identifier - description: The reference identifier for the customer - required: true - required: true - currency: - type: String - displayName: Currency - description: Currency of the payment - required: true - validation: - warnings: - - field: Currency - details: must match the currency of any invoices or credit notes - information: [] - date: - type: DateTime - displayName: Date - description: The date the payment was recorded - required: true - currencyRate: - type: Number - displayName: Currency Exchange Rate - description: The exchange rate between the currency of the payment and the base currency of the company - required: true - note: - type: String - displayName: Note - description: Any additional text based information associated with the payment - required: false - totalAmount: - type: Number - displayName: Total Amount - description: 'The total amount of the payment, inclusive of discounts and tax' - required: true - validation: - warnings: - - field: TotalAmount - details: must be greater than or equal to 0 - information: [] - lines: - type: Array - displayName: Lines - description: A collection of payment lines - properties: - links: - type: Array - displayName: Links - description: A collection of linked transactions - properties: - amount: - type: Number - displayName: Amount - description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' - required: true - validation: - warnings: - - field: Links.Amount - details: the sum of all link amounts must equal the negated total amount of the payment - information: [] - id: - type: String - displayName: Identifier - description: The identifier for the referenced transaction - required: true - type: - type: String - displayName: Link Type - description: The type of transaction that is being linked - options: - - type: Array - displayName: Invoice - required: false - - type: Array - displayName: CreditNote - required: false - - type: Array - displayName: PaymentOnAccount - required: false - required: true - required: true - validation: - warnings: - - field: Lines.Links - details: 'if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed' - information: [] - required: true - required: true - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: get-create-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 push operations - tags: - - Push data - operationId: get-company-push-history - x-speakeasy-name-override: list-operations - description: |- - The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - 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}/push/{pushOperationKey}': - parameters: - - $ref: '#/components/parameters/companyId' - - schema: - type: string - format: uuid - name: pushOperationKey - in: path - required: true - description: Push operation key. - get: - summary: Get push operation - tags: - - Push data - operationId: get-push-operation - x-speakeasy-name-override: get-operation - description: |- - The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - 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' - '/integrations/{platformKey}/dataTypes/{dataType}/supplementalDataConfig': - parameters: - - $ref: '#/components/parameters/platformKey' - - name: dataType - in: path - required: true - description: Supported supplemental data data type. - schema: - x-internal: true - type: string - description: Data types that support supplemental data - enum: - - chartOfAccounts - - bills - - company - - creditNotes - - customers - - invoices - - items - - journalEntries - - suppliers - - taxRates - - commerce-companyInfo - - commerce-customers - - commerce-disputes - - commerce-locations - - commerce-orders - - commerce-payments - - commerce-paymentMethods - - commerce-products - - commerce-productCategories - - commerce-taxComponents - - commerce-transactions - example: invoices - put: - summary: Configure - description: |- - The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination. - - [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types. - - **Integration-specific behaviour** - See the *examples* for integration-specific frequently requested properties. - operationId: configure-supplemental-data - x-speakeasy-name-override: configure - tags: - - Supplemental data - responses: - '200': - description: OK - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SupplementalDataConfiguration' - examples: - Xero - Accounts: - value: - yourKeyNameForAccounts: - dataSource: /Accounts - pullData: - yourNameForTaxType: TaxType - yourNameForSystemAccount: SystemAccount - Xero - Invoices: - value: - yourKeyNameForInvoices: - dataSource: /Invoices - pullData: - yourNameForExpectedPaymentDate: ExpectedPaymentDate - yourNameForHasAttachments: HasAttachments - Xero - Items: - value: - yourKeyNameForItems: - dataSource: /Items - pullData: - yourNameForQuantityOnHand: QuantityOnHand - yourNameForTotalCostPool: TotalCostPool - Xero - Contacts: - value: - yourKeyNameForContacts: - dataSource: /Contacts - pullData: - yourNameForBankAccounts: BankAccountDetails - Xero - Tax rates: - value: - yourKeyNameForTaxRates: - dataSource: /TaxRates - pullData: - yourNameForCanApplyToLiabilities: CanApplyToLiabilities - yourNameForCanApplyToAssets: CanApplyToAssets - yourNameForCanApplyToEquity: CanApplyToEquity - yourNameForCanApplyToExpenses: CanApplyToExpenses - yourNameForCanApplyToRevenue: CanApplyToRevenue - QBO - Customers: - value: - yourKeyNameForCustomers: - dataSource: /Customer - pullData: - yourNameForSalesTermRef: SalesTermRef.value - yourNameForParentRef: ParentRef.value - QBO - Invoices: - value: - yourKeyNameForInvoices: - dataSource: /Invoice - pullData: - yourNameForSalesTermRef: SalesTermRef.value - description: The configuration for the specified platform and data type. - get: - summary: Get configuration - description: |- - The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination. - - [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types. - operationId: get-supplemental-data-configuration - x-speakeasy-name-override: get-configuration - tags: - - Supplemental data - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SupplementalDataConfiguration' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}': - parameters: - - $ref: '#/components/parameters/platformKey' - - $ref: '#/components/parameters/customDataIdentifier' - put: - summary: Configure custom data type - description: "The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration. \n\nA [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.\n\n### Tips and traps\n\n- You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms. \n\n- You can only indicate a single data source for each customer data type. \n\n- Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way." - operationId: configure-custom-data-type - x-speakeasy-name-override: configure - tags: - - Custom data type - requestBody: - description: Custom data type configuration for the specified platform. - content: - application/json: - schema: - $ref: '#/components/schemas/CustomDataTypeConfiguration' - examples: - Dynamics 365 Business Central: - value: - dataSource: api/purchaseOrders - requiredData: - currency: '$[*].currencyCode' - number: '$[*].number' - date: '$[*].orderDate' - totalexvat: '$[*].totalAmountExcludingTax' - totaltax: '$[*].totalTaxAmount' - vendor: '$[*].number' - keyBy: - - '$[*].id' - sourceModifiedDate: - - '$[*].lastModifiedDateTime' - Xero Simple Record: - value: - dataSource: /api.xro/2.0/Accounts - requiredData: - code: $.Code - accountId: $.AccountID - type: $.Type - SysAcc: $.SystemAccount - keyBy: - - $.AccountID - Xero Mapping Arrays: - value: - dataSource: /api.xro/2.0/Invoices - requiredData: - invNumber: $.InvoiceNumber - type: $.Type - InvoiceID: $.InvoiceID - lines: '$.LineItems[*]' - keyBy: - - $.InvoiceID - sourceModifiedDate: - - $.UpdatedDateUTC - QuickBooks Online: - value: - dataSource: /query?query=select * from Account - requiredData: - id: $.Id - Currentbal: $.CurrentBalance - SubAcc: $.SubAccount - keyBy: - - $.Id - sourceModifiedDate: - - $.time - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CustomDataTypeConfiguration' - examples: - Dynamics 365 Business Central: - value: - dataSource: api/purchaseOrders - requiredData: - currency: '$[*].currencyCode' - number: '$[*].number' - date: '$[*].orderDate' - totalexvat: '$[*].totalAmountExcludingTax' - totaltax: '$[*].totalTaxAmount' - vendor: '$[*].number' - keyBy: - - '$[*].id' - sourceModifiedDate: - - '$[*].lastModifiedDateTime' - Xero Simple Record: - value: - dataSource: /api.xro/2.0/Accounts - requiredData: - code: $.Code - accountId: $.AccountID - type: $.Type - SysAcc: $.SystemAccount - keyBy: - - $.AccountID - Xero Mapping Arrays: - value: - dataSource: /api.xro/2.0/Invoices - requiredData: - invNumber: $.InvoiceNumber - type: $.Type - InvoiceID: $.InvoiceID - lines: '$.LineItems[*]' - keyBy: - - $.InvoiceID - sourceModifiedDate: - - $.UpdatedDateUTC - QuickBooks Online: - value: - dataSource: /query?query=select * from Account - requiredData: - id: $.Id - Currentbal: $.CurrentBalance - SubAcc: $.SubAccount - keyBy: - - $.Id - sourceModifiedDate: - - $.time - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - get: - summary: Get custom data configuration - description: |- - The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured. - - A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model. - operationId: get-custom-data-type-configuration - x-speakeasy-name-override: get-configuration - tags: - - Custom data type - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CustomDataTypeRecords' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/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}/data/queue/custom/{customDataIdentifier}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/customDataIdentifier' - post: - summary: Refresh custom data type - description: The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view. - operationId: refresh-custom-data-type - x-speakeasy-name-override: refresh - tags: - - Custom data type - responses: - '200': - description: OK - '/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' - '451': - $ref: '#/components/responses/Legal-Reasons' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/customDataIdentifier' - get: - summary: List custom data type records - description: |- - The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured. - - A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type) - operationId: list-custom-data-type-records - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - tags: - - Custom data type - '/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/CustomDataTypeRecords' - '400': - $ref: '#/components/responses/Bad-Request' - $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' - - 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' - '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/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' - '451': - $ref: '#/components/responses/Legal-Reasons' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' -webhooks: - company.created: - post: - description: Called when a company is created in Codat. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyWebhook' - examples: - Company created: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: company.created - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Bank of Dave - description: Requested a loan for refurb. - redirect: 'https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2' - lastSync: '2022-01-01T12:00:00.000Z' - created: '2022-01-01T12:00:00.000Z' - tags: - customerRegion: us - uid: 335a086e-8563-4b03-94e3-39544225ecb6 - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - company.deleted: - post: - description: Called when a company is deleted in Codat. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyWebhook' - examples: - Company deleted: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: company.deleted - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Bank of Dave - description: Requested a loan for refurb. - redirect: 'https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2' - lastSync: '2022-01-01T12:00:00.000Z' - created: '2022-01-01T12:00:00.000Z' - tags: - customerRegion: uk - uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.created: - post: - description: Called when a connection is created by the SMB. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Connection created: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.created - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: PendingAuth - lastSync: 2022-10-27T10:22:43.646Z - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.connected: - post: - description: Called when a connection is successfully linked by the SMB. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Connection connected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.connected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: 2022-10-27T10:22:43.646Z - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.failed: - post: - description: Called when a connection failed linking to the SMB. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Connection failed: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.failed - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: PendingAuth - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - dataConnectionErrors: - - statusCode: '403' - statusText: User cancelled linking - errorMessage: User cancelled - erroredOnUtc: 2022-10-27T09:53:29.000Z - status: Active - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.disconnected: - post: - description: Called when a connection is disconnected either due to being unlinked or de-authorized by the SMB or integration. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Unlinked: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.disconnected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Unlinked - lastSync: 2022-10-27T10:22:43.646Z - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - De-authorized: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.disconnected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Deauthorized - lastSync: 2022-10-27T10:22:43.646Z - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - dataConnectionErrors: - - statusCode: '401' - statusText: The integration de-authorized access to the connection. - errorMessage: The integration de-authorized access to the connection. - erroredOnUtc: 2022-12-27T09:53:29.000Z - status: Active - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.reconnected: - post: - description: Called when a connection is reconnected after becoming disconnected. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Reconnected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.reconnected - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: 2022-10-27T10:22:43.646Z - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - connection.deleted: - post: - description: Called when a connection is deleted. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionWebhook' - examples: - Deleted: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: connection.deleted - generatedDate: '2024-08-08T17:10:34.015Z' - payload: - 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 - connection: - 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/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: 2022-10-27T10:22:43.646Z - created: 2022-10-27T09:53:29.000Z - sourceType: Banking - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - read.completed: - post: - description: Called when the fetch of data types for a product has completed. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ReadCompletedWebhook' - examples: - Read completed with validation warnings: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed - 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' - modifiedFromDate: 2022-10-23T00:00:00.000Z - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: - - type: warning.validation - message: Something doesn't look right about these invoices. You can see more information in the logs. - links: - logs: 'https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/743ec94a-8aa4-44bb-8bd4-e1855ee0e74b/validation' - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history' - readMore: 'https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation' - Read completed without issues: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed - 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' - modifiedFromDate: 2022-10-23T00:00:00.000Z - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: [] - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - read.completed.initial: - post: - description: Called when the initial fetch of data types for a product has been completed. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ReadCompletedWebhook' - examples: - Initial with validation warnings: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed.initial - 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' - modifiedFromDate: 2022-10-23T00:00:00.000Z - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: - - type: warning.validation - message: Something doesn't look right about these invoices. You can see more information in the logs. - links: - logs: 'https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/743ec94a-8aa4-44bb-8bd4-e1855ee0e74b/validation' - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history' - readMore: 'https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation' - Initial without issues: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: read.completed.initial - 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' - modifiedFromDate: 2022-10-23T00:00:00.000Z - dataTypes: - - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - dataType: invoices - recordsModified: false - status: Complete - issues: [] - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - '{dataType}.write.successful': - post: - description: "Indicates that a `dataType` has been successfully created, updated, deleted, or had an attachment uploaded in the accounting software.\n\nCodat now refers to push operations as write requests.\n\nFor example, to subscribe to events where a bill is written into the accounting software, use the `bills.write.successful` webhook.\n\n### Supported data types and write types\n\n| `dataType` | Create | Update | Delete | UploadAttachment |\n|------------------|---------|---------|---------|------------------|\n| bankAccounts | ✅ | ✅ | - | - | \n| bankTransactions | ✅ | - | - | - |\n| billCreditNotes | ✅ | ✅ | - | ✅ | \n| billPayments | ✅ | - | ✅ | - | \n| bills | ✅ | ✅ | ✅ | ✅ | \n| chartOfAccounts | ✅ | - | - | - | \n| creditNotes | ✅ | ✅ | - | - | \n| customers | ✅ | ✅ | - | - | \n| directCosts | ✅ | - | ✅ | ✅ | \n| directIncomes | ✅ | - | - | ✅ | \n| invoices | ✅ | ✅ | ✅ | ✅ | \n| items | ✅ | - | - | - | \n| journalEntries | ✅ | - | ✅ | - | \n| journals | ✅ | - | - | - | \n| payments | ✅ | - | - | - | \n| purchaseOrders | ✅ | ✅ | - | - | \n| suppliers | ✅ | ✅ | - | - | \n| transfers | ✅ | - | - | ✅ | \n" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataTypeWriteWebhook' - examples: - Record: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.successful' - generatedDate: 2023-05-03T10:00:23.000Z - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: Create - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: 2023-05-03T10:00:00.000Z - completedOnDate: 2023-05-03T10:00:23.000Z - status: Success - record: - id: bil_1Nispe2eZvKYlo2Cd31jOCgZ - Attachment: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.successful' - generatedDate: 2023-05-03T10:00:23.000Z - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: UploadAttachment - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: 2023-05-03T10:00:00.000Z - completedOnDate: 2023-05-03T10:00:23.000Z - status: Success - record: - id: bil_1Nispe2eZvKYlo2Cd31jOCgZ - attachmentId: att_1AZtxr2eZvKYlo2CJDX8whov - responses: - '200': - description: Return a 200 status to indicate that the webhook was received. - '{dataType}.write.unsuccessful': - post: - description: "Indicates that a `dataType` has not been successfully created, updated, deleted, or had an attachment uploaded in the accounting software.\n\nCodat now refers to push operations as write requests.\n\nFor example, to subscribe to events where a bill is written into the accounting software, use the `bills.write.unsuccessful` webhook.\n\n### Supported data types and write types\n\n| `dataType` | Create | Update | Delete | UploadAttachment |\n|------------------|---------|---------|---------|------------------|\n| bankAccounts | ✅ | ✅ | - | - | \n| bankTransactions | ✅ | - | - | - |\n| billCreditNotes | ✅ | ✅ | - | ✅ | \n| billPayments | ✅ | - | ✅ | - | \n| bills | ✅ | ✅ | ✅ | ✅ | \n| chartOfAccounts | ✅ | - | - | - | \n| creditNotes | ✅ | ✅ | - | - | \n| customers | ✅ | ✅ | - | - | \n| directCosts | ✅ | - | ✅ | ✅ | \n| directIncomes | ✅ | - | - | ✅ | \n| invoices | ✅ | ✅ | ✅ | ✅ | \n| items | ✅ | - | - | - | \n| journalEntries | ✅ | - | ✅ | - | \n| journals | ✅ | - | - | - | \n| payments | ✅ | - | - | - | \n| purchaseOrders | ✅ | ✅ | - | - | \n| suppliers | ✅ | ✅ | - | - | \n| transfers | ✅ | - | - | ✅ | \n" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataTypeWriteWebhook' - examples: - Record: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.unsuccessful' - generatedDate: 2023-05-03T10:00:23.000Z - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: Update - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: 2023-05-03T10:00:00.000Z - completedOnDate: 2023-05-03T10:00:23.000Z - status: Failed - Record timed out: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.unsuccessful' - generatedDate: 2023-05-03T10:00:23.000Z - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: Delete - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: 2023-05-03T10:00:00.000Z - completedOnDate: 2023-05-03T10:00:23.000Z - status: TimedOut - Attachment: - value: - id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 - eventType: '{dataType}.write.unsuccessful' - generatedDate: 2023-05-03T10:00:23.000Z - payload: - id: a9367074-b5c3-42c4-9be4-be129f43577e - type: UploadAttachment - referenceCompany: - id: 70af3071-65d9-4ec3-b3cb-5283e8d55dac - name: Toft stores - description: cust_1MtJUT2eZvKYlo2CNaw2HvEv - connectionId: 12571faf-0898-47e7-afdd-0fe9eb0a9bf5 - requestedOnDate: 2023-05-03T10:00:00.000Z - completedOnDate: 2023-05-03T10:00:23.000Z - status: TimedOut - record: - id: bil_1Nispe2eZvKYlo2Cd31jOCgZ - responses: - '200': - description: Return a 200 status to indicate that the webhook was received. - 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. -components: - schemas: - ApiKeyDetails: - title: API key details - description: Details of the API key. - 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: Unique identifier for the API key. - example: e288a972-b402-4b21-93f9-b5335ae5679c - name: - type: string - maxLength: 50 - nullable: true - description: A meaningful name assigned to the API key. - example: azure-invoice-finance-processor - apiKey: - type: string - description: The API key value used to make authenticated http requests. - example: ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd - - nullable: true - description: Datetime in UTC the API key was created. The created date will be null if the API key created before YYYY-MM-DD. - title: Created date - type: object - x-internal: true - properties: - createdDate: - $ref: '#/components/schemas/DateTime' - description: The date the entity was created. - ApiKeys: - title: API keys - x-internal: true - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/ApiKeyDetails' - Branding: - title: Branding - type: object - properties: - logo: - $ref: '#/components/schemas/Branding/definitions/brandingLogo' - button: - $ref: '#/components/schemas/Branding/definitions/brandingButton' - 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`.' - definitions: - brandingLogo: - description: Logo branding references. - type: object - properties: - full: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - square: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - brandingButton: - type: object - description: Button branding references. - properties: - default: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - hover: - $ref: '#/components/schemas/Branding/definitions/brandingImage' - brandingImage: - title: Branding Image - type: object - properties: - image: - $ref: '#/components/schemas/Branding/definitions/imageReference' - examples: [] - imageReference: - type: object - title: Image Reference - description: Image reference. - properties: - src: - type: string - format: uri - description: Source URL for image. - alt: - type: string - description: Alternative text when image is not available. - examples: - - logo: - full: - image: - src: 'https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png' - alt: xero full icon - square: - image: - src: 'https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png' - alt: xero square icon - button: - default: - image: - src: 'https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png' - alt: xero default button icon - hover: - image: - src: 'https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png' - alt: xero hover button icon - sourceId: 35b92968-9851-4095-ad60-395c95cbcba4 - ClientId: - title: Client ID - type: string - format: uuid - description: Unique identifier for your client in Codat. - 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 - 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: |- - > **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.\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: - - - `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\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 + 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/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: |- - ## 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 - 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: + $ref: '#/components/schemas/DataStatus' + nullable: true + journalEntries: + $ref: '#/components/schemas/DataStatus' + nullable: true + journals: + $ref: '#/components/schemas/DataStatus' + nullable: true + paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + profitAndLoss: + $ref: '#/components/schemas/DataStatus' + nullable: true + purchaseOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + salesOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + suppliers: + $ref: '#/components/schemas/DataStatus' + nullable: true + taxRates: + $ref: '#/components/schemas/DataStatus' + nullable: true + trackingCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + transfers: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accountBalances: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactionCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-companyInfo: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-disputes: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-locations: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-orders: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-productCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-products: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-taxComponents: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + examples: + Example: + value: + accountTransactions: + dataType: accountTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + balanceSheet: + dataType: balanceSheet + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankAccounts: + dataType: bankAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankTransactions: + dataType: bankTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billCreditNotes: + dataType: billCreditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billPayments: + dataType: billPayments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bills: + dataType: bills + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + cashFlowStatement: + dataType: cashFlowStatement + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + chartOfAccounts: + dataType: chartOfAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + company: + dataType: company + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + creditNotes: + dataType: creditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + customers: + dataType: customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directCosts: + dataType: directCosts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directIncomes: + dataType: directIncomes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + invoices: + dataType: invoices + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + itemReceipts: + dataType: itemReceipts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + items: + dataType: items + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journalEntries: + dataType: journalEntries + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journals: + dataType: journals + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + paymentMethods: + dataType: paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + payments: + dataType: payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + profitAndLoss: + dataType: profitAndLoss + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + purchaseOrders: + dataType: purchaseOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + salesOrders: + dataType: salesOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + suppliers: + dataType: suppliers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + taxRates: + dataType: taxRates + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + trackingCategories: + dataType: trackingCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + transfers: + dataType: transfers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accountBalances: + dataType: banking-accountBalances + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accounts: + dataType: banking-accounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactionCategories: + dataType: banking-transactionCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactions: + dataType: banking-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-companyInfo: + dataType: commerce-companyInfo + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-customers: + dataType: commerce-customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-disputes: + dataType: commerce-disputes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-locations: + dataType: commerce-locations + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-orders: + dataType: commerce-orders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-paymentMethods: + dataType: commerce-paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-payments: + dataType: commerce-payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-productCategories: + dataType: commerce-productCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-products: + dataType: commerce-products + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-taxComponents: + dataType: commerce-taxComponents + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-transactions: + dataType: commerce-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/queue/{dataType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataType' + post: + summary: Refresh data type + operationId: refresh-data-type + description: |- + Refreshes a given data type for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + tags: + - Manage data + parameters: + - schema: type: string - description: Allowed name of the 'dataType'. - examples: - - journalEntry - - invoice - - accountTransaction - - transfer - AccountingSupplier: - title: 'Accounting: Supplier' + format: uuid + in: query + name: connectionId + description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/history': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List pull operations + tags: + - Manage data + operationId: list-pull-operations + x-speakeasy-name-override: list-pull-operations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperations' + examples: + Example: + value: + results: + - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b + companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 + connectionId: 51baa045-4836-4317-a42e-3542e991e581 + dataType: invoices + status: Initial + requested: '2022-11-14T11:18:37.2798351Z' + progress: 10 + isCompleted: false + isErrored: false + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets the pull operation history (datasets) for a given company. + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/data/history/{datasetId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: datasetId + in: path + required: true + schema: + type: string + format: uuid + description: Unique identifier for the dataset that completed its sync. + description: Unique identifier for the dataset that completed its sync. + get: + summary: Get pull operation + operationId: get-pull-operation + x-speakeasy-name-override: get-pull-operation + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Retrieve information about a single dataset or pull operation. + '/companies/{companyId}/push': + parameters: + - $ref: '#/components/parameters/companyId' + get: + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + summary: List push operations + tags: + - Push operations + operationId: list-push-operations + description: List push operation records. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperations' + examples: {} + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/push/{pushOperationKey}': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + format: uuid + name: pushOperationKey + in: path + required: true + description: Push operation key. + get: + summary: Get push operation + tags: + - Push operations + operationId: get-push-operation + description: Retrieve push operation. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/push/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Accounts + summary: Create account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Account/definitions/accountPrototype' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create account* endpoint creates a new [account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behaviour** + + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). + operationId: create-account + '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create account model + tags: + - Accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + Exact (UK): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: Name + details: Must have a length between 1 and 60 characters + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Must have a length between 1 and 255 characters + information: [] + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank + type: String + displayName: Bank + required: false + - value: Asset.AccountReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Asset.CashAndBank + type: String + displayName: Cash + required: false + - value: Asset.Property Plant and Equipment + type: String + displayName: Equipment Machinery + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherLiability + type: String + displayName: Other Liability + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Equity.Equity + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Owner's Equity + type: String + displayName: Retained Earnings + required: false + - value: Income + type: String + displayName: Income + required: false + - value: OtherIncome + type: String + displayName: Other Income + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Expense.Expense + type: String + displayName: Sales Marketing + required: false + - value: Expense.Expense.Insurance + type: String + displayName: General Administrative + required: false + - value: Expense.Overhead + type: String + displayName: General Administrative + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repairs Maintenance + required: false + - value: OtherExpense + type: String + displayName: Other Expense + required: false + - value: CostOfSales + type: String + displayName: Cost of Sales + required: false + - value: Cost Of Goods Sold.Cost of Sales + type: String + displayName: Other + required: false + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Max length of 31 characters. + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Max length of 200 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the Quickbooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.AccountsReceivable + type: String + displayName: Account Receivable + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Income.Income + type: String + displayName: Income + required: false + - value: Income.OtherIncome + type: String + displayName: Other Income + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.CostOfGoodsSold + type: String + displayName: Cost Of Goods Sold + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.OtherExpense + type: String + displayName: Other Expense + required: false + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Should not be longer than 200 characters. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: SALES + type: String + displayName: Sales + required: false + - value: OTHER_INCOME + type: String + displayName: Other Income + required: false + - value: DIRECT_EXPENSES + type: String + displayName: Direct Expenses + required: false + - value: OVERHEADS + type: String + displayName: Overheads + required: false + - value: DEPRECIATION + type: String + displayName: Depreciation + required: false + - value: CURRENT_ASSETS + type: String + displayName: Current Assets + required: false + - value: FIXED_ASSETS + type: String + displayName: Fixed Assets + required: false + - value: FUTURE_ASSETS + type: String + displayName: Future Assets + required: false + - value: BANK + type: String + displayName: Bank + required: false + - value: CURRENT_LIABILITY + type: String + displayName: Current Liability + required: false + - value: FUTURE_LIABILITY + type: String + displayName: Future Liability + required: false + - value: EQUITY + type: String + displayName: Equity + required: false + - value: LINE_OF_CREDIT + type: String + displayName: Credit Card / Loan + required: false + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Must be unique within the entity. + - field: NominalCode + details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + options: + - value: Asset + type: String + displayName: Asset + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Income + type: String + displayName: Income + required: false + - value: Liability + type: String + displayName: Liability + required: false + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' + required: true + Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + description: + type: String + displayName: Description + description: Description of the account + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + fullyQualifiedName: + type: String + displayName: Fully Qualified Name + description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales + required: true + currency: + type: String + displayName: Currency + description: The currency of the account + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + required: true + status: + type: String + displayName: Account Status + description: The status of the account + required: true + isBankAccount: + type: Boolean + displayName: Is Bank Account? + description: Confirms whether the nominal account represents a bank account or not + required: true + validDatatypeLinks: + type: Array + displayName: Valid Datatype Links + description: Describes which fields on other data types are valid links to this account in the originating system + properties: + property: + type: String + displayName: Property + description: The field on the source data type that other data types can link to + required: true + links: + type: Array + displayName: Links + description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: Identifier for the nominal account. + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 10 characters. + information: [] + name: + type: String + displayName: Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + validation: + warnings: [] + information: + - field: Name + details: Payments are enabled to this account if the name ends in .PaymentsEnabled. + description: + type: String + displayName: Description + description: Description for the nominal account. + required: false + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: Account type and category for nominal account. + options: + - value: Asset.Current + type: String + displayName: Current Asset + required: false + - value: Asset.Fixed + type: String + displayName: Fixed Asset + required: false + - value: Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.NonCurrent + type: String + displayName: Non-current Asset + required: false + - value: Asset.Prepayment + type: String + displayName: Prepayment + required: false + - value: Expense.DirectCosts + type: String + displayName: Direct Costs + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.Overhead + type: String + displayName: Overhead + required: false + - value: Expense.Superannuation + type: String + displayName: Superannuation + required: false + - value: Expense.Wages + type: String + displayName: Wages + required: false + - value: Income.Sales + type: String + displayName: Sales + required: false + - value: Income.Revenue + type: String + displayName: Revenue + required: false + - value: Income.Other + type: String + displayName: Other Income + required: false + - value: Liability.Current + type: String + displayName: Current Liability + required: false + - value: Liability.Depreciation + type: String + displayName: Depreciation + required: false + - value: Liability.Liability + type: String + displayName: Liability + required: false + - value: Liability.NonCurrent + type: String + displayName: Non Current Liability + required: false + - value: Liability.PayAsYouGo + type: String + displayName: Pay As You Go Liability + required: false + - value: Liability.Superannuation + type: String + displayName: Superannuation Liability + required: false + - value: Liability.WagesPayable + type: String + displayName: Wages Payable Liability + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-chartOfAccounts-model description: |- - ## Overview + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) for a given company and integration. - 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. + [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behaviour** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Bank accounts + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankAccount' examples: - - +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: + QuickBooks Online: + value: + accountName: GBP Bank Account + accountType: Debit + accountNumber: '12345678' + currency: GBP + status: Active + Xero: + value: + accountName: Xero GBP Bank Account + accountType: Debit + sortCode: '445566' + accountNumber: '12345678' + currency: GBP + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBankAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create bank account + description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model)." + operationId: create-bank-account + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create bank account model + tags: + - Bank accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: 'Needs to be of the format ''{No.}-{Name}''' + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Bank Account Posting Group with Nominal Account must exist + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Must have a length between 0 and 20 characters + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: false + validation: + warnings: [] + information: + - field: OverdraftLimit + details: Default value is 0 + required: true + Exact (Netherlands): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must have a length between 0 and 8 characters + information: [] + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account + options: + - value: AED + type: String + displayName: AED + required: false + - value: AMD + type: String + displayName: AMD + required: false + - value: AOA + type: String + displayName: AOA + required: false + - value: ARS + type: String + displayName: ARS + required: false + - value: AUD + type: String + displayName: AUD + required: false + - value: AWG + type: String + displayName: AWG + required: false + - value: AZN + type: String + displayName: AZN + required: false + - value: BBD + type: String + displayName: BBD + required: false + - value: BDT + type: String + displayName: BDT + required: false + - value: BGN + type: String + displayName: BGN + required: false + - value: BRL + type: String + displayName: BRL + required: false + - value: BWP + type: String + displayName: BWP + required: false + - value: CAD + type: String + displayName: CAD + required: false + - value: CHF + type: String + displayName: CHF + required: false + - value: CLP + type: String + displayName: CLP + required: false + - value: CNY + type: String + displayName: CNY + required: false + - value: COP + type: String + displayName: COP + required: false + - value: CRC + type: String + displayName: CRC + required: false + - value: CUC + type: String + displayName: CUC + required: false + - value: CUP + type: String + displayName: CUP + required: false + - value: CZK + type: String + displayName: CZK + required: false + - value: DKK + type: String + displayName: DKK + required: false + - value: DOP + type: String + displayName: DOP + required: false + - value: EGP + type: String + displayName: EGP + required: false + - value: EUR + type: String + displayName: EUR + required: false + - value: FJD + type: String + displayName: FJD + required: false + - value: GBP + type: String + displayName: GBP + required: false + - value: GEL + type: String + displayName: GEL + required: false + - value: GHS + type: String + displayName: GHS + required: false + - value: GTQ + type: String + displayName: GTQ + required: false + - value: GYD + type: String + displayName: GYD + required: false + - value: HKD + type: String + displayName: HKD + required: false + - value: HNL + type: String + displayName: HNL + required: false + - value: HRK + type: String + displayName: HRK + required: false + - value: HUF + type: String + displayName: HUF + required: false + - value: IDR + type: String + displayName: IDR + required: false + - value: ILS + type: String + displayName: ILS + required: false + - value: INR + type: String + displayName: INR + required: false + - value: ISK + type: String + displayName: ISK + required: false + - value: JMD + type: String + displayName: JMD + required: false + - value: JPY + type: String + displayName: JPY + required: false + - value: KES + type: String + displayName: KES + required: false + - value: KRW + type: String + displayName: KRW + required: false + - value: KWD + type: String + displayName: KWD + required: false + - value: KYD + type: String + displayName: KYD + required: false + - value: KZT + type: String + displayName: KZT + required: false + - value: LAK + type: String + displayName: LAK + required: false + - value: LBP + type: String + displayName: LBP + required: false + - value: LKR + type: String + displayName: LKR + required: false + - value: LTL + type: String + displayName: LTL + required: false + - value: LVL + type: String + displayName: LVL + required: false + - value: MAD + type: String + displayName: MAD + required: false + - value: MDL + type: String + displayName: MDL + required: false + - value: MGA + type: String + displayName: MGA + required: false + - value: MUR + type: String + displayName: MUR + required: false + - value: MVR + type: String + displayName: MVR + required: false + - value: MWK + type: String + displayName: MWK + required: false + - value: MXN + type: String + displayName: MXN + required: false + - value: MYR + type: String + displayName: MYR + required: false + - value: MZN + type: String + displayName: MZN + required: false + - value: NAD + type: String + displayName: NAD + required: false + - value: NGN + type: String + displayName: NGN + required: false + - value: NOK + type: String + displayName: NOK + required: false + - value: NPR + type: String + displayName: NPR + required: false + - value: NZD + type: String + displayName: NZD + required: false + - value: OMR + type: String + displayName: OMR + required: false + - value: PEN + type: String + displayName: PEN + required: false + - value: PHP + type: String + displayName: PHP + required: false + - value: PKR + type: String + displayName: PKR + required: false + - value: PLN + type: String + displayName: PLN + required: false + - value: QAR + type: String + displayName: QAR + required: false + - value: RON + type: String + displayName: RON + required: false + - value: RSD + type: String + displayName: RSD + required: false + - value: RUB + type: String + displayName: RUB + required: false + - value: RWF + type: String + displayName: RWF + required: false + - value: SAR + type: String + displayName: SAR + required: false + - value: SCR + type: String + displayName: SCR + required: false + - value: SEK + type: String + displayName: SEK + required: false + - value: SGD + type: String + displayName: SGD + required: false + - value: THB + type: String + displayName: THB + required: false + - value: TND + type: String + displayName: TND + required: false + - value: TRY + type: String + displayName: TRY + required: false + - value: TTD + type: String + displayName: TTD + required: false + - value: TWD + type: String + displayName: TWD + required: false + - value: TZS + type: String + displayName: TZS + required: false + - value: UAH + type: String + displayName: UAH + required: false + - value: UGX + type: String + displayName: UGX + required: false + - value: USD + type: String + displayName: USD + required: false + - value: UYU + type: String + displayName: UYU + required: false + - value: VEF + type: String + displayName: VEF + required: false + - value: VND + type: String + displayName: VND + required: false + - value: VUV + type: String + displayName: VUV + required: false + - value: XAF + type: String + displayName: XAF + required: false + - value: XCD + type: String + displayName: XCD + required: false + - value: XOF + type: String + displayName: XOF + required: false + - value: ZAR + type: String + displayName: ZAR + required: false + - value: ZMK + type: String + displayName: ZMK + required: false + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + validation: + warnings: [] + information: + - field: Balance + details: 'The opening balance, in the account currency' + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: false + required: true + KashFlow: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of the bank account as it appears in Kashflow. + required: true + balance: + type: Number + displayName: Balance + description: 'The opening balance, in the account currency.' + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account. + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: + - field: AccountName + details: Max length of 31 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the Quickbooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + accountNumber: + type: String + displayName: Account Number + description: User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. + required: true + currency: + type: String + displayName: Currency + description: Currency of the bank account. + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: Must be provided. + - field: AccountName + details: Should not be longer than 50 characters. + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + - field: Currency + details: Must match the company's base currency. + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Should be a 6 digit number. + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + validation: + warnings: [] + information: + - field: AccountNumber + details: Should not be longer than 25 characters. + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + validation: + warnings: [] + information: + - field: IBan + details: Should be in the international bank account number format. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + required: true + Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountType: + type: String + displayName: Account Type + description: The type of account + required: true + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: true + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: true + availableBalance: + type: Number + displayName: Available Balance + description: The available balance of the bank account + required: true + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: true + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-bankAccounts-model + description: "The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behaviour**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" + '/companies/{companyId}/data/customers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Customers + summary: List customers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Customers' + examples: + Clear Books: + value: + results: + - id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + contactName: Miguel Hahn + emailAddress: contact@BreitenbergEmardandSchiller.biz + defaultCurrency: GBP + phone: 0800 445 6957 + addresses: + - type: Billing + line1: Apt. 184 + line2: 60578 Louie Springs + city: East Khalid + region: Wales + country: United Kingdom + postalCode: XW89 7NT + contacts: + - name: Miguel Hahn + email: Miguel.Hahn@gmail.com + phone: + - number: 018555 09614 + type: Landline + address: + type: Delivery + line1: Suite 400 + line2: 21930 Milan Lane + city: Reingerton + region: Wales + country: United Kingdom + postalCode: QG10 2DL + status: Active + registrationNumber: KME0AMIL + taxNumber: '8560920952.553111' + status: Archived + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-12-03T11:05:01' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-06-03T08:48:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 + customerName: anna test 2 + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-05-24T11:53:21Z' + pageNumber: 1 + pageSize: 2 + totalResults: 71 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c + customerName: Abdulbasit Al-haj + contactName: abeee + emailAddress: a.alhaj@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + country: GB + contacts: + - name: abeee + phone: [] + address: + type: Unknown + line1: '' + country: 'GB ' + status: Active + modifiedDate: '2020-02-24T12:00:51.027Z' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-24T12:00:50Z' + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + - id: '9677150' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-24T06:19:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: 1234 56789 + type: Primary + - number: 9876 54321 + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + - id: '634486' + customerName: A test customer name 2 + contactName: test person name + emailAddress: test8@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test9@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test10@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test8@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-11T11:39:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: '88459410' + customerName: Diogo Sousa + contactName: Mr Diogo Sousa + emailAddress: diogomail@mail.com + phone: '123123123' + addresses: + - type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + - type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + contacts: + - name: Mr Diogo Sousa + email: diogomail@mail.com + phone: + - number: '123123123' + type: Landline + - number: '321321321' + type: Mobile + address: + type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + status: Active + - name: Mr Diogo Sousa + phone: [] + address: + type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2021-05-04T13:22:19' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + - id: '172722' + customerName: 1248 European Company + contactName: European Company + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-07-27T14:29:16' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + - id: 800000D0-1182061376 + customerName: 'Allard, Robert' + contactName: Amanda Roberts + emailAddress: rallard@myemail.com + defaultCurrency: GBP + phone: 650-555-3422 + addresses: + - type: Delivery + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + - type: Billing + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + contacts: + - name: 'Allard, Robert' + email: rallard@myemail.com + phone: + - number: 650-555-3422 + type: Primary + - number: 650-555-9804 + type: Fax + - number: 650-555-8349 + type: Unknown + status: Active + - name: Robert Allard + phone: [] + status: Active + - name: Rachel Fisher + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + - id: '49' + customerName: adeel qbo child test + contactName: Adeel test + emailAddress: adeel@adeel.com + defaultCurrency: GBP + phone: '123456789' + addresses: + - type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + - type: Delivery + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + contacts: + - name: Adeel test + email: adeel@adeel.com + phone: + - number: '123456789' + type: Primary + - number: '07546543216' + type: Mobile + address: + type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + status: Active + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-08-22T09:21:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + - id: '67' + customerName: Abercrombie International Group + contactName: Natalie Watts + emailAddress: n.watts@google.com + defaultCurrency: USD + addresses: + - type: Billing + - type: Delivery + contacts: + - name: Abercrombie International Group + email: n.watts@google.com + phone: [] + address: + type: Billing + status: Active + registrationNumber: XXXXVat123456 + taxNumber: XXXXVat123456 + status: Active + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2023-03-29T01:12:55Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 243 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + - id: A1D002 + customerName: A2 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Billing + line1: 77a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 40 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2020-09-23T10:28:58Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + - id: ABS001 + customerName: ABS Garages Ltd + contactName: Mike Hall + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 0191 254 5909 + addresses: + - type: Delivery + line1: Swanson Industries + line2: Dukes Industrial Estate + city: Whitley Bay + region: North Tyneside + country: GB + postalCode: NE56 4ER + - type: Delivery + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + - type: Unknown + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + contacts: [] + taxNumber: GB745 4584 68 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + - id: 44a5d9461d9e4f6d90a5ace251c5cf35 + customerName: 100 test name DS + contactName: Main Contact + emailAddress: DCemail@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: POST - Aruba Address line 1 + line2: POST - Aruba Address line 2 + city: POST - Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: [] + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-06-10T14:22:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 168 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + - id: '324' + customerName: 3Way International Logistics + contactName: Lauri O'Heagertie + defaultCurrency: CAD + phone: 410-309-3976 + addresses: + - type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + contacts: + - name: 'O''Heagertie, Lauri' + phone: + - number: 410-309-3976 + type: Primary + address: + type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2020-10-20T05:01:49' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 530 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 + customerName: Coffee Cart + contactName: Coffee Carl + emailAddress: coffee.cart@example.com + defaultCurrency: GBP + phone: '0201111' + addresses: + - type: Billing + line1: 11 Coffee Lane + line2: Coffee Town + city: Coffee City + region: Hampshire + country: United Kingdom + postalCode: CC1 1CC + contacts: + - name: Coffee Carl + phone: + - number: '07733' + type: Mobile + status: Active + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2020-03-17T19:12:39Z' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + customerName: 7-Eleven + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + - id: '104957000000054050' + customerName: 'Doe, John' + contactName: John Doe + emailAddress: '' + defaultCurrency: GBP + addresses: [] + contacts: + - name: John Doe + email: '' + phone: [] + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-28T15:09:22' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data).\n " + operationId: list-customers + '/companies/{companyId}/data/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Customers + summary: Get customer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + examples: + Clear Books: + value: + id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + Exact (UK): + value: + id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + FreeAgent: + value: + id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + KashFlow: + value: + id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Oracle NetSuite: + value: + id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + QuickBooks Desktop: + value: + id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + QuickBooks Online Sandbox: + value: + id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + Sage 50 (UK): + value: + id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + Sage Intacct: + value: + id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). + operationId: get-customer + '/companies/{companyId}/connections/{connectionId}/push/customers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Customers + summary: Create customer + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + responses: + '200': + description: Success content: - 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' + application/json: + schema: + $ref: '#/components/schemas/CreateCustomerResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: create-customer description: |- - 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. + The *Create customer* endpoint creates a new [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - 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. + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - 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 Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. + **Integration-specific behaviour** - 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' + Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). + '/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + put: + tags: + - Customers + summary: Update customer + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + - $ref: '#/components/parameters/forceUpdate' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomerResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' description: |- - The Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity. + The *Update customer* endpoint updates an existing [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - 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. + [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + **Integration-specific behaviour** + + Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). + operationId: update-customer + '/companies/{companyId}/data/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Suppliers + summary: List suppliers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Suppliers' + examples: + Clear Books: + value: + results: + - id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: FyUkHbZxhn + supplierName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + phone: 0116 796 3163 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '0177-04-27T11:56:00' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 100 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: be49ec62-6754-ed11-946f-0022481b67d1 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2022-10-25T13:17:36Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 31 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + - id: 00014c12-2616-481a-a2e8-31bdf2497775 + supplierName: Ann's test supplier 2 + contactName: Ann's contact name + emailAddress: anna@anna888888.com + phone: '55555555' + addresses: + - type: Billing + line1: line1 + line2: line2 + city: city + region: region + country: RU + postalCode: postal + registrationNumber: '55566677788899944455' + taxNumber: RU4444444 + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-09T12:04:08Z' + defaultCurrency: USD + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + - id: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2020-05-01T14:05:46Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 118 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + - id: '9677150' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-24T06:19:23' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + - id: DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA== + supplierName: 'Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez' + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + - id: '9338173' + supplierName: Home + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '1990-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + - id: '726' + supplierName: Vendor -.A + contactName: Vendor -.A + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2021-03-26T09:53:15' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: A40000-1197774038 + supplierName: Bank of Anycity + contactName: Lisa D. Holzhauser + emailAddress: lisah@samplename.com + phone: 415-555-9135 + addresses: + - type: Billing + line1: 'Bank of Anycity, Lisa Holzhauser' + line2: 1935 Main Street + city: Middlefield + region: CA + postalCode: '94482' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 54 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + - id: '42' + supplierName: AI Support 2 + contactName: AI Support 2 + addresses: + - type: Billing + line1: test + region: string + country: DJ + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2021-08-31T08:45:02Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 23 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: '88' + supplierName: Andrew Haberbosch + addresses: [] + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2022-07-06T15:55:28Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + - id: '914' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + pageNumber: 1 + pageSize: 2 + totalResults: 943 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: MCN001 + supplierName: McNally Computer Supplies + contactName: Stuart Lynn + emailAddress: newbusinessadvice@sage.com + phone: 0191 415 3434 + addresses: + - type: Delivery + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + - type: Unknown + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + taxNumber: GB455 2385 34 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-12-05T13:37:26Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + - id: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + contactName: Abdi + emailAddress: abdisupplier@company.com + addresses: + - type: Billing + line1: 1 Place House + city: London + country: United Kingdom (GB) + postalCode: WC1X 1AH + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-13T10:38:19Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + - id: '29' + supplierName: Advisor Printing + contactName: 'Roach, Nathan' + phone: 130-202-4796 + addresses: + - type: Unknown + line1: 5 Carey Hill + line2: '' + city: Drayton Valley + region: Alberta + country: Canada + postalCode: G8V + registrationNumber: '' + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2022-06-15T11:38:29' + defaultCurrency: CAD + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx + supplierName: Flour Mill + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:12:40Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + supplierName: 7-Eleven + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + - id: '104957000000648001' + supplierName: Cool company + contactName: Dre + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-10T09:07:16' + defaultCurrency: CAD + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data).\n " + operationId: list-suppliers + '/companies/{companyId}/data/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/supplierId' + get: + tags: + - Suppliers + summary: Get supplier + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier' + examples: + Clear Books: + value: + id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + Exact (UK): + value: + id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + FreeAgent: + value: + id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + FreshBooks: + value: + id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + Oracle NetSuite: + value: + id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + QuickBooks Desktop: + value: + id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + QuickBooks Online Sandbox: + value: + id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + Sage 50 (UK): + value: + id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + Sage Intacct: + value: + id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get supplier* endpoint returns a single supplier for a given supplierId. - 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. + [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - 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' - - 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' - 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 + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). + operationId: get-supplier + '/companies/{companyId}/connections/{connectionId}/push/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Suppliers + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier' + examples: + Sage Intacct: + value: + id: '73593' + supplierName: test 20230420 1004 + contactName: Joe Bloggs + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create supplier + description: "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model).\r\n" + operationId: create-supplier + '/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/supplierId' + put: + tags: + - Suppliers + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + - $ref: '#/components/parameters/forceUpdate' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Update supplier + description: "The *Update supplier* endpoint updates an existing [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model)." + operationId: update-supplier +webhooks: + expenses.sync.successful: + post: + description: Called when an expense sync successfully completes without any errors or warnings. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpensesSyncWebhook' + examples: + Successful: + value: + id: ba29118f-5406-4e59-b05c-ba307ca38d01 + eventType: expenses.sync.successful + generatedDate: '2024-09-01T00:00:00Z' + payload: + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Toft stores + description: Syncing expenses + syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + transactions: + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: Completed + errorMessage: null + - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 + status: Completed + errorMessage: null + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + expenses.sync.unsuccessful: + post: + description: 'Called when an expense sync fails to complete successfully, resulting in at least one error or warning.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpensesSyncWebhook' examples: - - 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 + Unsuccessful: + value: + id: ba29118f-5406-4e59-b05c-ba307ca38d01 + eventType: expenses.sync.unsuccessful + generatedDate: '2024-09-01T00:00:00Z' + payload: + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Toft stores + description: Syncing expenses + syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + transactions: + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: Completed + errorMessage: null + - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 + status: Failed + errorMessage: Insufficient funds + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + SyncCompleted: + post: + deprecated: true + description: |- + Triggered anytime an expense sync completes. Used for Sync for Expenses only. + + > This event type is deprecated. Use the `expenses.sync.successful` to get notified when an expense sync completes successfully. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyncCompleteWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + SyncFailed: + post: + deprecated: true + description: |- + Indicates a failure occurred during an expense sync. Used for Sync for Expenses only. + + > This event type is deprecated. Use the `expenses.sync.unsuccessful` to get notified when an expense sync completes unsuccessfully. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyncFailedWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reached: + post: + description: Called when your client’s request count to Codat's API surpasses the allocated quota. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' examples: - - 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 + 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: - - 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 + Reset: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reset + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 11993 + expiryDate: '2024-09-01T23:59:99Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + Client rate limit reached: + post: + deprecated: true + description: "Called when your client’s requests to Codat's API exceed the allocated quota. \n\n**Note: This event type is deprecated. Developers should now use the `client.rateLimit.reached` event for handling rate limit notifications.**" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitReachedWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + Client rate limit reset: + post: + deprecated: true description: |- - The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. + Called when the rate limit quota has reset for the client, and more requests to Codat's API are available. - 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). + Note: This event type is deprecated. Developers should now use the `client.rateLimit.reset` event for handling rate limit notifications. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitResetWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + Account: + title: 'Accounting: Account' + description: "\uFEFF\x3E\x20\x2A\x2A\x4C\x61\x6E\x67\x75\x61\x67\x65\x20\x74\x69\x70\x3A\x2A\x2A\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x61\x6C\x73\x6F\x20\x72\x65\x66\x65\x72\x72\x65\x64\x20\x74\x6F\x20\x61\x73\x20\x2A\x2A\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x2A\x2A\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x61\x6E\x64\x20\x2A\x2A\x67\x65\x6E\x65\x72\x61\x6C\x20\x6C\x65\x64\x67\x65\x72\x2A\x2A\x2E\n\n\x23\x23\x20\x4F\x76\x65\x72\x76\x69\x65\x77\n\n\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x75\x73\x65\x73\x20\x74\x6F\x20\x72\x65\x63\x6F\x72\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2E\x20\x46\x72\x6F\x6D\x20\x74\x68\x65\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x72\x65\x74\x72\x69\x65\x76\x65\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x63\x6C\x75\x64\x65\x3A\n\x2A\x20\x41\x73\x73\x65\x74\n\x2A\x20\x45\x78\x70\x65\x6E\x73\x65\n\x2A\x20\x49\x6E\x63\x6F\x6D\x65\n\x2A\x20\x4C\x69\x61\x62\x69\x6C\x69\x74\x79\n\x2A\x20\x45\x71\x75\x69\x74\x79\x2E\n\n\x54\x68\x65\x20\x73\x61\x6D\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x61\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x62\x61\x73\x65\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x69\x74\x20\x69\x73\x20\x75\x73\x65\x64\x20\x69\x6E\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x63\x75\x72\x72\x65\x6E\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x6B\x6E\x6F\x77\x6E\x20\x61\x73\x20\x63\x68\x65\x63\x6B\x69\x6E\x67\x20\x69\x6E\x20\x74\x68\x65\x20\x55\x53\x29\x20\x73\x68\x6F\x75\x6C\x64\x20\x62\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x61\x73\x20\x60\x41\x73\x73\x65\x74\x2E\x43\x75\x72\x72\x65\x6E\x74\x60\x20\x66\x6F\x72\x20\x58\x65\x72\x6F\x2C\x20\x61\x6E\x64\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x2E\x43\x68\x65\x63\x6B\x69\x6E\x67\x60\x20\x66\x6F\x72\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x2E\n\n\x41\x74\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x74\x69\x6D\x65\x2C\x20\x65\x61\x63\x68\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x69\x74\x73\x20\x6F\x77\x6E\x20\x72\x65\x71\x75\x69\x72\x65\x6D\x65\x6E\x74\x73\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x50\x61\x79\x70\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x58\x65\x72\x6F\x20\x69\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x60\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x61\x6E\x64\x20\x74\x68\x65\x72\x65\x66\x6F\x72\x65\x20\x72\x65\x71\x75\x69\x72\x65\x73\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x74\x6F\x20\x62\x65\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2E\n\n\x54\x6F\x20\x64\x65\x74\x65\x72\x6D\x69\x6E\x65\x20\x74\x68\x65\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x3A\n\x2D\x20\x46\x6F\x6C\x6C\x6F\x77\x20\x6F\x75\x72\x20\x5B\x43\x72\x65\x61\x74\x65\x2C\x20\x75\x70\x64\x61\x74\x65\x2C\x20\x64\x65\x6C\x65\x74\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x70\x75\x73\x68\x29\x20\x67\x75\x69\x64\x65\x20\x61\x6E\x64\x20\x75\x73\x65\x20\x74\x68\x65\x20\x5B\x47\x65\x74\x20\x63\x72\x65\x61\x74\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x6F\x64\x65\x6C\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x63\x72\x65\x61\x74\x65\x2D\x63\x68\x61\x72\x74\x4F\x66\x41\x63\x63\x6F\x75\x6E\x74\x73\x2D\x6D\x6F\x64\x65\x6C\x29\x2E\n\x2D\x20\x52\x65\x66\x65\x72\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x27\x73\x20\x6F\x77\x6E\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x2E\n\n\x3E\x20\x2A\x2A\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\n\x3E\n\x3E\x20\x49\x66\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x73\x20\x70\x75\x6C\x6C\x65\x64\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x69\x74\x73\x20\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x63\x6F\x64\x65\x20\x64\x6F\x65\x73\x20\x6E\x6F\x74\x20\x6C\x69\x65\x20\x77\x69\x74\x68\x69\x6E\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x6C\x61\x79\x6F\x75\x74\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x74\x68\x65\x6E\x20\x74\x68\x65\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x69\x73\x20\x60\x55\x6E\x6B\x6E\x6F\x77\x6E\x60\x2E\x20\x54\x68\x65\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x43\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\x20\x61\x6E\x64\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x4E\x61\x6D\x65\x2A\x2A\x20\x66\x69\x65\x6C\x64\x73\x20\x72\x65\x74\x75\x72\x6E\x20\x60\x6E\x75\x6C\x6C\x60\x2E\n\x3E\n\x3E\x20\x54\x68\x69\x73\x20\x61\x70\x70\x72\x6F\x61\x63\x68\x20\x67\x69\x76\x65\x73\x20\x61\x20\x74\x72\x75\x65\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x68\x69\x6C\x73\x74\x20\x70\x72\x65\x76\x65\x6E\x74\x69\x6E\x67\x20\x64\x69\x73\x74\x6F\x72\x74\x69\x6E\x67\x20\x66\x69\x6E\x61\x6E\x63\x69\x61\x6C\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x70\x72\x6F\x66\x69\x74\x20\x61\x6E\x64\x20\x6C\x6F\x73\x73\x20\x61\x6E\x64\x20\x62\x61\x6C\x61\x6E\x63\x65\x20\x73\x68\x65\x65\x74\x20\x72\x65\x70\x6F\x72\x74\x73\x2E" allOf: - - type: object - x-stoplight: - id: 516bf0ecc4907 - required: - - id - properties: + - 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 + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + - $ref: '#/components/schemas/Account/definitions/accountPrototype' - 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. + metadata: + title: Metadata + type: object + x-internal: true + properties: + isDeleted: + type: boolean + description: Indicates whether the record has been deleted in the third-party system this record originated from. + nullable: true - title: Modified dates x-internal: true allOf: @@ -82956,15 +9967,8 @@ components: 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. + - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + - description: "The date when the record was last fetched from the data source and updated in Codat’s data cache. \n\nUse it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today.\n\nThis date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)).\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." - title: Source Modified Date x-internal: true type: object @@ -82972,932 +9976,555 @@ components: 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." + - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + - description: "The date when a record was last modified in the source platform, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The integration platform does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." 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: + 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: - 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 + 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: - - 0 - - 12.5 - - 45 - taxPercentage: - description: Percentage rate (from 0 to 100) of any tax applied to the service charge. - type: number - format: decimal + - Cash On Hand + - Fixed Asset + currency: + title: Currency + x-internal: true + type: string + description: "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system." + format: ISO4217 examples: - - 0 - - 12.5 - - 45 - taxAmount: - description: Amount of the service charge that is tax. + - GBP + - USD + - EUR + currentBalance: type: number format: decimal - examples: - - 0 - - 12.5 - - 45 - taxes: - description: Taxes breakdown as applied to service charges. + nullable: true + description: Current balance in the account. + example: 0 + type: + $ref: '#/components/schemas/Account/definitions/accountType' + status: + $ref: '#/components/schemas/Account/definitions/accountStatus' + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validDatatypeLinks: type: array + nullable: true + description: 'The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-expenses-api#/schemas/ValidDataTypeLinks).' items: - $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: + 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 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. + description: '''name'' from the Accounts data type.' + accountType: + title: Account type enum: - - Pending - - Authorized - - Paid - - Failed - - Cancelled - Unknown - paymentType: + - Asset + - Expense + - Income + - Liability + - Equity type: string - x-internal: true - nullable: true - description: Type of payment. + description: Type of account + example: Asset + accountStatus: + title: Account status 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. + - Active + - Archived + - Pending + type: string + description: Status of the account + example: Active 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' + AccountMappingInfo: + title: Account mapping info x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/CommercePaymentMethod' - - $ref: '#/components/schemas/PagingInfo' - CommercePayments: - title: 'Commerce: Payments' + type: object + additionalProperties: false + x-examples: + Example AccountInfo: + id: 313a4dbe-b3a4-42f0-a5f5-43e382e62db9 + nominalCode: '720' + name: Travel + currency: GBP + accountType: Expense + fullyQualifiedCategory: Expense.Overhead + isBankAccount: false + validTransactionTypes: + - Payment + - Refund + validFor: + - expense-transactions.Payment + - expense-transactions.Refund + - reimbursable-expense-transactions + properties: + id: + type: string + description: Unique identifier of account. + example: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b + nullable: false + nominalCode: + type: string + description: Code used to identify each nominal account in the accounting software. + example: '300' + nullable: true + name: + type: string + description: Name of the account as it appears in the company's accounting software. + example: Purchases + nullable: false + currency: + type: string + description: Currency of the account. + example: GBP + nullable: false + accountType: + type: string + description: Type of the account. + example: Expense + enum: + - Asset + - Liability + - Income + - Expense + - Equity + nullable: false + fullyQualifiedCategory: + type: string + description: Full account type and category of the account + example: Expense.DirectCosts + nullable: false + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validTransactionTypes: + $ref: '#/components/schemas/validTransactionTypes' + description: Supported transaction types for the account. + validFor: + $ref: '#/components/schemas/validFor' + description: Supported endpoints for the account. + AdjustmentTransactionLine: x-internal: true - 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. + title: Adjustment transaction line 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 + properties: + amount: + type: number + format: decimal + example: 50 + description: Amount of the line. A positive line represents a debit; a negative line represents a credit. + accountRef: + $ref: '#/components/schemas/RecordRef' + description: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + trackingRefs: + type: array + minItems: 1 + maxItems: 10 + nullable: true + items: + $ref: '#/components/schemas/TrackingRefAdjustmentTransaction' + invoiceTo: + $ref: '#/components/schemas/InvoiceTo' + required: + - amount + - accountRef + AdjustmentTransactionRequest: + title: Adjustment transaction + type: object + properties: + id: type: string - description: The status of the product variant. - enum: - - Unknown - - Published - - Unpublished - CommerceProductCategories: - title: 'Commerce: Product categories' + format: uuid + description: Your unique identifier for the transaction. + date: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction. + currency: + type: string + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + reference: + type: string + nullable: true + description: User-friendly reference for the adjustment transaction. + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/AdjustmentTransactionLine' + required: + - id + - date + - currency + - lines + AdjustmentTransactionResponse: + title: Adjustment response x-internal: true - 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 + properties: + syncId: + type: string + example: cd937d46-8e41-43a9-9477-a79158ffd98a + format: uuid + description: Unique id of sync created + apAccountRef: x-internal: true type: object + title: Accounts Payable account reference + nullable: true properties: id: - 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. + example: 8000004C-1724173136 + description: Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. + Attachment: + title: Attachment + type: object + x-examples: + Attachment Example: + companyId: bf1e0242-5b7a-418b-a307-9e09dbf9f39a + id: '1400000000122699154' + transactionId: f8f00edd-ddb0-4ca5-b36b-8f932e6b5160 + properties: + companyId: type: string - 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" + format: uuid + description: Unique ID of company in Codat + id: + type: string + description: Unique identifier of attachment + transactionId: + type: string + description: Unique identifier of transaction + AttachmentUpload: + title: Attachment upload type: object + x-internal: true + required: + - file properties: - reportInfo: - type: object - additionalProperties: + file: + $ref: '#/components/schemas/AttachmentUpload/definitions/codatFile' + definitions: + codatFile: + type: string + description: The file to be uploaded as an attachment. + format: binary + BankAccount: + title: 'Accounting: Bank account' + description: "> **Accessing Bank Accounts through Banking API**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n> \n> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type.\n\n## Overview\n\nA list of bank accounts associated with a company and a specific data connection.\n\nBank accounts data includes:\n* The name and ID of the account in the accounting software.\n* The currency and balance of the account.\n* The sort code and account number." + type: object + allOf: + - properties: + id: type: string - 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' + description: 'Identifier for the account, unique for the company in the accounting software.' + - $ref: '#/components/schemas/BankAccount/definitions/bankAccountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Account/allOf/2/properties/metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/Account/allOf/3' definitions: - 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 + bankAccountPrototype: + title: Bank account prototype type: object properties: - message: + accountName: type: string - description: Message returned by error. - type: + 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 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: + 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 - description: The dimension's display name. - type: + nullable: true + description: Code used to identify each nominal account for a business. + sortCode: 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: + 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 - description: The component's display name. - item: - type: integer - description: The component's item number. - itemDisplayName: + 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 - 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: + nullable: true + description: International bank account number of the account. Often used when making or receiving international payments. + currency: + $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' + description: Base currency of the bank account. + balance: + type: number + format: decimal + nullable: true + description: Balance of the bank account. + institution: type: string - description: The measure's display name. - value: + nullable: true + description: The institution of the bank account. + availableBalance: 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. + 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 - taxComponentRef: + description: |- + Pre-arranged overdraft limit of the account. + + The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. + status: + $ref: '#/components/schemas/BankAccount/definitions/bankAccountStatus' + bankAccountCreateResponse: + title: Create bank account response + allOf: + - properties: + data: + allOf: + - $ref: '#/components/schemas/BankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + bankAccountRef: + title: Bank account reference type: object - 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 + description: Bank account 'id' for the account transaction. name: - description: Name of the tax component being referenced. type: string - required: - - id - - name + description: bank account 'name' for the account transaction. + description: Links to the Account transactions data type. + bankAccounts: + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankAccount' + - $ref: '#/components/schemas/PagingInfo' + bankAccountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the bank account. + example: Active + ClientRateLimitReachedWebhook: + title: Client rate limit reached webhook + x-internal: true + description: Webhook request body for a client that has reached their rate limit. + type: object + properties: + ClientId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' + ClientName: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' + RuleId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' + RuleType: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' + AlertId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' + Message: + $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' + Data: + $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData' + definitions: + ClientRateLimitReachedWebhookData: + type: object + title: Client rate limit reached webhook data + properties: + DailyQuota: + type: integer + description: The number of available requests per day. + ExpiresUtc: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: The date time in UTC when your daily quota is reset. + examples: + - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + ClientName: Bank of Dave + RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac + RuleType: Rate Limit Reached + AlertId: a9367074-b5c3-42c4-9be4-be129f43577e + Message: The current daily rate limit quota of 1000 requests for bae71d36-ff47-420a-b4a6-f8c9ddf41140 has been reached. + Data: + DailyQuota: 1000 + ExpiresUtc: '2023-05-03T00:00:00Z' + ClientRateLimitResetWebhook: + title: Client rate limit reset webhook + x-internal: true + description: Webhook request body for a client that has had their rate limit reset. + type: object + properties: + ClientId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' + ClientName: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' + RuleId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' + RuleType: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' + AlertId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' + Message: + $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' + Data: + $ref: '#/components/schemas/ClientRateLimitResetWebhook/definitions/ClientRateLimitResetWebhookData' + definitions: + ClientRateLimitResetWebhookData: + type: object + title: Client rate limit reset webhook data + properties: + QuotaRemaining: + type: integer + description: Total number of requests remaining for your client. + nullable: true + ResetReason: + type: string + description: The reason for your rate limit quota being reset. + DailyQuota: + $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData/properties/DailyQuota' + nullable: true + ExpiresUtc: + $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData/properties/ExpiresUtc' + nullable: true examples: - - 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" + - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + ClientName: Bank of Dave + RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac + RuleType: Rate Limit Reset + AlertId: a9367074-b5c3-42c4-9be4-be129f43577e + Message: The current daily rate limit quota for client 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e has been reset to 1000 requests. + Data: + QuotaRemaining: 1000 + ResetReason: The quota was reset because it is a new day. + DailyQuota: 1000 + ExpiresUtc: '2023-05-03T00:00:00Z' + ClientRateLimitWebhook: + title: Client rate limit webhook type: object - 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 + properties: + id: 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. " + format: uuid + example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + description: Unique identifier of the event. + eventType: 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' + description: The type of event. + examples: + - client.rateLimit.reset + - client.rateLimit.reached + generatedDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/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/TransferTransactionRequest/properties/date/allOf/1' + description: The date time in UTC when your daily quota is reset. Companies: title: Companies x-internal: true @@ -83911,8 +10538,7 @@ components: - $ref: '#/components/schemas/PagingInfo' Company: title: Company - description: "\uFEFF\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\x20\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x58\x65\x72\x6F\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2F\x78\x65\x72\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x78\x65\x72\x6F\x29\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x5B\x50\x6C\x61\x69\x64\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2F\x70\x6C\x61\x69\x64\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x70\x6C\x61\x69\x64\x29\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x5A\x65\x74\x74\x6C\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2F\x7A\x65\x74\x74\x6C\x65\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x7A\x65\x74\x74\x6C\x65\x29\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x54\x79\x70\x69\x63\x61\x6C\x6C\x79\x20\x65\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x69\x73\x20\x6F\x6E\x65\x20\x6F\x66\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x73\x2E\n\n\x57\x68\x65\x6E\x20\x79\x6F\x75\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x73\x70\x65\x63\x69\x66\x79\x20\x61\x20\x60\x6E\x61\x6D\x65\x60\x20\x61\x6E\x64\x20\x77\x65\x20\x77\x69\x6C\x6C\x20\x61\x75\x74\x6F\x6D\x61\x74\x69\x63\x61\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x20\x61\x20\x75\x6E\x69\x71\x75\x65\x20\x60\x69\x64\x60\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x61\x6C\x73\x6F\x20\x61\x64\x64\x20\x61\x20\x60\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x60\x20\x74\x6F\x20\x73\x74\x6F\x72\x65\x20\x61\x6E\x79\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" - description: "\uFEFF\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\x20\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\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" + description: "\uFEFF\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\x20\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x58\x65\x72\x6F\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2F\x78\x65\x72\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x78\x65\x72\x6F\x29\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x5B\x50\x6C\x61\x69\x64\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2F\x70\x6C\x61\x69\x64\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x70\x6C\x61\x69\x64\x29\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x5A\x65\x74\x74\x6C\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2F\x7A\x65\x74\x74\x6C\x65\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x7A\x65\x74\x74\x6C\x65\x29\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x54\x79\x70\x69\x63\x61\x6C\x6C\x79\x20\x65\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x69\x73\x20\x6F\x6E\x65\x20\x6F\x66\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x73\x2E\n\n\x57\x68\x65\x6E\x20\x79\x6F\x75\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x73\x70\x65\x63\x69\x66\x79\x20\x61\x20\x60\x6E\x61\x6D\x65\x60\x20\x61\x6E\x64\x20\x77\x65\x20\x77\x69\x6C\x6C\x20\x61\x75\x74\x6F\x6D\x61\x74\x69\x63\x61\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x20\x61\x20\x75\x6E\x69\x71\x75\x65\x20\x60\x69\x64\x60\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x61\x6C\x73\x6F\x20\x61\x64\x64\x20\x61\x20\x60\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x60\x20\x74\x6F\x20\x73\x74\x6F\x72\x65\x20\x61\x6E\x79\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" type: object allOf: - $ref: '#/components/schemas/Company/definitions/companyDetails' @@ -83942,10 +10568,10 @@ components: description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' lastSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' nullable: true created: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' createdByUserName: type: string description: Name of user that created the company in Codat. @@ -84021,39 +10647,232 @@ components: 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. + CompanyConfiguration: + required: + - bankAccount + - supplier + - customer + title: Company configuration type: object - allOf: - - $ref: '#/components/schemas/CompanyAccessToken/definitions/accessToken' + x-examples: + Config Example: + bankAccount: + id: '89' + supplier: + id: '124' + customer: + id: '140' + properties: + bankAccount: + $ref: '#/components/schemas/CompanyConfiguration/definitions/BankAccountDetails' + supplier: + $ref: '#/components/schemas/CompanyConfiguration/definitions/SupplierDetails' + customer: + $ref: '#/components/schemas/CompanyConfiguration/definitions/CustomerDetails' definitions: - accessToken: - title: Access token + BankAccountDetails: + title: Bank account details type: object properties: - expiresIn: - type: integer - description: The number of seconds until the access token expires. - example: 86400 - accessToken: - type: string - description: The access token for the company. - tokenType: + id: type: string - description: The type of token. - example: Bearer - required: - - expiresIn - - accessToken - - tokenType + description: The id of the account from which purchases are made + example: '32' + SupplierDetails: + title: Supplier details + type: object + properties: + id: + $ref: '#/components/schemas/Supplier/allOf/0/properties/id' + CustomerDetails: + title: Customer details + type: object + properties: + id: + $ref: '#/components/schemas/Customer/allOf/0/properties/id' + CompanyInformation: + title: 'Accounting: Company information' + description: "Company info provides standard details about a linked company such as their address, phone number, and company registration.\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: + title: 'Accounting: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items/definitions/accountingAddressType' + line1: + type: string + nullable: true + description: Line 1 of the customer address. + line2: + type: string + nullable: true + description: Line 2 of the customer address. + city: + type: string + nullable: true + description: City of the customer address. + region: + type: string + nullable: true + description: Region of the customer address. + country: + type: string + nullable: true + description: Country of the customer address. + postalCode: + type: string + nullable: true + description: Postal code or zip code. + required: + - type + definitions: + accountingAddressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + phoneNumbers: + type: array + nullable: true + description: An array of phone numbers. + items: + title: Phone + type: object + x-internal: true + properties: + number: + type: string + nullable: true + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + description: A phone number. + type: + $ref: '#/components/schemas/CompanyInformation/properties/phoneNumbers/items/definitions/phoneNumberType' + required: + - type + definitions: + phoneNumberType: + description: The type of phone number + type: string + enum: + - Primary + - Landline + - Mobile + - Fax + - Unknown + webLinks: + type: array + nullable: true + description: An array of weblinks. + items: + title: Weblink + description: Weblink associated with the company. + type: object + properties: + type: + description: The type of the weblink. + type: string + enum: + - Website + - Social + - Unknown + url: + description: The full URL for the weblink. + type: string + format: url + example: + type: Website + url: 'https://codat.io' + ledgerLockDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: 'If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end.' + registrationNumber: + type: string + nullable: true + description: Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + taxNumber: + type: string + nullable: true + description: Company tax number. + financialYearStartDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Start date of the financial year for the company. + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. + sourceUrls: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + description: |- + URL addresses for the accounting source. + + For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + createdDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date the linked company was created in the accounting software. + supplementalData: + $ref: '#/components/schemas/SupplementalData' examples: - - expiresIn: 86400 - accessToken: string - tokenType: Bearer + - companyName: ACME Corporation + accountingPlatformRef: 4444e827-401b-4925-92cb-d79086bf3b6b + companyLegalName: ACME Corporation Ltd. + addresses: + - type: Billing + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalcode: WC1X 8WB + - type: Unknown + line1: 123 Sierra Way + line2: '' + city: San Pablo + region: CA + country: '' + postalCode: '87999' + phoneNumbers: + - number: 010 1234 5678 + type: Landline + webLinks: + - type: Website + url: 'https://www.wbsl.com/' + ledgerLockDate: '2019-03-04T12:08:01.881Z' + registrationNumber: '1234567890' + taxNumber: GB 123456789 + financialYearStartDate: '2019-04-01T00:00:00Z' + baseCurrency: USD + sourceUrls: + url1: 'https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q' + url2: 'https://reporting.xero.com/!rxs0Q' + createdDate: '2020-02-03T16:42:02Z' CompanyRequestBody: title: Create company request x-internal: true @@ -84073,47 +10892,73 @@ components: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' required: - name - CompanyUpdateRequest: - title: Update company request - x-internal: true + CompanySyncStatus: + title: Company sync status type: object + additionalProperties: false + x-examples: + Success Data Pushed: + companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 + syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 + syncStatusCode: 2000 + syncStatus: Complete + errorMessage: '' + syncExceptionMessage: '' + syncUtc: '2023-01-24T14:15:22Z' + dataPushed: true + Success No Data Pushed: + companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 + syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 + syncStatusCode: 2040 + syncStatus: Complete + errorMessage: '' + syncExceptionMessage: '' + syncUtc: '2023-01-24T14:15:22Z' + dataPushed: false properties: - name: + companyId: 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' - CompanyWebhook: - title: Company webhook - type: object - properties: - id: + description: Unique identifier for your SMB in Codat. + example: d4d73051-ed31-42b6-99f6-d288cd940992 + nullable: true + syncId: type: string - format: uuid - example: ba29118f-5406-4e59-b05c-ba307ca38d01 - description: Unique identifier of the event - eventType: + description: Unique identifier of the sync. + example: a6a22aff-a43a-411d-a910-2dae73217cce + nullable: true + syncStatusCode: + type: integer + format: int32 + description: Status code of the sync. + example: 2000 + syncStatus: type: string - description: The type of event. + description: Text status of the sync. examples: - - company.created - - company.deleted - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/Company/definitions/companyDetails' - 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\x70\x6C\x61\x74\x66\x6F\x72\x6D\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" + - Complete + - PushError + - Started + - NotStarted + - Pushing + nullable: true + errorMessage: + type: string + description: Error message of the sync. + nullable: true + syncExceptionMessage: + type: string + description: Exception message of the sync. + nullable: true + syncUtc: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Datetime of the sync. + nullable: true + dataPushed: + type: boolean + description: Boolean of whether the sync resulted in data being pushed. 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" + description: "\uFEFF\x41\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x61\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x6E\x64\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x73\x79\x6E\x63\x68\x72\x6F\x6E\x69\x7A\x65\x20\x64\x61\x74\x61\x20\x28\x70\x75\x6C\x6C\x20\x61\x6E\x64\x2F\x6F\x72\x20\x70\x75\x73\x68\x29\x20\x77\x69\x74\x68\x20\x74\x68\x61\x74\x20\x73\x6F\x75\x72\x63\x65\x2E\n\n\x41\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x69\x74\x20\x69\x73\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6E\x67\x20\x74\x6F\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x6C\x69\x6E\x6B\x20\x74\x6F\x3A\n\n\x2D\x20\x5B\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x31\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2E\n\x2D\x20\x5B\x42\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x2D\x20\x5B\x43\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x41\x6E\x79\x20\x63\x6F\x6D\x62\x69\x6E\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2C\x20\x62\x61\x6E\x6B\x69\x6E\x67\x2C\x20\x61\x6E\x64\x20\x63\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x69\x73\x20\x61\x6C\x6C\x6F\x77\x65\x64\x2E\n\n\x42\x65\x66\x6F\x72\x65\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x61\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x70\x75\x6C\x6C\x20\x6F\x72\x20\x70\x75\x73\x68\x20\x64\x61\x74\x61\x2C\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x6D\x75\x73\x74\x20\x67\x72\x61\x6E\x74\x20\x79\x6F\x75\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x64\x61\x74\x61\x20\x62\x79\x20\x5B\x6C\x69\x6E\x6B\x69\x6E\x67\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x75\x74\x68\x2D\x66\x6C\x6F\x77\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E" type: object properties: id: @@ -84127,9 +10972,6 @@ components: 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: - $ref: '#/components/schemas/Branding/properties/sourceId' - sourceType: - $ref: '#/components/schemas/Integration/definitions/sourceType' type: string format: uuid example: 35b92968-9851-4095-ad60-395c95cbcba4 @@ -84158,10 +11000,10 @@ components: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' nullable: true created: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' dataConnectionErrors: type: array nullable: true @@ -84170,7 +11012,8 @@ components: connectionInfo: type: object nullable: true - additionalProperties: true + additionalProperties: + type: string additionalProperties: false required: - id @@ -84206,7 +11049,7 @@ components: type: string description: A message about a error returned by Codat. erroredOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' status: title: Error status description: The current status of a transient error. Null statuses indicate that the error is not transient. @@ -84218,7 +11061,7 @@ components: resolvedOnUtc: description: The datetime in Utc that the error was resolved. nullable: true - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' dataConnectionSourceType: title: Source Type description: The type of platform of the connection. @@ -84243,29 +11086,6 @@ components: lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking - ConnectionManagementAccessToken: - title: Access token - type: object - properties: - accessToken: - type: string - nullable: false - description: Access token that allows SMBs to manage connections that have access to their data. - example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c - ConnectionManagementAllowedOrigins: - title: Allowed origins - type: object - properties: - allowedOrigins: - type: array - description: 'An array of allowed origins (i.e. your domains) to permit cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).n resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).' - items: - type: string - format: uri - description: A domain you want to allow CORS with Codat. - example: - allowedOrigins: - - 'https://www.bank-of-dave.com' Connections: title: Connections x-internal: true @@ -84277,383 +11097,215 @@ components: items: $ref: '#/components/schemas/Connection' - $ref: '#/components/schemas/PagingInfo' - ConnectionWebhook: - title: Connection webhook - DataIntegrityDetail: - title: Data integrity detail + CreateAccountResponse: + title: Create account response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Account' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + CreateAdjustmentRequest: + title: Create adjustment request + x-internal: true + type: array + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/AdjustmentTransactionRequest' + CreateBankAccountResponse: + title: Create bank account response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/BankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + CreateCustomerResponse: + title: Create customer response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Customer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + CreateExpenseRequest: + title: Create expense request + x-internal: true + type: array + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/ExpenseTransaction' + CreateExpenseResponse: + title: Create expense response + x-internal: true type: object properties: - id: + syncId: type: string + example: cd937d46-8e41-43a9-9477-a79158ffd98a format: uuid - example: ba29118f-5406-4e59-b05c-ba307ca38d01 - description: Unique identifier of the event. - eventType: - type: string - description: The type of event. - examples: - - connection.created - - connection.connected - - connection.disconnected - - connection.reconnected - - connection.deleted - - connection.failed - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ConnectionWebhook/definitions/connectionWebhookPayload' - definitions: - connectionWebhookPayload: - title: Connection webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - connection: - $ref: '#/components/schemas/Connection' - CreateApiKey: - title: Create API key - description: Details about the newly created API key. + description: Unique id of sync created + CreateReimbursableExpenseResponse: + title: Create reimbursable expense response x-internal: true type: object properties: - name: - $ref: '#/components/schemas/ApiKeyDetails/allOf/0/properties/name' - CustomDataTypeConfiguration: - title: Custom data type configuration - type: object - description: Client's configuration details for a specific custom data type and platform pair. - properties: - dataSource: - type: string - description: Underlying endpoint of the source platform that will serve as a data source for the custom data type. This value is not validated by Codat. - requiredData: - type: object - description: Properties required to be fetched from the underlying platform for the custom data type that is being configured. This value is not validated by Codat. - additionalProperties: - type: string - description: The client's defined name for the property with the value being the source system's property name which the mapping is targeting. - keyBy: - type: array - description: An array of properties from the source system that can be used to uniquely identify the records returned for the custom data type. This value is not validated by Codat. - items: - type: string - minLength: 1 - sourceModifiedDate: - type: array - nullable: true - items: - type: string - description: Property in the source platform nominated by the client that defines the date when a record was last modified there. This value is not validated by Codat. - examples: - - dataSource: api/purchaseOrders?$filter=currencyCode eq 'NOK' - requiredData: - currencyCode: '$[*].currencyCode' - id: '$[*].id' - number: '$[*].number' - orderDate: '$[*].orderDate' - totalAmountExcludingTax: '$[*].totalAmountExcludingTax' - totalTaxAmount: '$[*].totalTaxAmount' - vendorName: '$[*].number' - keyBy: - - '$[*].id' - sourceModifiedDate: - - '$[*].lastModifiedDateTime' - CustomDataTypeRecords: - title: Custom data type records - type: object - description: Resulting records pulled from the source platform for a specific custom data type. - properties: - results: - type: array - items: - $ref: '#/components/schemas/CustomDataTypeRecords/definitions/customDataTypeRecord' - pageNumber: - $ref: '#/components/schemas/PagingInfo/properties/pageNumber' - pageSize: - $ref: '#/components/schemas/PagingInfo/properties/pageSize' - totalResults: - $ref: '#/components/schemas/PagingInfo/properties/totalResults' - definitions: - customDataTypeRecord: - title: Custom data type record - description: ID GUID of the transaction. - type: - type: string - description: The data type of the record. - connectionId: + syncId: type: string + example: cd937d46-8e41-43a9-9477-a79158ffd98a 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 - nullable: false - description: Unique identifier of the record. - content: - type: object - description: Values from the source system for the properties defined in the custom data type configuration. - additionalProperties: - type: object - modifiedDate: - 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. - 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 + description: Unique id of sync created + CreateSupplierResponse: + title: Create supplier response x-internal: true allOf: - type: object properties: - results: - type: array - items: - $ref: '#/components/schemas/DataIntegrityDetail' - - $ref: '#/components/schemas/PagingInfo' - DataIntegrityStatus: - title: Data integrity status + data: + allOf: + - $ref: '#/components/schemas/Supplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + Customer: + title: 'Accounting: Customer' + description: | + ## Overview + + A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). + + Customers' data links to accounts receivable [invoices](https://docs.codat.io/sync-for-expenses-api#/schemas/Invoice). type: object allOf: - - $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' + id: + type: string + description: 'Identifier for the customer, unique to the company in the accounting software.' + customerName: + type: string + nullable: true + description: 'Name of the customer as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the identified customer. + emailAddress: + type: string + nullable: true + description: Email address the customer can be contacted by. + defaultCurrency: + $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' + description: Default currency the transactional data of the customer is recorded in. + phone: + type: string + nullable: true + description: Phone number the customer can be contacted by. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' + contacts: + type: array + nullable: true + description: An array of Contacts. + items: + $ref: '#/components/schemas/Customer/definitions/contact' + registrationNumber: + type: string + nullable: true + description: 'Company number. In the UK, this is typically the Companies House company registration number.' + taxNumber: + type: string + nullable: true + description: Company tax number. + status: + $ref: '#/components/schemas/Customer/definitions/customerStatus' + description: Current state of the customer. + metadata: + $ref: '#/components/schemas/Account/allOf/2/properties/metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/Account/allOf/3' + required: + - status definitions: - dataIntegrityStatusInfo: + accountingCustomerRef: type: object properties: - lastMatched: + id: + minLength: 1 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: + description: '`id` from the Customers data type' + companyName: 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: + nullable: true + description: '`customerName` from the Customer data type' + required: + - id + customerStatus: + description: Status of customer. 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: + - Active + - Archived + contact: type: object properties: - type: + name: 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. + nullable: true + description: Name of a contact for a customer. + email: + type: string + nullable: true + description: Email of a contact for a customer. + phone: + type: array + nullable: true + description: An array of Phone numbers. + items: + $ref: '#/components/schemas/CompanyInformation/properties/phoneNumbers/items' + address: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' + description: An object of Address information. + status: + $ref: '#/components/schemas/Customer/definitions/customerStatus' + modifiedDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + required: + - status + Customers: + title: Customers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Customer' + - $ref: '#/components/schemas/PagingInfo' DataStatus: title: Data status description: Describes the state of data in the Codat cache for a company and data type type: object required: - dataType + - lastSuccessfulSync - currentStatus properties: dataType: @@ -84707,7 +11359,7 @@ components: - commerce-transactions example: invoices lastSuccessfulSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' currentStatus: $ref: '#/components/schemas/PullOperation/properties/status' latestSyncId: @@ -84726,216 +11378,6 @@ components: currentStatus: string latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 - DataStatuses: - 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 - DataType: - x-internal: true - $ref: '#/components/schemas/DataStatus/properties/dataType' - DataTypeWriteWebhook: - title: Write data type 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: - - bills.write.successful - - bills.write.unsuccessful - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/dataTypeWriteWebhookPayload' - definitions: - dataTypeWriteWebhookPayload: - title: Payload - type: object - properties: - id: - type: string - description: Unique identifier of the write request. This is also known as the push operation ID. - type: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/writeType' - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - connectionId: - $ref: '#/components/parameters/connectionId/schema' - requestedOnDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the write request was submitted. - completedOnDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the write request completed. - status: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/writeStatus' - record: - $ref: '#/components/schemas/DataTypeWriteWebhook/definitions/dataTypeWriteWebhookRecord' - nullable: true - attachmentId: - type: string - nullable: true - description: 'Unique identifier for the uploaded attachment, null if no attachment uploaded.' - dataTypeWriteWebhookRecord: - type: object - properties: - id: - type: string - description: 'The unique identifier of the data type created, updated, deleted, or had an attachment uploaded in the accounting platform.' - writeType: - title: Write type - description: Type of write request. - type: string - enum: - - Create - - Update - - Delete - - UploadAttachment - writeStatus: - title: Write request status - type: string - enum: - - Pending - - Failed - - Success - - TimedOut - description: 'The current status of the write request, which is the same as the push operation status.' DataStatusResponse: x-internal: true title: Data status response @@ -84944,535 +11386,7 @@ components: $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:00.000Z - - 2022-10-23T00:00:00.000Z - description: "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." - - '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 - 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: - dataSource: - type: object - properties: - 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 - 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' - 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: - 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: - 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: 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: - lendingCustomerRef: - type: object - properties: - id: - minLength: 1 - type: string - description: '`id` from the Customers data type.' - customerName: - type: string - nullable: true - 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' - paymentType: - type: string - 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 - items: - $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/bankingTransactionRef' - bankingTransactionRef: - title: Banking transaction reference - type: object - properties: - id: - 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: - 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' + $ref: '#/components/schemas/DataStatus/properties/dataType' ErrorMessage: title: Error message type: object @@ -85531,498 +11445,287 @@ components: type: string nullable: true description: Name of validator. - Integration: - title: Integration - description: An integration that Codat supports - examples: - - key: gbol - logoUrl: 'http://example.com' - name: Xero - enabled: true - sourceId: accounting - sourceType: 8193a927-ab7a-45a3-9dc2-d357a4932dfe - integrationId: 497a18ca-284e-40c0-985d-f72be35d468e - isOfflineConnector: true - isBeta: true - dataProvidedBy: string - datatypeFeatures: - - datatype: invoices - supportedFeatures: - - featureType: get - featureState: release - type: object - properties: - key: - $ref: '#/components/parameters/platformKey/schema' - logoUrl: - type: string - format: uri - description: Static url for integration's logo. - name: - type: string - example: Xero - description: Name of integration. - enabled: - type: boolean - description: Whether this integration is enabled for your customers to use. - sourceId: - $ref: '#/components/schemas/Branding/properties/sourceId' - sourceType: - $ref: '#/components/schemas/Integration/definitions/sourceType' - integrationId: - $ref: '#/components/schemas/Connection/properties/integrationId' - isOfflineConnector: - type: boolean - description: '`True` if the integration is to an application installed and run locally on an SMBs computer.' - isBeta: - type: boolean - description: '`True` if the integration is currently in beta release.' - dataProvidedBy: - type: string - description: The name of the data provider. - datatypeFeatures: - type: array - items: - $ref: '#/components/schemas/Integration/definitions/dataTypeFeature' - required: - - key - - logoUrl - - name - - enabled - definitions: - sourceType: - title: Source Type - description: The type of platform of the connection. - ExcelStatus: + ExpenseContactRef: type: object - title: Excel status + title: Supplier/customer reference + x-internal: true properties: - 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 - description: The date and time of when a successful request was queued for the most recent report. - success: - type: boolean - 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: Error details in case the report generation request was unsuccessful. - lastInvocationId: + id: type: string - 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: + example: 40e3e57c-2322-4898-966c-ca41adfd23fd + description: Identifier of supplier or customer. + type: type: string + description: The type of contact. + example: Supplier + default: Supplier enum: - - 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 + - Supplier + required: + - id + ExpensesSyncWebhook: + title: Expenses sync webhook type: object properties: - fileName: - type: string - nullable: true - description: The file's name. - displayName: - type: string - nullable: true - description: An optional display name for the file. - sourceType: + id: type: string - nullable: true - description: The source of the file uploaded. - uploaded: - $ref: '#/components/schemas/DateTime' - additionalProperties: false - Files: - title: Files - type: array - items: - $ref: '#/components/schemas/File' - FileUpload: - title: Attachment upload - type: object - x-internal: true - required: - - file - properties: - file: - $ref: '#/components/schemas/FileUpload/definitions/codatFile' - definitions: - codatFile: + format: uuid + example: ba29118f-5406-4e59-b05c-ba307ca38d01 + description: Unique identifier of the event. + eventType: type: string - 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: - date: - type: string - 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' + description: The type of event. + examples: + - expenses.sync.successful + - expenses.sync.unsuccessful + generatedDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/expensesSyncWebhookPayload' definitions: - loanSummaryReportInfo: - title: Loan Summary Report Info - type: object - properties: - 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. urns the YYYY-MM-DD datetime of report generation. - loanRef: - title: Loan Reference + transaction: + title: Transaction 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. - 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: + description: Unique identifier of the transaction. + status: type: string - description: The id of the object being referred to. - dataConnectionId: + enum: + - Unknown + - PushError + - Completed + - Failed + - Pending + description: Status of transaction. + errorMessage: 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: + nullable: true + description: Error message for failed transaction. + expensesSyncWebhookPayload: + title: Expenses sync webhook payload 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' - 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: + referenceCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + syncId: 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 - dataTypeFeature: - title: Data type feature - description: Describes support for a given datatype and associated operations - type: object - properties: - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - supportedFeatures: + description: Unique identifier of the sync. + transactions: type: array items: - $ref: '#/components/schemas/Integration/definitions/supportedFeature' - required: - - datatype - - supportedFeatures - examples: - - datatype: invoices - supportedFeatures: - - featureType: Get - featureState: Release - supportedFeature: + $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/transaction' + ExpenseTransaction: + title: Expense transaction + type: object + properties: + id: + type: string + example: 4d7c6929-7770-412b-91bb-44d3bc71d111 + format: uuid + description: Your unique identifier for the transaction. + type: + type: string + example: Payment + description: The type of transaction. + enum: + - Payment + - Refund + - Reward + - Chargeback + issueDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction was recorded. + currency: + type: string + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + title: Currency rate + type: number + format: decimal + nullable: true + description: "Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.\n\nCurrency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. \n\nIt is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.\n\nWhere the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). \n\nFor accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.\n\n## Examples with base currency of GBP\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **USD** | $20 | 0.781 | £15.62 |\n| **EUR** | €20 | 0.885 | £17.70 |\n| **RUB** | ₽20 | 0.011 | £0.22 |\n\n## Examples with base currency of USD\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **GBP** | £20 | 1.277 | $25.54 |\n| **EUR** | €20 | 1.134 | $22.68 |\n| **RUB** | ₽20 | 0.015 | $0.30 |\n\n\n### Integration-specific details\n\n| Integration | Scenario | System behavior |\n|-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. |" + contactRef: + description: Supplier or customer for the purchase to be associated to. + $ref: '#/components/schemas/ExpenseContactRef' + bankAccountRef: type: object - x-internal: true + title: Bank account reference properties: - featureType: - $ref: '#/components/schemas/Integration/definitions/featureType' - featureState: - $ref: '#/components/schemas/Integration/definitions/featureState' - required: - - featureType - - featureState - featureState: - title: Feature state + id: + type: string + example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea + description: Identifier of the bank account. + reference: type: string - example: Release - description: The current release state of the feature. - enum: - - Release - - Alpha - - Beta - - Deprecated - - NotSupported - - NotImplemented - featureType: + nullable: true + description: User-friendly reference for the expense transaction. + merchantName: type: string - x-internal: true - description: The type of feature. - enum: - - Get - - Post - - Categorization - - Delete - - Put - - GetAsPdf - - DownloadAttachment - - GetAttachment - - GetAttachments - - UploadAttachment - example: Get - Integrations: - title: Integrations - x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Integration' - - $ref: '#/components/schemas/PagingInfo' - - Commerce - description: The integration type begin referred to. - loanSummaryRecordRefType: - title: Record reference type + example: Amazon UK + description: Name of the merchant where the purchase took place + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ExpenseTransactionLine' + notes: type: string - enum: - - accounts - - banking-accounts - - commerce-transactions - description: The datatype being referred to. + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + postAsDraft: + type: boolean + nullable: true + description: 'This optional property, when set to true, posts the transaction to a drafted state. Note that postAsDraft is only supported in Microsoft Dynamics 365 Business Central.' + required: + - id + - type + - issueDate + - currency examples: - - 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 + - id: a44135b0-6882-489a-83fe-a0c57a4afb19 + type: Payment + issueDate: '2024-05-21T00:00:00+00:00' + currency: GBP + currencyRate: 1 + contactRef: + id: '430' + type: Supplier + bankAccountRef: + id: '97' + merchantName: Amazon UK + notes: amazon purchase + lines: + - netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 23_Bills + accountRef: + id: '35' + trackingRefs: + - id: DEPARTMENT_3 + - dataType: trackingCategories + invoiceTo: + id: '504' + type: customer + ExpenseTransactionLine: + x-internal: true + title: Expense transaction line type: object + x-examples: + ExpenseTransactionLine: + netAmount: 100 + taxAmount: 20 + taxRateRef: + id: 08d37c46-8d5d-441b-8bad-76286c43047e + accountRef: + id: 16989b16-96d4-401a-9054-f5c620c655a6 + trackingRefs: + - id: e9a1b63d-9ff0-40e7-8038-016354b987e6 + invoiceTo: + id: 80000002-1674552702 + type: customer properties: - reportInfo: - $ref: '#/components/schemas/LoanTransactions/definitions/loanTransactionsReportInfo' - reportItems: + netAmount: + type: number + format: decimal + example: 100 + description: 'Amount of the line, exclusive of tax.' + taxAmount: + type: number + format: decimal + example: 20 + description: Amount of tax for the line. + taxRateRef: + $ref: '#/components/schemas/RecordRef' + accountRef: + description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. + $ref: '#/components/schemas/RecordRef' + itemRef: + $ref: '#/components/schemas/ItemRef' + trackingRefs: type: array - description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + minItems: 1 + maxItems: 10 + nullable: true 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 + $ref: '#/components/schemas/TrackingRef' + invoiceTo: + $ref: '#/components/schemas/InvoiceTo' + required: + - netAmount + IntegrationType: + title: Integration type + x-internal: true + type: string + description: Type of transaction that has been processed e.g. Expense or Bank Feed. + enum: + - expenses + - bankfeeds + default: expenses + example: expenses + nullable: true + InvoiceTo: + title: Billable customer reference + x-internal: true type: object + nullable: true + description: Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. + properties: + id: + type: string + example: 80000002-1674552702 + description: identifier of customer. + type: + type: string + example: customer + description: The type of contact. + enum: + - customer + ItemRef: x-internal: true + type: object + title: Item reference + nullable: true properties: - isDeleted: - type: boolean - description: Indicates whether the record has been deleted in the third-party system this record originated from. + id: + type: string + example: 80000002-1675158984 + description: 'Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both.' + MappingOptions: + title: Mapping options + type: object + additionalProperties: false + x-examples: {} + properties: + expenseProvider: + type: string + description: Name of the expense integration. + example: Partner Expense + nullable: true + accounts: + type: array + description: Array of available accounts for mapping. + nullable: true + items: + $ref: '#/components/schemas/AccountMappingInfo' + trackingCategories: + type: array + description: Array of available tracking categories for mapping. + nullable: true + items: + $ref: '#/components/schemas/TrackingCategoryMappingInfo' + taxRates: + type: array + description: Array of available tax rates for mapping. nullable: true + items: + $ref: '#/components/schemas/TaxRateMappingInfo' PagingInfo: type: object title: Pagination information @@ -86083,113 +11786,6 @@ components: href: '/companies/{id}/data/{dataType}' current: href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' - Profile: - title: Profile - description: Describes your Codat client instance - examples: - - name: Bob's Burgers - logoUrl: 'https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png' - iconUrl: 'https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico' - redirectUrl: 'https://bobs-burgers.{countrySuffix}/{companyId}' - whiteListUrls: - - 'https://bobs-burgers.com' - - 'https://bobs-burgers.co.uk' - confirmCompanyName: true - type: object - properties: - name: - type: string - example: Bob's Burgers - description: The name given to the instance. - logoUrl: - type: string - description: Static url to your organization's logo. - example: 'https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png' - iconUrl: - type: string - description: Static url to your organization's icon. - example: 'https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico' - redirectUrl: - type: string - example: 'https://bobs-burgers.{countrySuffix}/{companyId}' - description: 'The redirect URL pasted on to the SMB once Codat''s [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB.' - whiteListUrls: - type: array - description: A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. - items: - type: string - format: uri - example: 'https://bobs-burgers.com' - description: A url that is allowed to communicate with Codat. - apiKey: - type: string - deprecated: true - example: sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB - description: The API key for this Codat instance. - confirmCompanyName: - type: boolean - deprecated: true - description: '`True` if the company name has been confirmed.' - required: - - name - - redirectUrl - x-stoplight: - id: b1fyq05edangf - 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: - 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: |- @@ -86253,9 +11849,9 @@ components: nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' completed: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' progress: type: integer description: An integer signifying the progress of the pull operation. @@ -86320,10 +11916,10 @@ components: dataConnectionKey: $ref: '#/components/parameters/connectionId/schema' requestedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' description: The datetime when the push was requested. completedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' description: 'The datetime when the push was completed, null if Pending.' timeoutInMinutes: type: integer @@ -86555,978 +12151,878 @@ components: title: Push Option Choice type: object properties: - value: - type: string - minLength: 1 - description: Allowed value for field. - type: - $ref: '#/components/schemas/PushOption/definitions/pushOptionType' - displayName: - $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName' - description: - $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' - required: - $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' - ReadCompletedWebhook: - title: Read completed webhook - ReportLine: + value: + type: string + minLength: 1 + description: Allowed value for field. + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName' + description: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' + required: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + RecordRef: + x-internal: true + type: object + title: Record reference + properties: + id: + type: string + example: 40e3e57c-2322-4898-966c-ca41adfd23fd + description: Identifier of linked reference from mapping options. + ReimbursableExpenseTransactionLine: + x-internal: true + title: Reimbursable expense transaction line + type: object + properties: + description: + type: string + example: 2-night hotel stay + description: line description + netAmount: + type: number + format: decimal + example: 100 + description: 'Amount of the line, exclusive of tax.' + taxAmount: + type: number + format: decimal + example: 20 + description: Amount of tax for the line. + taxRateRef: + $ref: '#/components/schemas/RecordRef' + accountRef: + description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. + $ref: '#/components/schemas/RecordRef' + itemRef: + $ref: '#/components/schemas/ItemRef' + trackingRefs: + type: array + minItems: 1 + maxItems: 10 + nullable: true + items: + $ref: '#/components/schemas/TrackingRef' + invoiceTo: + $ref: '#/components/schemas/InvoiceTo' + required: + - netAmount + ReimbursableExpenseTransactionRequest: + title: Reimbursable expense transaction request + type: array + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/ReimbursableExpenseTransactionRequest/definitions/reimbursableExpenseTransaction' + definitions: + reimbursableExpenseTransaction: + title: Reimbursable expense transaction + type: object + properties: + id: + type: string + example: 4d7c6929-7770-412b-91bb-44d3bc71d111 + format: uuid + description: Your unique identifier for the transaction. + reference: + type: string + nullable: true + description: User-friendly reference for the reimbursable expense. + contactRef: + $ref: '#/components/schemas/ReimbursementContactRef' + apAccountRef: + $ref: '#/components/schemas/apAccountRef' + issueDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction was recorded. + dueDate: + description: Date the supplier is due to be paid. + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + currency: + type: string + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + notes: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' + required: + - id + - contactRef + - issueDate + - dueDate + - currency + ReimbursementContactRef: + type: object + title: Contact reference + x-internal: true + properties: + id: + type: string + example: 40e3e57c-2322-4898-966c-ca41adfd23fd + description: Identifier of contact. + required: + - id + SupplementalData: + title: Supplemental data + type: object + x-internal: true + description: "Supplemental data is additional data you can include in our standard data types. \n\nIt is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data." + properties: + content: + type: object + additionalProperties: + type: object + additionalProperties: true + nullable: true + Supplier: + title: 'Accounting: Supplier' + description: |- + ## Overview + + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: + type: string + nullable: true + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the supplier. + emailAddress: + type: string + nullable: true + description: Email address that the supplier may be contacted on. + phone: + type: string + nullable: true + description: Phone number that the supplier may be contacted on. + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' + registrationNumber: + type: string + nullable: true + description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' + taxNumber: + type: string + nullable: true + description: Supplier's company tax number. + status: + $ref: '#/components/schemas/Supplier/definitions/supplierStatus' + defaultCurrency: + type: string + nullable: true + description: Default currency the supplier's transactional data is recorded in. + metadata: + $ref: '#/components/schemas/Account/allOf/2/properties/metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/Account/allOf/3' + required: + - status + definitions: + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. + type: object + properties: + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. + type: string + enum: + - Unknown + - Active + - Archived + examples: + - id: C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F + supplierName: Kelly's Industrial Supplies + contactName: Kelly's Industrial Supplies + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + line2: Bakersfield Industrial Estate + city: Bakersfield + region: California + country: USA + postalcode: '93308' + registrationNumber: string + taxNumber: string + status: Unknown + defaultCurrency: string + metadata: + isDeleted: true + supplementalData: + content: + property1: + property1: null + property2: null + property2: + property1: null + property2: null + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + Suppliers: + title: Suppliers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Supplier' + - $ref: '#/components/schemas/PagingInfo' + SyncCompleteWebhook: + title: Sync complete webhook + x-internal: true + description: Webhook request body used to notify that a sync has completed. + type: object + properties: + ClientId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' + ClientName: + $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' + CompanyId: + $ref: '#/components/parameters/companyId/schema' + RuleId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' + RuleType: + $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' + AlertId: + $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' + Message: + $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' + Data: + $ref: '#/components/schemas/SyncCompleteWebhook/definitions/SyncCompleteWebhookData' + definitions: + SyncCompleteWebhookData: + type: object + title: Sync complete webhook data + properties: + syncId: + $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncId' + syncType: + $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncType' + examples: + - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e + ClientName: Expense Sync + CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 + AlertId: 33a4f8e9-09ae-4334-9b00-7bbe83024672 + RuleId: 5c27631d-3b63-4b50-8228-ee502fd113eb + RuleType: Sync Completed + Message: Sync 321363b4-efa9-4fbc-b71c-0b58d62f3248 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense completed successfully. + Data: + syncId: 321363b4-efa9-4fbc-b71c-0b58d62f3248 + syncType: Expense + SyncFailedWebhook: + title: Sync failed webhook x-internal: true + description: Webhook request body used to notify that a sync has failed. type: object - title: 'Accounting: Report line' properties: - accountId: + ClientId: + title: Client ID type: string - nullable: true - description: 'Identifier for the account, unique for the company in the accounting software.' - name: + format: uuid + description: Unique identifier for your client in Codat. + ClientName: 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: + description: Name of your client in Codat. + CompanyId: + $ref: '#/components/parameters/companyId/schema' + RuleId: type: string format: uuid - example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - description: Unique identifier of the event. - eventType: + description: Unique identifier for the rule. + deprecated: true + RuleType: type: string - description: The type of event. - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/readCompletedWebhookPayload' + x-stoplight: + id: 34d52a089f08a + description: The type of rule. + AlertId: + type: string + format: uuid + description: Unique identifier of the webhook event. + Message: + type: string + description: A human-readable message about the webhook. + Data: + $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData' definitions: - readCompletedWebhookPayload: - title: Read result webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - modifiedFromDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC when the data types were last fetched and input into Codat's cache. - nullable: true - dataTypes: - type: array - items: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/dataTypeReadSummary' - dataTypeReadSummary: - title: Summary of data type reads - type: object - properties: - connectionId: - $ref: '#/components/parameters/connectionId/schema' - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - recordsModified: - type: boolean - example: false - description: '`True` if records have been created, updated or deleted in Codat''s cache.' - status: - $ref: '#/components/schemas/PullOperation/properties/status' - issues: - type: array - nullable: true - description: A array of issues encountered during a data read. - items: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/issue' - customProductReadCompleteWebhook: - title: Read completed webhook - type: object - properties: - id: - $ref: '#/components/schemas/ReadCompletedWebhook/properties/id' - eventType: - $ref: '#/components/schemas/ReadCompletedWebhook/properties/eventType' - generatedDate: - $ref: '#/components/schemas/ReadCompletedWebhook/properties/generatedDate' - payload: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/customProductReadCompleteWebhookPayload' - customProductReadCompleteWebhookPayload: - title: Read result webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - modifiedFromDate: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/readCompletedWebhookPayload/properties/modifiedFromDate' - dataTypes: - type: array - items: - type: object - title: Summary of data type reads - properties: - connectionId: - $ref: '#/components/parameters/connectionId/schema' - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - recordsModified: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/dataTypeReadSummary/properties/recordsModified' - status: - $ref: '#/components/schemas/PullOperation/properties/status' - issues: - type: array - nullable: true - description: A array of issues encountered during a data read. - items: - $ref: '#/components/schemas/ReadCompletedWebhook/definitions/issue' - issue: - title: Issue + SyncFailedWebhookData: type: object - description: Details of a problem encountered during a data read. + title: Sync failed webhook data properties: - type: + syncId: type: string - description: The type of issue. - example: warning.validation - message: + format: uuid + example: a9367074-b5c3-42c4-9be4-be129f43577e + description: Unique identifier for the failed sync. + syncType: type: string - description: A message describing the issue. - example: Something doesn't look right about these accounts from Xero. You can see more information in the logs. - links: - title: Links - type: object - properties: - logs: - type: string - description: 'A link to the validation logs, providing details on any errors or warnings encountered.' - example: 'https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation' - portal: - type: string - description: A link to the company's past data read history in the Codat portal. - example: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history' - readMore: - type: string - description: A link to Codat's documentation with additional information on how to troubleshoot this issue. - example: 'https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation' - SupplementalDataConfiguration: - description: '' - title: Supplemental data configuration - type: object - properties: - supplementalDataConfig: - type: object - additionalProperties: - type: object - title: Supplemental data source configuration - description: The client's defined name for the object. - properties: - dataSource: - type: string - description: 'The underlying endpoint of the source system which the configuration is targeting. ' - pullData: - type: object - description: The additional properties that are required when pulling records. - additionalProperties: - type: string - description: The client's defined name for the property with the value being the source system's property name which the mapping is targeting. - pushData: - type: object - description: The additional properties that are required to create and/or update records. - additionalProperties: - type: string - description: The client's defined name for the property with the value being the source system's property name which the mapping is targeting. - examples: - - supplementalDataConfig: - orders-supplemental-data: - dataSource: /orders - pullData: - orderNumber: order_num - pushData: - orderNumber: order_num - SyncSetting: - title: SyncSetting - description: 'Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued.' + description: The type of sync being performed. + FailureStage: + type: string + description: The stage of the job the sync failed. examples: - - dataType: invoices - fetchOnFirstLink: true - syncSchedule: 24 - syncOrder: 0 - syncFromUtc: '2020-01-01T12:00:00.000Z' - syncFromWindow: 24 - monthsToSync: 24 - isLocked: true + - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e + ClientName: Expense Sync + CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 + RuleId: 289c80dc-2aee-4b71-afff-9acd8d051080 + RuleType: Sync Failed + AlertId: 72c1103b-7f17-4a3a-8db5-67c2d360a516 + Message: Sync 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense has failed at step Pushing. + Data: + syncId: 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 + syncType: Expense + FailureStage: Pushing + SyncInitiated: + title: Sync initiated type: object properties: - dataType: - $ref: '#/components/schemas/DataStatus/properties/dataType' - fetchOnFirstLink: - type: boolean - description: Whether this data type should be queued after a company has authorized a connection. - syncSchedule: - type: integer - example: 24 - description: Number of hours after which this data type should be refreshed. - syncOrder: - type: integer - description: The sync in which data types are queued for a sync. - syncFromUtc: - $ref: '#/components/schemas/DateTime' - description: Date from which data should be fetched. Set this *or* `syncFromWindow`. - syncFromWindow: - type: integer - example: 24 - description: Number of months of data to be fetched. Set this *or* `syncFromUTC`. - monthsToSync: - type: integer - example: 24 - description: 'Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only.' - isLocked: - type: boolean - description: '`True` if the [sync setting](https://docs.codat.io/knowledge-base/advanced-sync-settings) is locked.' - required: - - dataType - - fetchOnFirstLink - - syncSchedule - - syncOrder - SyncSettings: - title: Sync settings + syncId: + type: string + format: uuid + description: Unique identifier for the sync initiated. + additionalProperties: false + TaxRateMappingInfo: + title: Tax rate mapping info x-internal: true type: object + additionalProperties: false + x-examples: + UK Tax Rate: + id: 23_Bills + name: 20% Bill tax Bills + code: 20% Bill tax + effectiveTaxRate: 20 + totalTaxRate: 20 + validTransactionTypes: + - Payment + - Reward properties: - clientId: - $ref: '#/components/schemas/ClientId' - settings: - type: array - items: - $ref: '#/components/schemas/SyncSetting' - overridesDefaults: - type: boolean - description: 'Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).' - UpdateConnectionStatus: - title: Update connection + id: + type: string + description: Unique identifier of tax rate. + example: 23_Bills + nullable: false + name: + type: string + description: Name of the tax rate in the accounting software. + example: 20% Bill tax Bills + nullable: false + code: + type: string + description: Code for the tax rate from the accounting software. + example: 20% Bill tax + nullable: true + effectiveTaxRate: + type: number + format: decimal + description: Effective tax rate. + example: 20 + totalTaxRate: + type: number + format: decimal + description: Total (not compounded) sum of the components of a tax rate. + example: 20 + validTransactionTypes: + $ref: '#/components/schemas/validTransactionTypes' + description: Supported transaction types for the tax rate. + TrackingCategoryMappingInfo: + title: Tracking category mapping info x-internal: true type: object - properties: - status: - $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' - description: The current authorization status of the data connection. - nullable: true additionalProperties: false - ValidationResult: - title: Validation result - type: object - properties: - errors: - type: array - items: - $ref: '#/components/schemas/ValidationResult/definitions/validationItem' - warnings: - type: array - items: - $ref: '#/components/schemas/ValidationResult/definitions/validationItem' - definitions: - validationItem: - title: Validation item - type: object - properties: - ruleId: - type: string - description: The unique identifier of the rule that wasn't met. - itemId: - type: string - description: The unique identifier of the item that was validated. - message: - type: string - description: The message that describes the validation warning or error. - validatorName: - type: string - description: The name of the validator that was used to validate the item. - WebhookConsumer: - title: Webhook consumer - type: object - description: "\uFEFF\x41\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x63\x6F\x6E\x73\x75\x6D\x65\x72\x20\x69\x73\x20\x61\x6E\x20\x48\x54\x54\x50\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x68\x61\x74\x20\x64\x65\x76\x65\x6C\x6F\x70\x65\x72\x73\x20\x63\x61\x6E\x20\x63\x6F\x6E\x66\x69\x67\x75\x72\x65\x20\x74\x6F\x20\x73\x75\x62\x73\x63\x72\x69\x62\x65\x20\x74\x6F\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x73\x75\x70\x70\x6F\x72\x74\x65\x64\x20\x65\x76\x65\x6E\x74\x20\x74\x79\x70\x65\x73\x2E\n\n\x53\x65\x65\x20\x6F\x75\x72\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x64\x65\x74\x61\x69\x6C\x73\x20\x6F\x6E\x20\x5B\x43\x6F\x64\x61\x74\x27\x73\x20\x77\x65\x62\x68\x6F\x6F\x6B\x20\x73\x65\x72\x76\x69\x63\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\x77\x65\x62\x68\x6F\x6F\x6B\x73\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E\n" + x-examples: + Tracking Category with parentId: + id: DEPARTMENT_1 + name: TestLocation + hasChildren: false + parentId: DEPARTMENTS + Parent Tracking Category: + id: DEPARTMENTS + name: Departments + hasChildren: true properties: id: type: string - format: uuid - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for the webhook consumer. - url: + description: Unique identifier of the tracking category. + example: DEPARTMENT_2 + nullable: false + name: type: string - format: uri - description: The URL that will consume webhook events dispatched by Codat. - disabled: + description: Name of the tracking category as it appears in the accounting software. + example: New York + nullable: false + hasChildren: type: boolean - description: Flag that enables or disables the endpoint from receiving events. Disabled when set to `true`. - nullable: true - default: false - eventTypes: - type: array - description: An array of event types the webhook consumer subscribes to. - items: - type: string - companyTags: - type: array + description: Boolean of whether the tracking category has child categories. + parentId: + type: string + description: ID of the parent tracking category + example: DEPARTMENTS nullable: true - description: 'Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format `tagKey:tagValue`.' - items: - type: string - maxLength: 128 - maxItems: 10 - definitions: - webhookConsumerPrototype: - title: Create webhook consumer - type: object - properties: - url: - $ref: '#/components/schemas/WebhookConsumer/properties/url' - disabled: - $ref: '#/components/schemas/WebhookConsumer/properties/disabled' - eventTypes: - $ref: '#/components/schemas/WebhookConsumer/properties/eventTypes' - companyTags: - $ref: '#/components/schemas/WebhookConsumer/properties/companyTags' - webhookConsumers: - title: Webhook consumers - type: object - properties: - results: - type: array - maxItems: 50 - items: - $ref: '#/components/schemas/WebhookConsumer' - WebhookZapierKey: - title: Zapier integration key + TrackingRef: type: object + title: Tracking reference + x-internal: true properties: - key: - type: string - description: Integration key used to authorize Zapier's HTTP requests with Codat. - example: sk_integ_WM4dfoK1nKZnDE_kceze6hWDjbRwOZwG.us - examples: - - key: sk_integ_WM4dfoK1nKZnDE_kceze6hWDjbRwOZwG.us - responses: - Bad-Request: - description: Unique identifier of the report - example: 52c0f26b-051a-43ff-b02a-258eec67f5ef - status: + id: type: string - enum: - - InProgress - - Complete - - Error - description: The status of the report generation. - type: + example: e9a1b63d-9ff0-40e7-8038-016354b987e6 + description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. + dataType: type: string + example: trackingCategories + default: trackingCategories + description: The type of the linked reference enum: - - 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) + - trackingCategories + - customers + TrackingRefAdjustmentTransaction: type: object - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false + title: Tracking reference + x-internal: true properties: id: type: string - description: Unique ID for the bank account. - accountName: - type: string - nullable: true - description: The bank account name. - accountType: - type: string - nullable: true - description: The type of bank account e.g. Credit. - accountNumber: + example: e9a1b63d-9ff0-40e7-8038-016354b987e6 + description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. + dataType: type: string - nullable: true - description: The account number. - sortCode: + example: trackingCategories + default: trackingCategories + description: The type of the linked reference + enum: + - trackingCategories + - customers + - suppliers + Transaction: + title: Transaction + type: object + additionalProperties: false + properties: + transactionId: type: string + description: Your unique idenfier of the transaction. + example: aa02271d-ed5f-47f5-be76-778d5905225a nullable: true - description: The sort code. - currency: - title: Currency - x-internal: true + status: + $ref: '#/components/schemas/TransactionStatus' + message: type: string - description: "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system." - format: ISO4217 - examples: - - GBP - - USD - - EUR - balance: - type: number - format: decimal + description: Metadata such as validation errors or the resulting record created in the accounting software. nullable: true - description: The latest balance for the bank account. - modifiedDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The last date the bank account was modified. - status: + integrationType: + $ref: '#/components/schemas/IntegrationType' + x-examples: + Successful Transaction: + transactionId: 8fdba4ed-e327-4925-be1a-b7a2b04627f7 + status: Completed + integrationType: expense + Unsuccessful Transaction: + transactionId: 3d694cd1-4cd9-4136-91db-32408195c6fc + status: ValidationError + message: The line item total -208.10((-195.01 + -1.09) + (-10.01 + -1.99)) must equal the transaction total -1.1 + integrationType: string + TransactionResponse: + title: Transaction response + x-internal: true + type: array + items: + $ref: '#/components/schemas/Transaction' + Transactions: + title: Transactions + x-internal: true + additionalProperties: false + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Transaction' + - $ref: '#/components/schemas/PagingInfo' + x-examples: + Example 1: + results: + - transactionId: aa02271d-ed5f-47f5-be76-778d5905225a + status: Completed + integrationType: expenses + - transactionId: 730177a2-8505-410a-9ebc-c2dd52e4bea9 + status: Completed + integrationType: expenses + pageNumber: 1 + pageSize: 100 + totalResults: 2 + links: + self: + href: string + current: + href: string + TransactionStatus: + title: Transaction status + x-internal: true + type: string + description: Status of the transaction. + enum: + - Unknown + - Pending + - ValidationError + - Completed + - PushError + example: Completed + nullable: true + TransferTransactionRequest: + title: Transfer + type: object + properties: + description: type: string - nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - required: - - id - definitions: - sourceAccountPrototype: - title: Source account (v1) + description: 'Any private, company notes about the transaction.' + example: Transfer from bank account Y to bank account Z + date: + allOf: + - description: Date of the transfer transaction as recorded in the accounting software. + - title: Date time + type: string + examples: + - 2022-10-23T00:00:00.000Z + - 2022-10-23T00:00:00.000Z + description: "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." + from: type: object properties: - id: - $ref: '#/components/schemas/SourceAccount/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccount/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccount/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccount/properties/accountNumber' - sortCode: - $ref: '#/components/schemas/SourceAccount/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - $ref: '#/components/schemas/SourceAccount/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccount/properties/modifiedDate' + accountRef: + type: object + title: Account reference + description: Reference of the account you are transferring money from. + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + required: + - id + amount: + type: number + format: decimal + description: Amount that has been transferred from the account in the native currency of the account. required: - - id - sourceAccounts: - title: Source accounts - type: array - items: - $ref: '#/components/schemas/SourceAccount' - examples: - - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - - id: acc-003 - accountName: account-095 - sortCode: '123456' - accountType: Credit - accountNumber: '12345671' - currency: USD - balance: 0 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - SourceAccountV2: - title: Source account (v2) + - accountRef + - amount + to: + type: object + properties: + accountRef: + type: object + title: Account reference + description: Reference of the account you are transferring money to. + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + required: + - id + amount: + type: number + format: decimal + description: Amount that has been transferred to the account in the native currency of the account. + required: + - accountRef + - amount + required: + - date + - from + - to + TransferTransactionResponse: + title: Create transfer response + x-internal: true type: object - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false properties: - id: - type: string - description: Unique ID for the bank account. - accountName: + syncId: type: string - description: The bank account name. - accountType: + example: cd937d46-8e41-43a9-9477-a79158ffd98a + format: uuid + description: Unique id of sync created + UpdateCustomerResponse: + title: Update customer response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Customer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + UpdateExpenseRequest: + title: Updating expense transaction request + type: object + properties: + type: type: string - description: 'The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.' + example: Payment + description: The type of transaction. enum: - - checking - - savings - - loan - - creditCard - - prepaidCard - accountNumber: - type: string - description: The account number. - sortCode: + - Payment + - Refund + - Reward + - Chargeback + issueDate: type: string - nullable: true - description: The sort code. - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' + description: Date the transaction was recorded. + example: '2022-06-28T00:00:00.000Z' currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - type: number - format: decimal - description: The latest balance for the bank account. - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' - modifiedDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The last date the bank account was modified. - status: - type: string - nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - nullable: true - title: Date type: string - example: '2022-10-23' - description: |- - In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example: - ``` - 2020-10-08 - ``` - required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance - definitions: - sourceAccountV2Prototype: - title: Source account (v2) + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + contactRef: + description: Supplier or Customer for the purchase to be associated to. + $ref: '#/components/schemas/ExpenseContactRef' + bankAccountRef: type: object + title: Bank account reference properties: id: - $ref: '#/components/schemas/SourceAccountV2/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccountV2/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccountV2/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccountV2/properties/accountNumber' - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' - sortCode: - $ref: '#/components/schemas/SourceAccountV2/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - $ref: '#/components/schemas/SourceAccountV2/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccountV2/properties/modifiedDate' - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' - required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance - accountInfo: - title: Account Info - type: object - nullable: true - properties: - description: type: string - nullable: true - description: Description of the account. - nickname: - type: string - nullable: true - description: Name given to the account by the user. Used in UIs to assist in account selection. - accountOpenDate: - $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' - nullable: true - description: Date when the account was opened or created at the provider - availableBalance: - type: number - format: decimal - nullable: true - description: Balance of funds available for use. This includes pending activity. - sourceAccounts: - title: Source accounts + example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea + description: Identifier of the bank account. + merchantName: + type: string + description: Name of the merchant where the purchase took place + example: Amazon UK + lines: type: array + description: Array of transaction lines. items: - $ref: '#/components/schemas/SourceAccountV2' - routingInfo: - title: Routing Info - type: object - description: Routing information for the bank. This does not include account number. - properties: - bankCode: - type: string - nullable: true - description: The numeric identifier of the routing number - type: - type: string - nullable: true - default: bankcode - enum: - - rtn - - aba - - swift - - bsb - - iban - - nz2 - - trno - - sortcode - - blz - - ifsc - - bankcode - - apca - - clabe - description: The type of routing number. - examples: - - id: acc-001 - accountName: account-081 - accountType: checking - accountNumber: '12345670' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 99.99 - accountInfo: - description: account description 1 - nickname: account 123 - accountOpenDate: '2023-05-06' - availableBalance: 10 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - - id: acc-002 - accountName: account-083 - accountType: savings - accountNumber: '23456789' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 400 - accountInfo: - description: account description 2 - nickname: account 1290 - accountOpenDate: '2023-05-23' - availableBalance: 400 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - StartUploadSessionRequest: - title: Upload session start request + $ref: '#/components/schemas/ExpenseTransactionLine' + notes: + type: string + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + required: + - type + - issueDate + - currency + UpdateExpenseResponse: + title: Update expense response + x-internal: true type: object properties: - dataType: + syncId: type: string - enum: - - banking-accounts - - banking-transactions - description: A key for a Codat data type. - SupplementalData: - title: Supplemental data + description: Unique identifier for the update expense sync. + examples: + Example 1: + syncId: 1ad0695c-4566-4715-918c-adbb03eac81e + UpdateReimbursableExpenseTransactionRequest: + title: Updating reimbursable expense transaction request 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 + reference: + type: string nullable: true - 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. + description: User-friendly reference for the reimbursable expense. + contactRef: + $ref: '#/components/schemas/ReimbursementContactRef' + apAccountRef: + $ref: '#/components/schemas/apAccountRef' + issueDate: + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + description: Date of the transaction was recorded. + dueDate: + description: Date the supplier is due to be paid. + $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + currency: type: string - enum: - - Website - - Social - - Unknown - url: - description: The full URL for the weblink. + example: GBP + description: Currency the transaction was recorded in. + currencyRate: + $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' + notes: type: string - format: url - example: - type: Website - url: 'https://codat.io' - parameters: - page: - name: page - in: query - schema: - type: integer - format: int32 - minimum: 1 - example: 1 - default: 1 - description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' - pageSize: - name: pageSize - in: query - schema: - type: integer - format: int32 - default: 100 - example: 100 - minimum: 1 - maximum: 5000 - description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' - query: - name: query - in: query - required: false - schema: - type: string - example: id=e3334455-1aed-4e71-ab43-6bccf12092ee - description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' - orderBy: - name: orderBy - in: query - required: false - schema: + description: 'Any private, company notes about the transaction.' + example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' + lines: + type: array + description: Array of transaction lines. + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' + required: + - contactRef + - issueDate + - dueDate + - currency + UpdateSupplierResponse: + title: Update supplier response + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Supplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + validFor: + title: Valid endpoints + x-internal: true + type: array + description: Supported endpoints for the account. + nullable: false + items: type: string - 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: + enum: + - expense-transactions.Payment + - expense-transactions.Refund + - expense-transactions.Reward + - expense-transactions.Chargeback + - reimbursable-expense-transactions + - transfer-transactions + - adjustment-transactions + example: expense-transactions.Payment + validTransactionTypes: + title: Valid transaction types + x-internal: true + type: array + description: Supported transaction types for the account. + nullable: false + items: type: string - 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 + enum: + - Payment + - Refund + - Reward + - Chargeback + example: Payment + parameters: + syncId: + name: syncId 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: A key for a Codat data type. - in: path - required: true - schema: - $ref: '#/components/schemas/DataType' - datasetId: - name: datasetId + example: 6fb40d5e-b13e-11ed-afa1-0242ac120002 + description: Unique identifier for a sync. + transactionId: + name: transactionId in: path required: true schema: type: string format: uuid - description: Unique identifier for the dataset that completed its sync. - description: Unique identifier for the dataset that completed its sync. - 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 + example: 336694d8-2dca-4cb5-a28d-3ccb83e55eee + description: The unique identifier for your SMB's transaction. + page: + name: page 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 + format: int32 + minimum: 1 + example: 1 + default: 1 + description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' + pageSize: + name: pageSize in: query - required: true schema: type: integer - description: The number of periods to return. There will be no pagination as a query parameter. - periodUnit: - name: periodUnit + format: int32 + default: 100 + example: 100 + minimum: 1 + maximum: 5000 + description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' + query: + name: query in: query - required: true + required: false 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 + example: id=e3334455-1aed-4e71-ab43-6bccf12092ee + description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' + orderBy: + name: orderBy in: query - 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 + required: false schema: type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for a bill. - attachmentId: - name: attachmentId + 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 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 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId 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 + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. + dataType: + name: dataType + description: The key of a Codat data type in: path required: true schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for an invoice. - accountingSupplierId: + $ref: '#/components/schemas/DataType' + supplierId: name: supplierId in: path required: true @@ -87538,54 +13034,6 @@ components: - 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 @@ -87619,79 +13067,6 @@ components: 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. @@ -87708,15 +13083,6 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - ConnectionManagementAllowedOrigins: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionManagementAllowedOrigins' - examples: - Allowed origins: - $ref: '#/components/examples/connectionManagementAllowedOriginsResponse' Malformed-Query: description: Your `query` parameter was not correctly formed content: @@ -87838,8 +13204,8 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - Too-Many-Requests: - description: Too many requests were made in a given amount of time. Wait a short period and then try again. + Unprocessable-Content: + description: The requests made can't be processed. This may be due to differences in platform support. content: application/json: schema: @@ -87847,14 +13213,14 @@ components: examples: Conflict: value: - statusCode: 429 - service: PublicApi - error: You have made too many requests in a given amount of time; please retry later. - correlationId: bc997528a9d7abb9161ef45f05d38599 + statusCode: 422 + service: ExpenseSyncApi + error: Expense transaction updates are not supported for platforms other than Xero. + correlationId: 7c8e23841d211c87f49f30b248f70c93 canBeRetried: Unknown detailedErrorCode: 0 - Legal-Reasons: - description: Not currently available due to compliance limitations. Reach out to your Codat contact for further assistance. + Too-Many-Requests: + description: Too many requests were made in a given amount of time. Wait a short period and then try again. content: application/json: schema: @@ -87862,10 +13228,10 @@ components: examples: Conflict: value: - statusCode: 451 - service: StdznCustomData - error: Platform 'qudb' is not currently available for compliance purposes. - correlationId: f63017dabb9b87865573bea95a51e55d + statusCode: 429 + service: PublicApi + error: You have made too many requests in a given amount of time; please retry later. + correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 Internal-Server-Error: @@ -87898,124 +13264,6 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - 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. - customDataIdentifier: - name: customDataIdentifier - in: path - required: true - schema: - type: string - example: DynamicsPurchaseOrders - description: Unique identifier for a custom data type. - page: - name: page - in: query - schema: - type: integer - format: int32 - minimum: 1 - example: 1 - default: 1 - description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' - pageSize: - name: pageSize - in: query - schema: - type: integer - format: int32 - default: 100 - example: 100 - minimum: 1 - maximum: 5000 - description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' - productIdentifier: - name: productIdentifier - in: path - required: true - schema: - type: string - examples: - - bank-feeds - - lending - - payables - - expenses - description: Human-readable product identifier for a product. - query: - name: query - in: query - required: false - schema: - type: string - example: id=e3334455-1aed-4e71-ab43-6bccf12092ee - description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' - orderBy: - name: orderBy - in: query - required: false - schema: - type: string - example: '-modifiedDate' - description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' - dataType: - name: dataType - description: The key of a Codat data type. - in: path - required: true - schema: - $ref: '#/components/schemas/DataType' - datasetId: - name: datasetId - in: path - required: true - schema: - type: string - format: uuid - description: Unique identifier for the dataset that completed its sync. - description: Unique identifier for the dataset that completed its sync. - platformKey: - name: platformKey - in: path - required: true - schema: - type: string - minLength: 4 - maxLength: 4 - pattern: '[a-z]{4}' - example: gbol - description: 'A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.' - description: A unique 4-letter key to represent a platform in each integration. - webhookId: - name: webhookId - in: path - required: true - schema: - $ref: '#/components/schemas/WebhookConsumer/properties/id' - description: Unique identifier for the webhook consumer. - examples: - connectionManagementAllowedOriginsResponse: - value: - allowedOrigins: - - 'https://www.bank-of-dave.com' securitySchemes: auth_header: name: Authorization @@ -88023,270 +13271,3 @@ 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 e54e28c25..f16bca809 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.715.0 +speakeasyVersion: 1.741.1 sources: bank-feeds-source: sourceNamespace: bank-feeds-source @@ -34,11 +34,10 @@ sources: - "1.1" sync-for-expenses-source: sourceNamespace: sync-for-expenses-source - sourceRevisionDigest: sha256:bce4f7554ac962747b9beb73543366d4297eb7efc8e9fccc28e8bf6b29c5db31 - sourceBlobDigest: sha256:abe56a70fc7e5c5883c7e8a6bef59d69ceb2dc4eddbb3106ae06b6c5acb38408 + sourceRevisionDigest: sha256:62683d8745c6d1a5c87fcfcf9b37c8d8d6209fabf2dd7ea7082e8f21531d1ebc + sourceBlobDigest: sha256:aa297e6cc1e1af7d1b8f9832e8da914f7e3d365f13c80edf6ac5a0c5f8789aeb tags: - latest - - speakeasy-sdk-regen-1732638512 - prealpha sync-for-payables-source: sourceNamespace: sync-for-payables-source @@ -94,10 +93,10 @@ targets: sync-for-expenses-library: source: sync-for-expenses-source sourceNamespace: sync-for-expenses-source - sourceRevisionDigest: sha256:bce4f7554ac962747b9beb73543366d4297eb7efc8e9fccc28e8bf6b29c5db31 - sourceBlobDigest: sha256:abe56a70fc7e5c5883c7e8a6bef59d69ceb2dc4eddbb3106ae06b6c5acb38408 - codeSamplesNamespace: sync-for-expenses-source-code-samples - codeSamplesRevisionDigest: sha256:96de587bc3726f162c82db1b0257026b0239c2f4485e4fcb10793f871462b735 + sourceRevisionDigest: sha256:62683d8745c6d1a5c87fcfcf9b37c8d8d6209fabf2dd7ea7082e8f21531d1ebc + sourceBlobDigest: sha256:aa297e6cc1e1af7d1b8f9832e8da914f7e3d365f13c80edf6ac5a0c5f8789aeb + codeSamplesNamespace: sync-for-expenses-source-csharp-code-samples + codeSamplesRevisionDigest: sha256:86b5d3a4ff0ed135676ddc3dc35560eec749c34613052b8d2200ce580a96d4bb sync-for-payables-library: source: sync-for-payables-source sourceNamespace: sync-for-payables-source diff --git a/sync-for-expenses/.gitignore b/sync-for-expenses/.gitignore index b004ecedd..d4890374f 100755 --- a/sync-for-expenses/.gitignore +++ b/sync-for-expenses/.gitignore @@ -1,3 +1,9 @@ +.DS_Store +**/.speakeasy/temp/ +**/.speakeasy/logs/ +.speakeasy/reports +.env +.env.local obj/ bin/ debug/ diff --git a/sync-for-expenses/.speakeasy/gen.lock b/sync-for-expenses/.speakeasy/gen.lock index 597b951b6..c57a339a8 100755 --- a/sync-for-expenses/.speakeasy/gen.lock +++ b/sync-for-expenses/.speakeasy/gen.lock @@ -1,614 +1,2267 @@ lockVersion: 2.0.0 id: 18b9d064-aee3-46b6-b773-6d0ab95e296c management: - docChecksum: c99953b67f6a5e5522a0340e273decdb + docChecksum: 9d547e67e069f901700226b1e2d7ca24 docVersion: prealpha - speakeasyVersion: 1.447.0 - generationVersion: 2.463.0 - releaseVersion: 7.0.0 - configChecksum: d503d9b87c1b84193fe6e4f28bc39aa8 + speakeasyVersion: 1.741.1 + generationVersion: 2.849.2 + releaseVersion: 7.1.0 + configChecksum: 759522a604b3e97013ffe9e10c719901 repoURL: https://github.com/codatio/client-sdk-csharp.git repoSubDirectory: sync-for-expenses + installationURL: https://github.com/codatio/client-sdk-csharp published: true +persistentEdits: + generation_id: 97e1b854-3525-47c5-b4d8-ce8fee51f523 + pristine_commit_hash: 3a77f22b8b5fd1d8a9faa350a72664a9f48b18ce + pristine_tree_hash: ed4a54cc37db5c5ec3f1839e12cb686de769a42e features: csharp: additionalDependencies: 0.1.0 - constsAndDefaults: 0.0.1 - core: 3.10.6 + constsAndDefaults: 0.0.3 + core: 3.15.18 decimal: 0.1.0 deprecations: 2.81.2 - examples: 2.81.3 - globalSecurity: 2.83.6 + examples: 2.81.7 + globalSecurity: 2.83.10 globalSecurityCallbacks: 0.1.0 globalSecurityFlattening: 0.1.0 - globalServerURLs: 2.82.3 + globalServerURLs: 2.83.1 intellisenseMarkdownSupport: 0.1.0 - methodArguments: 0.1.0 - nameOverrides: 2.81.2 - nullables: 0.1.0 + methodArguments: 0.2.1 + nameOverrides: 2.81.4 + nullables: 0.1.1 responseFormat: 0.0.4 retries: 0.0.1 - sdkHooks: 0.1.0 + sdkHooks: 0.3.0 + serverEventsSentinels: 0.2.0 webhooks: 1.0.0 -generatedFiles: - - .gitattributes - - CONTRIBUTING.md - - Codat.Sync.Expenses.sln - - Codat/Sync/Expenses/Accounts.cs - - Codat/Sync/Expenses/Adjustments.cs - - Codat/Sync/Expenses/Attachments.cs - - Codat/Sync/Expenses/BankAccounts.cs - - Codat/Sync/Expenses/Codat.Sync.Expenses.csproj - - Codat/Sync/Expenses/CodatSyncExpenses.cs - - Codat/Sync/Expenses/Companies.cs - - Codat/Sync/Expenses/CompanyInfo.cs - - Codat/Sync/Expenses/Configuration.cs - - Codat/Sync/Expenses/Connections.cs - - Codat/Sync/Expenses/Customers.cs - - Codat/Sync/Expenses/Expenses.cs - - Codat/Sync/Expenses/Hooks/HookTypes.cs - - Codat/Sync/Expenses/Hooks/SDKHooks.cs - - Codat/Sync/Expenses/ManageData.cs - - Codat/Sync/Expenses/MappingOptions.cs - - Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs - - Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs - - Codat/Sync/Expenses/Models/Components/AccountPrototype.cs - - Codat/Sync/Expenses/Models/Components/AccountReference.cs - - Codat/Sync/Expenses/Models/Components/AccountStatus.cs - - Codat/Sync/Expenses/Models/Components/AccountType.cs - - Codat/Sync/Expenses/Models/Components/AccountingAccount.cs - - Codat/Sync/Expenses/Models/Components/AccountingAddress.cs - - Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs - - Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs - - Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs - - Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs - - Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs - - Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs - - Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs - - Codat/Sync/Expenses/Models/Components/ApAccountRef.cs - - Codat/Sync/Expenses/Models/Components/Attachment.cs - - Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs - - Codat/Sync/Expenses/Models/Components/BankAccount.cs - - Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs - - Codat/Sync/Expenses/Models/Components/BankAccountReference.cs - - Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs - - Codat/Sync/Expenses/Models/Components/BankAccountType.cs - - Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhook.cs - - Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhookData.cs - - Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhook.cs - - Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhookData.cs - - Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs - - Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs - - Codat/Sync/Expenses/Models/Components/CodatFile.cs - - Codat/Sync/Expenses/Models/Components/Companies.cs - - Codat/Sync/Expenses/Models/Components/Company.cs - - Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs - - Codat/Sync/Expenses/Models/Components/CompanyInformation.cs - - Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs - - Codat/Sync/Expenses/Models/Components/CompanyReference.cs - - Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs - - Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs - - Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs - - Codat/Sync/Expenses/Models/Components/Connection.cs - - Codat/Sync/Expenses/Models/Components/Connections.cs - - Codat/Sync/Expenses/Models/Components/Contact.cs - - Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs - - Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs - - Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs - - Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs - - Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs - - Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs - - Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs - - Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs - - Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs - - Codat/Sync/Expenses/Models/Components/Customer.cs - - Codat/Sync/Expenses/Models/Components/CustomerDetails.cs - - Codat/Sync/Expenses/Models/Components/CustomerStatus.cs - - Codat/Sync/Expenses/Models/Components/Customers.cs - - Codat/Sync/Expenses/Models/Components/DataConnectionError.cs - - Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs - - Codat/Sync/Expenses/Models/Components/DataStatus.cs - - Codat/Sync/Expenses/Models/Components/DataType.cs - - Codat/Sync/Expenses/Models/Components/DataTypes.cs - - Codat/Sync/Expenses/Models/Components/DatasetStatus.cs - - Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs - - Codat/Sync/Expenses/Models/Components/ErrorStatus.cs - - Codat/Sync/Expenses/Models/Components/ErrorValidation.cs - - Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs - - Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs - - Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs - - Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs - - Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs - - Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs - - Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs - - Codat/Sync/Expenses/Models/Components/From.cs - - Codat/Sync/Expenses/Models/Components/HalRef.cs - - Codat/Sync/Expenses/Models/Components/IntegrationType.cs - - Codat/Sync/Expenses/Models/Components/InvoiceTo.cs - - Codat/Sync/Expenses/Models/Components/InvoiceToType.cs - - Codat/Sync/Expenses/Models/Components/ItemRef.cs - - Codat/Sync/Expenses/Models/Components/Items.cs - - Codat/Sync/Expenses/Models/Components/Links.cs - - Codat/Sync/Expenses/Models/Components/MappingOptions.cs - - Codat/Sync/Expenses/Models/Components/Metadata.cs - - Codat/Sync/Expenses/Models/Components/Phone.cs - - Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs - - Codat/Sync/Expenses/Models/Components/PhoneNumberType.cs - - Codat/Sync/Expenses/Models/Components/PropertieDataType.cs - - Codat/Sync/Expenses/Models/Components/PullOperation.cs - - Codat/Sync/Expenses/Models/Components/PullOperations.cs - - Codat/Sync/Expenses/Models/Components/PushChangeType.cs - - Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs - - Codat/Sync/Expenses/Models/Components/PushOperation.cs - - Codat/Sync/Expenses/Models/Components/PushOperationChange.cs - - Codat/Sync/Expenses/Models/Components/PushOperationRef.cs - - Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs - - Codat/Sync/Expenses/Models/Components/PushOperations.cs - - Codat/Sync/Expenses/Models/Components/PushOption.cs - - Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs - - Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs - - Codat/Sync/Expenses/Models/Components/PushOptionType.cs - - Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs - - Codat/Sync/Expenses/Models/Components/RecordRef.cs - - Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs - - Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs - - Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs - - Codat/Sync/Expenses/Models/Components/Security.cs - - Codat/Sync/Expenses/Models/Components/SourceType.cs - - Codat/Sync/Expenses/Models/Components/Status.cs - - Codat/Sync/Expenses/Models/Components/SupplementalData.cs - - Codat/Sync/Expenses/Models/Components/Supplier.cs - - Codat/Sync/Expenses/Models/Components/SupplierDetails.cs - - Codat/Sync/Expenses/Models/Components/SupplierStatus.cs - - Codat/Sync/Expenses/Models/Components/Suppliers.cs - - Codat/Sync/Expenses/Models/Components/SyncCompleteWebhook.cs - - Codat/Sync/Expenses/Models/Components/SyncCompleteWebhookData.cs - - Codat/Sync/Expenses/Models/Components/SyncFailedWebhook.cs - - Codat/Sync/Expenses/Models/Components/SyncFailedWebhookData.cs - - Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs - - Codat/Sync/Expenses/Models/Components/To.cs - - Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs - - Codat/Sync/Expenses/Models/Components/TrackingRef.cs - - Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs - - Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs - - Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs - - Codat/Sync/Expenses/Models/Components/Transaction.cs - - Codat/Sync/Expenses/Models/Components/TransactionStatus.cs - - Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs - - Codat/Sync/Expenses/Models/Components/Transactions.cs - - Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs - - Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs - - Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs - - Codat/Sync/Expenses/Models/Components/Type.cs - - Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs - - Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs - - Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs - - Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs - - Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs - - Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs - - Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs - - Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs - - Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs - - Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs - - Codat/Sync/Expenses/Models/Components/ValidFor.cs - - Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs - - Codat/Sync/Expenses/Models/Components/Validation.cs - - Codat/Sync/Expenses/Models/Components/ValidationItem.cs - - Codat/Sync/Expenses/Models/Components/Weblink.cs - - Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs - - Codat/Sync/Expenses/Models/Errors/SDKException.cs - - Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs - - Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs - - Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs - - Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs - - Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs - - Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs - - Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs - - Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs - - Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs - - Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs - - Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs - - Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs - - Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs - - Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs - - Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs - - Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs - - Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs - - Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs - - Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs - - Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs - - Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs - - Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs - - Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs - - Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs - - Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs - - Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs - - Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs - - Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs - - Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs - - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs - - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse1.cs - - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs - - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse1.cs - - Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs - - Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs - - Codat/Sync/Expenses/Models/Webhooks/SyncCompletedResponse.cs - - Codat/Sync/Expenses/Models/Webhooks/SyncFailedResponse.cs - - Codat/Sync/Expenses/PushOperations.cs - - Codat/Sync/Expenses/Reimbursements.cs - - Codat/Sync/Expenses/Suppliers.cs - - Codat/Sync/Expenses/Sync.cs - - Codat/Sync/Expenses/TransactionStatus.cs - - Codat/Sync/Expenses/Transfers.cs - - Codat/Sync/Expenses/Utils/AnyDeserializer.cs - - Codat/Sync/Expenses/Utils/BigIntStrConverter.cs - - Codat/Sync/Expenses/Utils/DecimalStrConverter.cs - - Codat/Sync/Expenses/Utils/EnumConverter.cs - - Codat/Sync/Expenses/Utils/FlexibleObjectDeserializer.cs - - Codat/Sync/Expenses/Utils/HeaderSerializer.cs - - Codat/Sync/Expenses/Utils/IsoDateTimeSerializer.cs - - Codat/Sync/Expenses/Utils/RequestBodySerializer.cs - - Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs - - Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs - - Codat/Sync/Expenses/Utils/Retries/Retries.cs - - Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs - - Codat/Sync/Expenses/Utils/SecurityMetadata.cs - - Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs - - Codat/Sync/Expenses/Utils/SpeakeasyMetadata.cs - - Codat/Sync/Expenses/Utils/URLBuilder.cs - - Codat/Sync/Expenses/Utils/Utilities.cs - - NUGET.md - - USAGE.md - - docs/Models/Components/AccountMappingInfo.md - - docs/Models/Components/AccountMappingInfoAccountType.md - - docs/Models/Components/AccountPrototype.md - - docs/Models/Components/AccountReference.md - - docs/Models/Components/AccountStatus.md - - docs/Models/Components/AccountType.md - - docs/Models/Components/AccountingAccount.md - - docs/Models/Components/AccountingAddress.md - - docs/Models/Components/AccountingAddressType.md - - docs/Models/Components/AccountingBankAccount.md - - docs/Models/Components/AccountingCustomer.md - - docs/Models/Components/AccountingSupplier.md - - docs/Models/Components/AdjustmentTransactionLine.md - - docs/Models/Components/AdjustmentTransactionRequest.md - - docs/Models/Components/AdjustmentTransactionResponse.md - - docs/Models/Components/ApAccountRef.md - - docs/Models/Components/Attachment.md - - docs/Models/Components/AttachmentUpload.md - - docs/Models/Components/BankAccount.md - - docs/Models/Components/BankAccountDetails.md - - docs/Models/Components/BankAccountReference.md - - docs/Models/Components/BankAccountStatus.md - - docs/Models/Components/BankAccountType.md - - docs/Models/Components/ClientRateLimitReachedWebhook.md - - docs/Models/Components/ClientRateLimitReachedWebhookData.md - - docs/Models/Components/ClientRateLimitResetWebhook.md - - docs/Models/Components/ClientRateLimitResetWebhookData.md - - docs/Models/Components/ClientRateLimitWebhook.md - - docs/Models/Components/ClientRateLimitWebhookPayload.md - - docs/Models/Components/CodatFile.md - - docs/Models/Components/Companies.md - - docs/Models/Components/Company.md - - docs/Models/Components/CompanyConfiguration.md - - docs/Models/Components/CompanyInformation.md - - docs/Models/Components/CompanyInformationType.md - - docs/Models/Components/CompanyReference.md - - docs/Models/Components/CompanyReferenceLinks.md - - docs/Models/Components/CompanyRequestBody.md - - docs/Models/Components/CompanySyncStatus.md - - docs/Models/Components/Connection.md - - docs/Models/Components/Connections.md - - docs/Models/Components/Contact.md - - docs/Models/Components/CreateAccountResponse.md - - docs/Models/Components/CreateAccountResponseMetadata.md - - docs/Models/Components/CreateAccountResponseValidDataTypeLinks.md - - docs/Models/Components/CreateBankAccountResponse.md - - docs/Models/Components/CreateBankAccountResponseBankAccountType.md - - docs/Models/Components/CreateCustomerResponse.md - - docs/Models/Components/CreateExpenseResponse.md - - docs/Models/Components/CreateReimbursableExpenseResponse.md - - docs/Models/Components/CreateSupplierResponse.md - - docs/Models/Components/Customer.md - - docs/Models/Components/CustomerDetails.md - - docs/Models/Components/CustomerStatus.md - - docs/Models/Components/Customers.md - - docs/Models/Components/DataConnectionError.md - - docs/Models/Components/DataConnectionStatus.md - - docs/Models/Components/DataStatus.md - - docs/Models/Components/DataType.md - - docs/Models/Components/DataTypes.md - - docs/Models/Components/DatasetStatus.md - - docs/Models/Components/DefinitionTransaction.md - - docs/Models/Components/ErrorStatus.md - - docs/Models/Components/ErrorValidation.md - - docs/Models/Components/ErrorValidationItem.md - - docs/Models/Components/ExpenseContactRef.md - - docs/Models/Components/ExpenseContactRefType.md - - docs/Models/Components/ExpenseTransaction.md - - docs/Models/Components/ExpenseTransactionLine.md - - docs/Models/Components/ExpensesSyncWebhook.md - - docs/Models/Components/ExpensesSyncWebhookPayload.md - - docs/Models/Components/From.md - - docs/Models/Components/HalRef.md - - docs/Models/Components/IntegrationType.md - - docs/Models/Components/InvoiceTo.md - - docs/Models/Components/InvoiceToType.md - - docs/Models/Components/ItemRef.md - - docs/Models/Components/Items.md - - docs/Models/Components/Links.md - - docs/Models/Components/MappingOptions.md - - docs/Models/Components/Metadata.md - - docs/Models/Components/Phone.md - - docs/Models/Components/PhoneNumberItems.md - - docs/Models/Components/PhoneNumberType.md - - docs/Models/Components/PropertieDataType.md - - docs/Models/Components/PullOperation.md - - docs/Models/Components/PullOperations.md - - docs/Models/Components/PushChangeType.md - - docs/Models/Components/PushFieldValidation.md - - docs/Models/Components/PushOperation.md - - docs/Models/Components/PushOperationChange.md - - docs/Models/Components/PushOperationRef.md - - docs/Models/Components/PushOperationStatus.md - - docs/Models/Components/PushOperations.md - - docs/Models/Components/PushOption.md - - docs/Models/Components/PushOptionChoice.md - - docs/Models/Components/PushOptionProperty.md - - docs/Models/Components/PushOptionType.md - - docs/Models/Components/PushValidationInfo.md - - docs/Models/Components/RecordRef.md - - docs/Models/Components/ReimbursableExpenseTransaction.md - - docs/Models/Components/ReimbursableExpenseTransactionLine.md - - docs/Models/Components/ReimbursementContactRef.md - - docs/Models/Components/Security.md - - docs/Models/Components/SourceType.md - - docs/Models/Components/Status.md - - docs/Models/Components/SupplementalData.md - - docs/Models/Components/Supplier.md - - docs/Models/Components/SupplierDetails.md - - docs/Models/Components/SupplierStatus.md - - docs/Models/Components/Suppliers.md - - docs/Models/Components/SyncCompleteWebhook.md - - docs/Models/Components/SyncCompleteWebhookData.md - - docs/Models/Components/SyncFailedWebhook.md - - docs/Models/Components/SyncFailedWebhookData.md - - docs/Models/Components/TaxRateMappingInfo.md - - docs/Models/Components/To.md - - docs/Models/Components/TrackingCategoryMappingInfo.md - - docs/Models/Components/TrackingRef.md - - docs/Models/Components/TrackingRefAdjustmentTransaction.md - - docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md - - docs/Models/Components/TrackingRefDataType.md - - docs/Models/Components/Transaction.md - - docs/Models/Components/TransactionStatus.md - - docs/Models/Components/TransactionStatus1.md - - docs/Models/Components/Transactions.md - - docs/Models/Components/TransferTransactionRequest.md - - docs/Models/Components/TransferTransactionRequestAccountReference.md - - docs/Models/Components/TransferTransactionResponse.md - - docs/Models/Components/Type.md - - docs/Models/Components/UpdateCustomerResponse.md - - docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md - - docs/Models/Components/UpdateExpenseRequest.md - - docs/Models/Components/UpdateExpenseRequestBankAccountReference.md - - docs/Models/Components/UpdateExpenseRequestType.md - - docs/Models/Components/UpdateExpenseResponse.md - - docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md - - docs/Models/Components/UpdateSupplierResponse.md - - docs/Models/Components/UpdateSupplierResponseAccountingSupplier.md - - docs/Models/Components/ValidDataTypeLinks.md - - docs/Models/Components/ValidFor.md - - docs/Models/Components/ValidTransactionTypes.md - - docs/Models/Components/Validation.md - - docs/Models/Components/ValidationItem.md - - docs/Models/Components/Weblink.md - - docs/Models/Errors/ErrorMessage.md - - docs/Models/Requests/CreateAccountRequest.md - - docs/Models/Requests/CreateAccountResponse.md - - docs/Models/Requests/CreateAdjustmentTransactionRequest.md - - docs/Models/Requests/CreateAdjustmentTransactionResponse.md - - docs/Models/Requests/CreateBankAccountRequest.md - - docs/Models/Requests/CreateBankAccountResponse.md - - docs/Models/Requests/CreateCompanyResponse.md - - docs/Models/Requests/CreateConnectionRequest.md - - docs/Models/Requests/CreateConnectionRequestBody.md - - docs/Models/Requests/CreateConnectionResponse.md - - docs/Models/Requests/CreateCustomerRequest.md - - docs/Models/Requests/CreateCustomerResponse.md - - docs/Models/Requests/CreateExpenseTransactionRequest.md - - docs/Models/Requests/CreateExpenseTransactionResponse.md - - docs/Models/Requests/CreatePartnerExpenseConnectionRequest.md - - docs/Models/Requests/CreatePartnerExpenseConnectionResponse.md - - docs/Models/Requests/CreateReimbursableExpenseTransactionRequest.md - - docs/Models/Requests/CreateReimbursableExpenseTransactionResponse.md - - docs/Models/Requests/CreateSupplierRequest.md - - docs/Models/Requests/CreateSupplierResponse.md - - docs/Models/Requests/CreateTransferTransactionRequest.md - - docs/Models/Requests/CreateTransferTransactionResponse.md - - docs/Models/Requests/DeleteCompanyRequest.md - - docs/Models/Requests/DeleteCompanyResponse.md - - docs/Models/Requests/DeleteConnectionRequest.md - - docs/Models/Requests/DeleteConnectionResponse.md - - docs/Models/Requests/GetCompanyConfigurationRequest.md - - docs/Models/Requests/GetCompanyConfigurationResponse.md - - docs/Models/Requests/GetCompanyInfoRequest.md - - docs/Models/Requests/GetCompanyInfoResponse.md - - docs/Models/Requests/GetCompanyRequest.md - - docs/Models/Requests/GetCompanyResponse.md - - docs/Models/Requests/GetConnectionRequest.md - - docs/Models/Requests/GetConnectionResponse.md - - docs/Models/Requests/GetCreateBankAccountsModelRequest.md - - docs/Models/Requests/GetCreateBankAccountsModelResponse.md - - docs/Models/Requests/GetCreateChartOfAccountsModelRequest.md - - docs/Models/Requests/GetCreateChartOfAccountsModelResponse.md - - docs/Models/Requests/GetCustomerRequest.md - - docs/Models/Requests/GetCustomerResponse.md - - docs/Models/Requests/GetDataStatusDataStatuses.md - - docs/Models/Requests/GetDataStatusRequest.md - - docs/Models/Requests/GetDataStatusResponse.md - - docs/Models/Requests/GetLastSuccessfulSyncRequest.md - - docs/Models/Requests/GetLastSuccessfulSyncResponse.md - - docs/Models/Requests/GetLatestSyncRequest.md - - docs/Models/Requests/GetLatestSyncResponse.md - - docs/Models/Requests/GetMappingOptionsRequest.md - - docs/Models/Requests/GetMappingOptionsResponse.md - - docs/Models/Requests/GetPullOperationRequest.md - - docs/Models/Requests/GetPullOperationResponse.md - - docs/Models/Requests/GetPushOperationRequest.md - - docs/Models/Requests/GetPushOperationResponse.md - - docs/Models/Requests/GetSupplierRequest.md - - docs/Models/Requests/GetSupplierResponse.md - - docs/Models/Requests/GetSyncByIdRequest.md - - docs/Models/Requests/GetSyncByIdResponse.md - - docs/Models/Requests/GetSyncTransactionRequest.md - - docs/Models/Requests/GetSyncTransactionResponse.md - - docs/Models/Requests/ListCompaniesRequest.md - - docs/Models/Requests/ListCompaniesResponse.md - - docs/Models/Requests/ListConnectionsRequest.md - - docs/Models/Requests/ListConnectionsResponse.md - - docs/Models/Requests/ListCustomersRequest.md - - docs/Models/Requests/ListCustomersResponse.md - - docs/Models/Requests/ListPullOperationsRequest.md - - docs/Models/Requests/ListPullOperationsResponse.md - - docs/Models/Requests/ListPushOperationsRequest.md - - docs/Models/Requests/ListPushOperationsResponse.md - - docs/Models/Requests/ListSuppliersRequest.md - - docs/Models/Requests/ListSuppliersResponse.md - - docs/Models/Requests/ListSyncTransactionsRequest.md - - docs/Models/Requests/ListSyncTransactionsResponse.md - - docs/Models/Requests/ListSyncsRequest.md - - docs/Models/Requests/ListSyncsResponse.md - - docs/Models/Requests/RefreshAllDataTypesRequest.md - - docs/Models/Requests/RefreshAllDataTypesResponse.md - - docs/Models/Requests/RefreshDataTypeRequest.md - - docs/Models/Requests/RefreshDataTypeResponse.md - - docs/Models/Requests/SetCompanyConfigurationRequest.md - - docs/Models/Requests/SetCompanyConfigurationResponse.md - - docs/Models/Requests/UnlinkConnectionRequest.md - - docs/Models/Requests/UnlinkConnectionResponse.md - - docs/Models/Requests/UnlinkConnectionUpdateConnection.md - - docs/Models/Requests/UpdateCompanyRequest.md - - docs/Models/Requests/UpdateCompanyResponse.md - - docs/Models/Requests/UpdateCustomerRequest.md - - docs/Models/Requests/UpdateCustomerResponse.md - - docs/Models/Requests/UpdateExpenseTransactionRequest.md - - docs/Models/Requests/UpdateExpenseTransactionResponse.md - - docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md - - docs/Models/Requests/UpdateReimbursableExpenseTransactionResponse.md - - docs/Models/Requests/UpdateSupplierRequest.md - - docs/Models/Requests/UpdateSupplierResponse.md - - docs/Models/Requests/UploadExpenseAttachmentRequest.md - - docs/Models/Requests/UploadExpenseAttachmentResponse.md - - docs/Models/Webhooks/ClientRateLimitReachedResponse.md - - docs/Models/Webhooks/ClientRateLimitReachedResponse1.md - - docs/Models/Webhooks/ClientRateLimitResetResponse.md - - docs/Models/Webhooks/ClientRateLimitResetResponse1.md - - docs/Models/Webhooks/ExpensesSyncSuccessfulResponse.md - - docs/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.md - - docs/Models/Webhooks/SyncCompletedResponse.md - - docs/Models/Webhooks/SyncFailedResponse.md - - docs/sdks/accounts/README.md - - docs/sdks/adjustments/README.md - - docs/sdks/attachments/README.md - - docs/sdks/bankaccounts/README.md - - docs/sdks/codatsyncexpenses/README.md - - docs/sdks/companies/README.md - - docs/sdks/companyinfo/README.md - - docs/sdks/configuration/README.md - - docs/sdks/connections/README.md - - docs/sdks/customers/README.md - - docs/sdks/expenses/README.md - - docs/sdks/managedata/README.md - - docs/sdks/mappingoptions/README.md - - docs/sdks/pushoperations/README.md - - docs/sdks/reimbursements/README.md - - docs/sdks/suppliers/README.md - - docs/sdks/sync/README.md - - docs/sdks/transactionstatus/README.md - - docs/sdks/transfers/README.md - - global.json +trackedFiles: + .gitattributes: + id: 24139dae6567 + last_write_checksum: sha1:6cf623aa5081ea7f1e32b99d74fac393718a29cf + pristine_git_object: c094dba670119a1a5414e11c713a4ea3218147cd + Codat.Sync.Expenses.sln: + id: 0a9ccf9ae6fc + last_write_checksum: sha1:9bced562eadb8b2e7aa21d3c5a7a4f8a2b381f33 + pristine_git_object: a1d6bbd10bfe99d99a37e8150921d9edf04588d9 + Codat/Sync/Expenses/Accounts.cs: + id: 1cfa7adba42c + last_write_checksum: sha1:36aedb0af4b544c37a9f7888d7d425981acef7b8 + pristine_git_object: 8ff569e80cca3d9f7ca79e5280726b900b3391eb + Codat/Sync/Expenses/Adjustments.cs: + id: 60de41b66cf9 + last_write_checksum: sha1:de2bdba86bc78dd66a25bf9e9e1d6f155630dd17 + pristine_git_object: 9a52124a04947b3a61da8a741795d33383acf977 + Codat/Sync/Expenses/Attachments.cs: + id: a77bbae8fef6 + last_write_checksum: sha1:2f0bc7d59ee537e7e8a365c03d9b853d8df1deb5 + pristine_git_object: 432b1e7c8b0a09dc820e37b26d12aad3ae96a898 + Codat/Sync/Expenses/BankAccounts.cs: + id: 74268b630921 + last_write_checksum: sha1:bb9db68fef703397338a4a891b625cd8a941a52f + pristine_git_object: 591ff698d387cb7024a5aa32add091ee565ecec8 + Codat/Sync/Expenses/Codat.Sync.Expenses.csproj: + id: 9a17e90bae47 + last_write_checksum: sha1:3c4d9629ec4a66598a8fb5160f3cc18b55cb2f07 + pristine_git_object: 1eb1e3cc62ba6ff30062b2878e785f64a362fd15 + Codat/Sync/Expenses/CodatSyncExpenses.cs: + id: aedbba25a430 + last_write_checksum: sha1:48aa4887303e4d41a788a07d2c7ec1949f20dc48 + pristine_git_object: 621cf9cb92d712997f21ed30ddcb373809b20b94 + Codat/Sync/Expenses/Companies.cs: + id: b3f9b8f2c4e5 + last_write_checksum: sha1:dd8db84c2d9f569528b7ea6b1a621201d0f1de2c + pristine_git_object: 61d7c2d9210b603f12182506c3ebee0474d998a8 + Codat/Sync/Expenses/CompanyInfo.cs: + id: 35887294c104 + last_write_checksum: sha1:a69ecaa972414863f7741b3ab2b8cb7580d95c83 + pristine_git_object: 2d4b6d04000b43ecee6b70b7799a94213d4a6cb2 + Codat/Sync/Expenses/Configuration.cs: + id: 83bd08bdea19 + last_write_checksum: sha1:6c60b099a235c989dbfa7606e863228b12f044e2 + pristine_git_object: 1dd912db355fe81f54ed701295062107ec440a98 + Codat/Sync/Expenses/Connections.cs: + id: 0d38c8c67a5c + last_write_checksum: sha1:ee963b3335bc22f191afe7f735789d1d5a3decf1 + pristine_git_object: 9713957cc0ca27b4149d7a00c8fcf6d6fc1eb165 + Codat/Sync/Expenses/Customers.cs: + id: e8e041980154 + last_write_checksum: sha1:8a0a412136b48ae5ef88d418af5571f98d9c3372 + pristine_git_object: f0edcb2196d992403d1002275a377d364190f41b + Codat/Sync/Expenses/Expenses.cs: + id: ca3dedbc6581 + last_write_checksum: sha1:4e011fc056064a81652eca70c456c8251a4d573b + pristine_git_object: 56400cef14937f57d9c37417a3d120b338bd439f + Codat/Sync/Expenses/Hooks/HookTypes.cs: + id: 6a59b5d962f0 + last_write_checksum: sha1:45d9ba8e284a5105ca4b0785a0e25d76fbff248d + pristine_git_object: 0705adbb0e81f745c9147d3d88ee272121fa5fdb + Codat/Sync/Expenses/Hooks/SDKHooks.cs: + id: 14478eacc74c + last_write_checksum: sha1:b793eb304d46ea5bc4ead8f3ffa5f6d97870a43a + pristine_git_object: 54705c9f9ca02a65ec4e9e8967c954c1099d7146 + Codat/Sync/Expenses/ManageData.cs: + id: 6446c3c112ea + last_write_checksum: sha1:6be82e3a206c5acc2cf7c19ab80361bdd222d0ac + pristine_git_object: 4c519635606c44498183e611e6ce918ba6287b40 + Codat/Sync/Expenses/MappingOptions.cs: + id: 394b9745e101 + last_write_checksum: sha1:773cd6247c83943fd6229536e71eb2cd3cf69a4b + pristine_git_object: aa7941812e62d790a7e2e9e5f1fa64914853ee58 + Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs: + id: 689b69ed9307 + last_write_checksum: sha1:10bfa822b44eee932f9c5d84470c2e78e94f4fe8 + pristine_git_object: c07d2f5a5f8c82be3fbe1f526dff820e38a0f36a + Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs: + id: 4cbcc7159c0d + last_write_checksum: sha1:6e3ff2336e07c50c40272a3ae20957510812e8be + pristine_git_object: eb4b66f801b65a1ddf330ef15849e492e173fe12 + Codat/Sync/Expenses/Models/Components/AccountPrototype.cs: + id: 01adfb2b227e + last_write_checksum: sha1:2f89fca3ccc9f12b691dc6e0bccbea70fc1c285e + pristine_git_object: a14e3d8cb62eee447fa77fd9b8bc8be50417536a + Codat/Sync/Expenses/Models/Components/AccountReference.cs: + id: 316554d88fd6 + last_write_checksum: sha1:682c5843937b183cf26756da7088a032163459c6 + pristine_git_object: 91d9d6cc12d26bcf90ee783e3d48a84d83006432 + Codat/Sync/Expenses/Models/Components/AccountStatus.cs: + id: 953a815c39cd + last_write_checksum: sha1:db2c9e8dda9f94e691a07ad1683c39a954366a05 + pristine_git_object: 53e93c0559de4e6317425d4e6cab675e869e8180 + Codat/Sync/Expenses/Models/Components/AccountType.cs: + id: 14b6912451fc + last_write_checksum: sha1:4bfc7dbaaf55fa67be829f022dfc1b2fcea88f46 + pristine_git_object: 733f417502371feab2d491b47b809095c63bbe21 + Codat/Sync/Expenses/Models/Components/AccountingAccount.cs: + id: 0cdf1b957c03 + last_write_checksum: sha1:a50ae14f1bb0fc708bad3db5ae0428e7a8a7f228 + pristine_git_object: 828301dd95042681205d050acffb87ba61600a6a + Codat/Sync/Expenses/Models/Components/AccountingAddress.cs: + id: 06ab994c8a73 + last_write_checksum: sha1:0022c4a6fc5d51d0a98af6c9da2e4e4273d145ff + pristine_git_object: b43cc548c8af77d666f8a94aee586f188ecc46ac + Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs: + id: 96feff8d00a9 + last_write_checksum: sha1:123fe68f9f0a9df5d2ee8bbe33a5e80fa0fa8e0b + pristine_git_object: a9414b5e55e9a7d08c4de96d5b1f279cfa402eb7 + Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs: + id: f2b0f529373c + last_write_checksum: sha1:b58c81601b0dbd9d35d73feb06862c33702d4528 + pristine_git_object: 5a4a9e677b7821548e3d58bff96c5555351c3d49 + Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs: + id: 3b444e5abfac + last_write_checksum: sha1:7e76d43b811ebf9baae3415f0dc6fa93ba337c46 + pristine_git_object: 7cbe5b866f3d94746d74fa514480b15e25781aef + Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs: + id: 92096ef67905 + last_write_checksum: sha1:27414f9a390dc83e9deaa5b4dea73b6a7c9db8ae + pristine_git_object: 49f325b54d5ad93a672e1a9ddc18ee7bac208a2e + Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs: + id: f598905a23c2 + last_write_checksum: sha1:2641e8d32c5700ca489974de7510ae50e1317ebe + pristine_git_object: 340db13d1d92127209e0416583cc73de4e57d1cf + Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs: + id: 5a1fa8abe90e + last_write_checksum: sha1:69f7c6f9254d64efad3962b1c8a5d407c3a699dc + pristine_git_object: f852a3a4ba6b5ba7f94e7af7b072ae8e62a34cb7 + Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs: + id: 0722494b0521 + last_write_checksum: sha1:565eedef7f1cd28e72df49956addf4e12473fe6b + pristine_git_object: c6d4e7f33e9f023bcf7ff849441740ce75d52db3 + Codat/Sync/Expenses/Models/Components/ApAccountRef.cs: + id: a99184b972e6 + last_write_checksum: sha1:78237b2efad70052b75b8175888a378eed4f2cba + pristine_git_object: e82b7285cc9743944bac63d6638470106b3e520e + Codat/Sync/Expenses/Models/Components/Attachment.cs: + id: 9c8a704ab249 + last_write_checksum: sha1:083f844d6361a1a4f8a5c9d8c249b5fe55be6dea + pristine_git_object: 069a9ccf0827b2c3cf5f854bc76409c472e7ae51 + Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs: + id: 3b330ecd3977 + last_write_checksum: sha1:40479cbf4fbfe13f291e85fd851d4fd5649281c2 + pristine_git_object: 3d314d7268da5f20f293bbd760d1bd37eabbf404 + Codat/Sync/Expenses/Models/Components/BankAccount.cs: + id: c4adf3d0759f + last_write_checksum: sha1:36d094a16d1e004ef7410663280a4335155b6669 + pristine_git_object: 8cd55a83d9cc946226d7a812b036b7b106d14ef4 + Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs: + id: 1bf1079dc0bd + last_write_checksum: sha1:92ceb72c79d4cba842fbf2d93a60b409e7adac47 + pristine_git_object: de3ef029ed125ccf1d529c5c935cd7288f930730 + Codat/Sync/Expenses/Models/Components/BankAccountReference.cs: + id: 2ec1a4cb8beb + last_write_checksum: sha1:f64f1c2dddcea82db64c61369c08cefb7519f814 + pristine_git_object: 51c5e008254d047ec3c01f1bd40f832c7289078c + Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs: + id: 73c4ef6dc304 + last_write_checksum: sha1:e5ef30f21920f63cba258b29c4ca3d1809451ef5 + pristine_git_object: 14fc6445758232834f48a04a0a7e3848a56b1a21 + Codat/Sync/Expenses/Models/Components/BankAccountType.cs: + id: 19757b58c5ba + last_write_checksum: sha1:012dd7d461072586eefa71edaf7c7268f16883bd + pristine_git_object: 08990b26c2c12a82e28a445bb8f176883f8bae65 + Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs: + id: 052ecce4564d + last_write_checksum: sha1:de0f6dce11887c68e874093973df41c9e7e35250 + pristine_git_object: f73dbee2af510633ad2c5e3e6ec7afe50f0b16f0 + Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs: + id: a0c345825145 + last_write_checksum: sha1:68149e790b5b470cd4bbe1169d22d2bc9affa043 + pristine_git_object: 28b8e1e8ba95c3c3067a592664f604b2711cde82 + Codat/Sync/Expenses/Models/Components/CodatFile.cs: + id: 5de73c340e48 + last_write_checksum: sha1:438dbd974b8bf0f349eec746c7c5f378399ce104 + pristine_git_object: 63780d6f09255454fab02a69dc8d4234376aa5c6 + Codat/Sync/Expenses/Models/Components/Companies.cs: + id: ab0cefe1dbda + last_write_checksum: sha1:ade6a34763713910094468b916793fb73e6382db + pristine_git_object: 912aded471617656bc74b7e1070bfa92cc984c71 + Codat/Sync/Expenses/Models/Components/Company.cs: + id: 827a3e4325a1 + last_write_checksum: sha1:0371c0f597a196e357a3b8eff1f22ebdf1602fa8 + pristine_git_object: fc71618e086664fee4fb7e90d5972318190acecc + Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs: + id: 1e648f61c66e + last_write_checksum: sha1:3ed7dda4e3c8b44212113f70926ed0f1eff76964 + pristine_git_object: 7530c70e7b2c862d251fc5f6478807e95a20108a + Codat/Sync/Expenses/Models/Components/CompanyInformation.cs: + id: 91d50fd6b495 + last_write_checksum: sha1:6d81908347174ea9e575ac569752e80912ac8a10 + pristine_git_object: b822015ac2d8dd0b21bab92b8f5b94d8dd36a802 + Codat/Sync/Expenses/Models/Components/CompanyInformationPhoneNumbersType.cs: + id: 6a2d56aec1d7 + last_write_checksum: sha1:a51e2e694ec2fa4afc3312a2dff4a21704bcb3d9 + pristine_git_object: 8ff1987fdaf1aa6b19d7e150a2dbd8e81d366f0d + Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs: + id: 8d1a3c326c66 + last_write_checksum: sha1:7eba1343454d3ef852f3befa982bee96c0693930 + pristine_git_object: abef4a8f4e6a5c09e8d0821e7b1e8f4d05099031 + Codat/Sync/Expenses/Models/Components/CompanyReference.cs: + id: e14848f5b665 + last_write_checksum: sha1:954e973a7e2eefd8ec18016004c2861430408109 + pristine_git_object: a66841f3035a9f53e0dfbbcec5087dc13f1dfb84 + Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs: + id: 49afd3177703 + last_write_checksum: sha1:8999076495a4dfed9f511db7e8b277c161f2357b + pristine_git_object: 4c9fff3ce722a86324b4ef0db42d12fb599e05aa + Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs: + id: d0d656ed6ad3 + last_write_checksum: sha1:7ce4cef2eac364844fca4f42a002323f6f0b87be + pristine_git_object: ddbac29730ed3a0ba875fed9f13fee34af44ba84 + Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs: + id: 83ad04aaf54f + last_write_checksum: sha1:1029e0ea962de06557ae0a6b98d27289a1f893b8 + pristine_git_object: 8bfa4dfd1e823ea2eb61f773e85d23d15ede5d6b + Codat/Sync/Expenses/Models/Components/CompanyUpdateRequest.cs: + id: d2f8f8d4630c + last_write_checksum: sha1:0df0e2c4bd9e3432abe03a38f913b8fa2a69b937 + pristine_git_object: 653137c59cdb9475a29660829a364001d7d1dc07 + Codat/Sync/Expenses/Models/Components/Connection.cs: + id: 380933f0fca9 + last_write_checksum: sha1:b90cbaa4fee3887b9ccc57efa546fe4d4ff491bf + pristine_git_object: 7dbb2a7f79ce9b964bedaf7e01cf3a51d7733670 + Codat/Sync/Expenses/Models/Components/Connections.cs: + id: 18af4a82b2d9 + last_write_checksum: sha1:cf419b8858a3f62a6b6fd73cd87ade759ee0f36d + pristine_git_object: ef88f1b74e8c5884fe700aa6ca51a0c0e8900fd6 + Codat/Sync/Expenses/Models/Components/Contact.cs: + id: 355dd83df3f1 + last_write_checksum: sha1:6a721ea1e74987491377d6babc92c9457dd2efdf + pristine_git_object: a72c81d165a65eef3148d605f790ea186ae4deb8 + Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs: + id: a9e81299c58f + last_write_checksum: sha1:7743a6881700fdec8bd4e43157ab35ad927a4adb + pristine_git_object: 4bd51f23f7236ce655f9d1d7caa2747062fd4be8 + Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs: + id: 414640db8ae4 + last_write_checksum: sha1:23b0f0a41983a8b9cbea04ef105a86b3ac63748c + pristine_git_object: bf09f8b44744b73659d7424b38a718e471aace72 + Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs: + id: 1eecf2b8dac6 + last_write_checksum: sha1:a0ac17be2d16f67691ed4fef211a5cbd1f98de7d + pristine_git_object: e1bd7d6761a8c94f049355d552cac4bacab3c5ca + Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs: + id: b8b80c7e3258 + last_write_checksum: sha1:ee12d5a84ff310e338e784949120a0c0181cbd5b + pristine_git_object: fcb77566d407a09c8348cac1cd4793463ace7ec7 + Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs: + id: b4747d6246ca + last_write_checksum: sha1:7ac352c03e5a21327cdabf83f4840c7497fc4f96 + pristine_git_object: e71074ff469567549790def6d674dfcd90448796 + Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs: + id: 3acbf9280408 + last_write_checksum: sha1:b55a066331a51981d8661f1c3d11e73bf213ebce + pristine_git_object: 2e32ed3c4e5b2fd31bff5df020905dd2a05b90a7 + Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs: + id: 28c007dc0e72 + last_write_checksum: sha1:daa8260864e99fa5562d103c03501c2430d55770 + pristine_git_object: 1f390403be3906c15cd2a5da1f504a302c04798c + Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs: + id: af4fcf842cc5 + last_write_checksum: sha1:fe13f7233d22e9b4a1361ccc42d339b18da34ec1 + pristine_git_object: 6c0ca59aeff7532a1881fd97fcb6203f307d3ac6 + Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs: + id: 6d67b76ac615 + last_write_checksum: sha1:23d949eaeb0253ef1dd67bfa5fa6606bdd0d4542 + pristine_git_object: 0431dc73c4c5eb0126dd2fe1665e0eb0255cbba1 + Codat/Sync/Expenses/Models/Components/Customer.cs: + id: 8468cb723923 + last_write_checksum: sha1:81829adaa295bb463c3ff32e1ef1e7e60a78420a + pristine_git_object: 880795fa86677e0636e3bf863ee868f59a3bcff1 + Codat/Sync/Expenses/Models/Components/CustomerDetails.cs: + id: 685f3ffda66b + last_write_checksum: sha1:35fd88c778656a893d4b91cb7a2fde2ceddbc6ea + pristine_git_object: 8a8485034653f42eba88f90d9d031ed5605a3adb + Codat/Sync/Expenses/Models/Components/CustomerStatus.cs: + id: 1fe5ad752196 + last_write_checksum: sha1:83ee805737278d72b065cd94657da2b44e26f097 + pristine_git_object: f8ed0d8ec0e4804586cb318a913671732b90021a + Codat/Sync/Expenses/Models/Components/Customers.cs: + id: 064e64ae2ca5 + last_write_checksum: sha1:ebab4c85ad9d9f2b806b0e0c38cb669ffef3200d + pristine_git_object: f284555434894e93d2ed237c244aab1b9e1d22fd + Codat/Sync/Expenses/Models/Components/DataConnectionError.cs: + id: a59a78d0116d + last_write_checksum: sha1:0e6a1d8ed4f35b1726f80eefa824c571cb7bcfad + pristine_git_object: eaba6c2e6862309099d11b6c6b631f303cdb7525 + Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs: + id: 2df92e9eded6 + last_write_checksum: sha1:d225443d4a03b82920fc560f1051174a8cf7a402 + pristine_git_object: dfea12d78be1f8cab2c273ff29ba5a4af3ad3969 + Codat/Sync/Expenses/Models/Components/DataStatus.cs: + id: 7fbcd471f2d7 + last_write_checksum: sha1:d0e04e15bbb63fe2be137d4ba7c319727346b8db + pristine_git_object: f2f463bcb18493622abbb3e9497a4cb553d85bdc + Codat/Sync/Expenses/Models/Components/DataType.cs: + id: b9c8fdb64851 + last_write_checksum: sha1:7361a82fbbd5eb8e23238d38abfa0af3198dc492 + pristine_git_object: 7b487da9a2c4166d1281b1fd5b2da81de5ca7e2b + Codat/Sync/Expenses/Models/Components/DataTypes.cs: + id: cc053553125c + last_write_checksum: sha1:095a7d54c6e72981531e478016faf0e891d1457e + pristine_git_object: cccfa587390748a4e2be094cd251c9e5b6d0029e + Codat/Sync/Expenses/Models/Components/DatasetStatus.cs: + id: 656edbdc9885 + last_write_checksum: sha1:539b31e911e75c0ed7e788e3be193d869682bc32 + pristine_git_object: d4758ec5a5371eef5052177950bb53c793d4e799 + Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs: + id: 0872b6305a58 + last_write_checksum: sha1:1d62cad5370e9c9c09989c00af59ef7732a9034d + pristine_git_object: 89cdfa775096610f28b425955cd22a0e9803637e + Codat/Sync/Expenses/Models/Components/ErrorStatus.cs: + id: e37cb2bab670 + last_write_checksum: sha1:f4af1911caf1c275d94f885a4fcfafa282be303d + pristine_git_object: 7bb3cbcd9f098f2f7480a52c67821773e284df4e + Codat/Sync/Expenses/Models/Components/ErrorValidation.cs: + id: daf0db53454e + last_write_checksum: sha1:515cdd782ef3690db14da2adfda95f74626c0787 + pristine_git_object: 6d394dd58409d4a790195b3708b8d446cea7c717 + Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs: + id: e082dac313ed + last_write_checksum: sha1:6748f4282b1e10b0ce46d3fd654c4ef5d6c1b663 + pristine_git_object: 110cb1a1acf73ead42df01be70c19c73bb713b3a + Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs: + id: 6a498dfdf331 + last_write_checksum: sha1:177e26316fd8fe8852dd529cb130021d02efee64 + pristine_git_object: 0017e8e9a90492c1ee70c43ab365215990072d09 + Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs: + id: 75b87b854694 + last_write_checksum: sha1:8827f21223111a3a96f9df3c3f510537c109022c + pristine_git_object: bbb64df9ab52002260a37ad5417799345c87d3c8 + Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs: + id: f797bc0cfbaf + last_write_checksum: sha1:1edc85111cd5e53a195b8ca47c1cca7aaac26cce + pristine_git_object: 7f2b6a5320fdca5e9939de84d27003a92cc9d332 + Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs: + id: 0a8382150501 + last_write_checksum: sha1:06a884047ccbc52330ab5b69549991546e25b07b + pristine_git_object: 567503052c08403bc82d7a1f19bf700ac20d4123 + Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs: + id: 7a2e06e8e782 + last_write_checksum: sha1:55d9f9b59b054d11be29aa6e352947ebe350acfc + pristine_git_object: ce3683f7ddcf9fafa233c70d10d74aa5bd001fee + Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs: + id: de23607eb0fd + last_write_checksum: sha1:ddd350c35e97535668a2a0f1ff3be67170820bbd + pristine_git_object: 016b7ae53ac0be16aced867ee3e9c60261efdbcf + Codat/Sync/Expenses/Models/Components/From.cs: + id: e9d8f07d0639 + last_write_checksum: sha1:f5e667947ae4dadb468e1779d9f14f4a3066ef70 + pristine_git_object: 362907e6e95f5bd6fcb2e2d93d32ecd4836c47b0 + Codat/Sync/Expenses/Models/Components/HalRef.cs: + id: b83c30ccdaac + last_write_checksum: sha1:38c6cf7c27fc5829ea7dc31e2803b80a4e1627db + pristine_git_object: afea9de1c0164ff25cd333814c8f8e58e467f959 + Codat/Sync/Expenses/Models/Components/IntegrationType.cs: + id: 9be00e8071cd + last_write_checksum: sha1:3ac587a7cc8d6f61371f991d2bb2eb26ec31f966 + pristine_git_object: 47f852b83a1405ce22dc66098719ed23f685ac07 + Codat/Sync/Expenses/Models/Components/InvoiceTo.cs: + id: da71fddeb449 + last_write_checksum: sha1:2335175703558e1376a995127964362019952a9e + pristine_git_object: c44652bda3527fa4f0e3cc4b8ff1374c25d47352 + Codat/Sync/Expenses/Models/Components/InvoiceToType.cs: + id: 551f9d1a77a6 + last_write_checksum: sha1:ac58e0404a6d5fc19a0228c4257fc81da58cf4ba + pristine_git_object: cdf3eedb2846411c3767e5a03897515ea31332c8 + Codat/Sync/Expenses/Models/Components/ItemRef.cs: + id: 226f73d84bfa + last_write_checksum: sha1:aac10e1eeff605f8eb88b979809d20349a9ad0e9 + pristine_git_object: c48eb01162209fbbf6821ba6177597cfad89a1f7 + Codat/Sync/Expenses/Models/Components/Items.cs: + id: 531be7f171b7 + last_write_checksum: sha1:5df01d5a0e462abe1c14efb07976e590a2da70a4 + pristine_git_object: c54063c64aa4442709daa49b970d12ba65838d20 + Codat/Sync/Expenses/Models/Components/ItemsType.cs: + id: cf880b76b86c + last_write_checksum: sha1:cac3f1871a9191ddae113b080c2bd3845c3f1233 + pristine_git_object: 407ea889c5ff720c97880b6659ca9cdea8fce520 + Codat/Sync/Expenses/Models/Components/Links.cs: + id: 3ad6ee29b6da + last_write_checksum: sha1:a3ec3ad38524fa8c2673484a871b7fcc9babde50 + pristine_git_object: 5657c36c4564ac2b83e106e164b6736ea4532e93 + Codat/Sync/Expenses/Models/Components/MappingOptions.cs: + id: f45dd7b12bff + last_write_checksum: sha1:11811161a8670ee4c167f13ed8e7c17d54322a9e + pristine_git_object: 285edff9e010a41b946459dbea8ef3aaed45ecea + Codat/Sync/Expenses/Models/Components/Metadata.cs: + id: 49e9ba85299e + last_write_checksum: sha1:ced71192a6ddd59ad1b79d907b5463a140f5e723 + pristine_git_object: 600a1822001a0bb7eeacc7b0b880d2cb435e48aa + Codat/Sync/Expenses/Models/Components/Phone.cs: + id: 457c69f76b48 + last_write_checksum: sha1:2c0bdb7ce86daabddf1abfbffafd58ae938b3fd5 + pristine_git_object: 3c4e88cbb5a6f6cc5310cb521ebf4317580e3479 + Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs: + id: 87a5e20ce020 + last_write_checksum: sha1:a15448f6268947644fb59e4a6bf9796938f3928d + pristine_git_object: d666d11d5a327388c91cebcfb1ba977a9a42dd42 + Codat/Sync/Expenses/Models/Components/PropertieDataType.cs: + id: 3bb5ebce9f1d + last_write_checksum: sha1:c7d8a77ecfc22e1e061a7b9ae16f3b09bd25e299 + pristine_git_object: fbbc9aaec1785a1310d6f4963e3a8967e57b1d77 + Codat/Sync/Expenses/Models/Components/PullOperation.cs: + id: 8c85d7c2e85b + last_write_checksum: sha1:dc5c51ffdf59882e738f586215a188e47f9e30d6 + pristine_git_object: 0403bbb00d9c7d19584b5b0fb6f0c66d62bd0679 + Codat/Sync/Expenses/Models/Components/PullOperations.cs: + id: c27e0896f18b + last_write_checksum: sha1:87baab54e8b1761387c7b08d6e41bfaa15eb4559 + pristine_git_object: 1de7f9999c79161940a7b61e5fad07ab667f4a9f + Codat/Sync/Expenses/Models/Components/PushChangeType.cs: + id: bf4b59674318 + last_write_checksum: sha1:e7c9228925c1a5280fe12169f3ecf006f2742bd6 + pristine_git_object: 14756af8af969d0e8416fecf2cf505579ee15da4 + Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs: + id: 61a790e8f8b7 + last_write_checksum: sha1:9cd5a7d90e94d786c6b4a4de04e9e096b27ce6b8 + pristine_git_object: c26c5d60b989a0a7095b821682b991bdc972f619 + Codat/Sync/Expenses/Models/Components/PushOperation.cs: + id: 549b278cab50 + last_write_checksum: sha1:38ec88eed6aa2c09398a9f8f7eb454684b552450 + pristine_git_object: 849daf9f7bf1410696ca94272424adf90fc4821e + Codat/Sync/Expenses/Models/Components/PushOperationChange.cs: + id: bc317af65304 + last_write_checksum: sha1:0802821bbdea024074b8441ec361c5eee15b1a40 + pristine_git_object: b87ec11347e0b08a510ca75f743a963f47bc6b17 + Codat/Sync/Expenses/Models/Components/PushOperationRef.cs: + id: 70b2d701cfa0 + last_write_checksum: sha1:0385919637edd85308cf9534c43cac6bdda6d6d5 + pristine_git_object: 3631aebf1136c5d242c8f203a625c76e91a3d36c + Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs: + id: 19623d155232 + last_write_checksum: sha1:a81e28170f88885f5a7771e3589d3b93d74c6cd5 + pristine_git_object: 494fca506a179cbc9bbe9bf4ee88eef911858814 + Codat/Sync/Expenses/Models/Components/PushOperations.cs: + id: d6c3cbe6c1bb + last_write_checksum: sha1:0f6e71331f8270254c83cbeb080f34ab18d2cf82 + pristine_git_object: 4f783dafc63208382b8524a7c831bdfba9fa01f1 + Codat/Sync/Expenses/Models/Components/PushOption.cs: + id: bd58b48524cc + last_write_checksum: sha1:ec945efeda4fe29c0b327bc1d09ff9d3f2fbfe8d + pristine_git_object: b4f79acb6b0e08ed8154e736834cbe390fd087d0 + Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs: + id: 8e974d63070a + last_write_checksum: sha1:a0ea5f7b2eb4c7252cae88730f1aeba6e8ef8ad4 + pristine_git_object: 076f2d073e1c6414edce3e0797f35376a810d7b7 + Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs: + id: e2356dccc843 + last_write_checksum: sha1:5616b1a8c72c56551ed9a33067aa212990a3bd43 + pristine_git_object: ea0f2bf81979984d7d8cae842b0bef530ce724b3 + Codat/Sync/Expenses/Models/Components/PushOptionType.cs: + id: cd103f47dbcc + last_write_checksum: sha1:39d9fb1d76a0460d93a2cc970c98327f50c47aa9 + pristine_git_object: c514b735da288c1163cf2aed7459a55700b5adf8 + Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs: + id: 4b8df3bc9e57 + last_write_checksum: sha1:19f5a6c42507361928694b0f8e4306919c311d95 + pristine_git_object: df84e0c16ed28d836887b4288c924697c7f50097 + Codat/Sync/Expenses/Models/Components/RecordRef.cs: + id: ba17342435fa + last_write_checksum: sha1:806c1506abd8b015642e43f1b467e118baea524b + pristine_git_object: e1b8627b6e597f47f011a0435bce5d25e6658542 + Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs: + id: 3c9f4d830c64 + last_write_checksum: sha1:254f31189524d21155958f2d67229b63797d0e6c + pristine_git_object: 605c14b8c7bfa5b5b0aea0bceffd89a1acf96156 + Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs: + id: 6931f0117957 + last_write_checksum: sha1:3de4f3a6cfbe38df1c81808171658a4e1382ea34 + pristine_git_object: 83a95bbbc66e49850e634e44a294b7e13cf4374e + Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs: + id: 15f3e281066b + last_write_checksum: sha1:8f31c45449acf5b5781189404c722ca0b2a6be6a + pristine_git_object: 4b279b8aee6df601d6129face317ccec1e81229c + Codat/Sync/Expenses/Models/Components/Security.cs: + id: e1406897adf1 + last_write_checksum: sha1:3b9dced2f0dc1bae7a89672315bf64e1f20cf264 + pristine_git_object: 5c1ed730f6c0c15c45da98104628c1112fe26e29 + Codat/Sync/Expenses/Models/Components/SourceType.cs: + id: 1d37a1dae7df + last_write_checksum: sha1:2c547f5ef490cb1a2c3768298cc406b49733ca26 + pristine_git_object: ab251fa0ca87ca9c726468cbb047f8883f933a55 + Codat/Sync/Expenses/Models/Components/Status.cs: + id: 2e4fed9c3aad + last_write_checksum: sha1:4e5c160d56423b0b950df6642cd2adc0926b1614 + pristine_git_object: 2efc9413e9e46db596a08311b6b64300ef10f89d + Codat/Sync/Expenses/Models/Components/SupplementalData.cs: + id: 884099e38bc8 + last_write_checksum: sha1:3265597f3f9519bfb9b07d400249633fac8bd118 + pristine_git_object: 71ef2e938350ade8238148668c6cffdd6c9004bd + Codat/Sync/Expenses/Models/Components/Supplier.cs: + id: 9e957944b253 + last_write_checksum: sha1:4d4bf93afecf8c1653af4e71c893be89a63f7c2c + pristine_git_object: fe261c24ffc51444756dd34f3b5a8b0344f173d4 + Codat/Sync/Expenses/Models/Components/SupplierDetails.cs: + id: 0e1e51dbfa99 + last_write_checksum: sha1:e1188338d1f9f0c3d735bd1b11683c3651046a85 + pristine_git_object: c2298d736cf0954a7ca45bb823ef50a7bed0cc3b + Codat/Sync/Expenses/Models/Components/SupplierStatus.cs: + id: e79516dc8cd7 + last_write_checksum: sha1:7eb219e170f6c93aa9e2d7ad13b756ea6f91bcaa + pristine_git_object: e67af650aa0ca16d691e7e2b76a5fedcec1627a6 + Codat/Sync/Expenses/Models/Components/Suppliers.cs: + id: c6b37f9b3d97 + last_write_checksum: sha1:c7b81049f3172e7f0d45e04b37de641276a5394e + pristine_git_object: 37b494be6ec626610de2cd2f71547da343680951 + Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs: + id: 98d072efe6aa + last_write_checksum: sha1:f5c413e57d236d90cd102a421415552b38787a59 + pristine_git_object: caf7ece7fba9db7223c2fdbe61f9ccbd7d7d5606 + Codat/Sync/Expenses/Models/Components/To.cs: + id: d179dea693e1 + last_write_checksum: sha1:2b6c050a3b21a9a98cd5e5a136247abc09bf48e3 + pristine_git_object: 71bfb56b97100872b2f9800e54d726950ce65921 + Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs: + id: 0c08686c6076 + last_write_checksum: sha1:875be7a938851a3135b4dde4fec66117e31ecb30 + pristine_git_object: 1874b70d3f4ea97d93cc3cc08d67e300f97a110b + Codat/Sync/Expenses/Models/Components/TrackingRef.cs: + id: 236d74eb09e1 + last_write_checksum: sha1:39dfbcab0d0e58811b7be02e5d08dcb203a7799f + pristine_git_object: ae54e55f459fda54c6f873285fe62e8984890c76 + Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs: + id: 158be74bf8a4 + last_write_checksum: sha1:2a60986ddb0fd7caa7ea60bafa2912a6150e71a9 + pristine_git_object: f756e4d2b2bbb0f984c1ae76a14ed18762c7b0e3 + Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs: + id: 21c2dad17a9c + last_write_checksum: sha1:e29cac2f5b65e1e190f17e34aad018aaefbbec03 + pristine_git_object: 1a5974767f6c2ccfdce5e30423166d51be988ee6 + Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs: + id: 3fd7d156df4d + last_write_checksum: sha1:e53334995aaf31e0b77984ab4063e393231fc2de + pristine_git_object: 392faaaad618e7e3a866fe276a018c3a3997fa28 + Codat/Sync/Expenses/Models/Components/Transaction.cs: + id: "131505028157" + last_write_checksum: sha1:2338f5fb11cae9487d1297c8ee49c88999cdae2d + pristine_git_object: ee698abc4a52251727008c2611d763454518a925 + Codat/Sync/Expenses/Models/Components/TransactionStatus.cs: + id: c5f7ff2573aa + last_write_checksum: sha1:7794a01781ab939e45cf26bcef61ba8c9fcf32df + pristine_git_object: a116bcf827d81609debdb8a8e75299b1d840e955 + Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs: + id: 736471ffedbb + last_write_checksum: sha1:59b4605b6fb1f100f4bcfd8e602ffc9196f1d4ab + pristine_git_object: c066430358e9e5fa2b132c12a8d7c9c991d5f63e + Codat/Sync/Expenses/Models/Components/Transactions.cs: + id: 7ebae240a2bc + last_write_checksum: sha1:c0e46249d08335d6cae473a11ba07452125a6819 + pristine_git_object: 436eeeb1db3dfa097419f9ba9816c26b3b9efc96 + Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs: + id: 5b3ad04bdca3 + last_write_checksum: sha1:ee6ce08a764c664cc80185418c85f2aefb33f3ce + pristine_git_object: d7ae436499bdc5681b15f330dd06b23da26f310f + Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs: + id: ae6ab268380c + last_write_checksum: sha1:58fe1cddd95e7920b9a8b3bc3984b52f4b9389ed + pristine_git_object: 6210a5ca00e02656dabee1a779905c3ae0d0f4cd + Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs: + id: 84e894f4bfc5 + last_write_checksum: sha1:73012abf453b77fc1570b1ab420cf1bff6c93fb5 + pristine_git_object: 83a8e3ec25b31b265f495eefd08c696190e1b674 + Codat/Sync/Expenses/Models/Components/Type.cs: + id: 10193b26377f + last_write_checksum: sha1:4df0976c3e54992917a9a4be75c9aba482d561bc + pristine_git_object: f24394c0620f4097c0188a2c04419ab056491385 + Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs: + id: 7c68683c7668 + last_write_checksum: sha1:ebd38a2543b6f846c125a7e4e34c1181b894d77f + pristine_git_object: 73c4ac2615b0c66a3bc82771b38cc80a26380802 + Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs: + id: 18fe4b482e09 + last_write_checksum: sha1:214dfc3a2f74f7ae3109e9c060fa6a98245ae6d9 + pristine_git_object: ff13d5caa9a11ef942cc6a06538f56d405df4f19 + Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs: + id: aa34b4b03435 + last_write_checksum: sha1:3e8f0647cd878d0bd32f2e574ca6fcdfbfafb341 + pristine_git_object: 27e35f022f6829f72e745342f55145e25e54fb2d + Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs: + id: c343b9d148cd + last_write_checksum: sha1:608771340bdd38ffb22db2cadcd3944ee0a85839 + pristine_git_object: 9a3ca93e4f56fbe7bd8d558c82f5d9fff8a10de6 + Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs: + id: 750a9687fac2 + last_write_checksum: sha1:e12a6fd50d5cbe3a24b74aeb583d9987786848c9 + pristine_git_object: 5bc41ad49e8ae8206928af890da7adc6cbab3685 + Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs: + id: 04eff925caeb + last_write_checksum: sha1:3514d8ece00d4c8262671522758695ff5eec8e5d + pristine_git_object: 57c77cf0bacac4122470afbf312791730f8d3dc1 + Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs: + id: 5e18125c15e0 + last_write_checksum: sha1:b11841e707f9a4eeacea3ae36e43826494e12615 + pristine_git_object: 4a5da770ae7c087b08f705d2bb287c5641f5cecf + Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs: + id: 4258e2831478 + last_write_checksum: sha1:d96a35df2c31a4a53c98d4016ffcada6c7916e89 + pristine_git_object: f037c430bbe1c5340c0703eb439e4fb46eae9e00 + Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs: + id: 2ff674f39493 + last_write_checksum: sha1:af25269a390ec49f77c06e24be09fbfec25a4211 + pristine_git_object: 17913385a645cac86d565a6fa3d9a14a90413fe1 + Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs: + id: 7193a97b048e + last_write_checksum: sha1:64642f9bda1654e5d297ef3ee63aa7f772e17633 + pristine_git_object: 9b284de75d53e26111b3e981a944a7c60bf85b00 + Codat/Sync/Expenses/Models/Components/ValidFor.cs: + id: 9ac2ef2d558c + last_write_checksum: sha1:7be198c38c693650f85f4088af87c165987e7eed + pristine_git_object: 47fdeb531f23f95db814f16a80921dc5449fb373 + Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs: + id: da9e3675d9b7 + last_write_checksum: sha1:8b68603cb94b47afaa1ae93123bbebfc6ca01bbd + pristine_git_object: 32935a881a4a4207fe6773ba4d9a122bf5f958d8 + Codat/Sync/Expenses/Models/Components/Validation.cs: + id: 7b6157cd0b18 + last_write_checksum: sha1:b5e28028b8339cf2b8fb65f2e82304d436d3e081 + pristine_git_object: 478abb4fe4fc9dbb74570e4a866fa3c4b5ba390f + Codat/Sync/Expenses/Models/Components/ValidationItem.cs: + id: 3bcd43587a76 + last_write_checksum: sha1:550b692f1730efc1bd9f195725e662f17c32eee3 + pristine_git_object: 9e38fde875fc4620744ed28d50b041ade4f5822a + Codat/Sync/Expenses/Models/Components/Weblink.cs: + id: b046dda0441e + last_write_checksum: sha1:e5ae0012f350900157198f58eefdf7066b0c5e59 + pristine_git_object: 4ee28335c37be97057e3770264f9550585f60916 + Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs: + id: 54f6625f0e69 + last_write_checksum: sha1:7e17f7e73162b827922dc7480d6b3af3ba5516b1 + pristine_git_object: 39f6b2d9c5762a71ecb6b3c54978308b5d785214 + Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs: + id: 305edc1dad23 + last_write_checksum: sha1:d48a65e1f249c773a772849cae7e5ac38fbee9c5 + pristine_git_object: 6b76eb4b3d2cc5e30a82ff3fb15e87ca00f41878 + Codat/Sync/Expenses/Models/Errors/ResponseValidationException.cs: + id: 6df8a6fbf120 + last_write_checksum: sha1:9918160e1a4270b943a9a3d6c875e72206f19ea9 + pristine_git_object: 7dcddadb20ff5a427891b05ae516cd0372deb8e3 + Codat/Sync/Expenses/Models/Errors/SDKException.cs: + id: 89d40eb3cffb + last_write_checksum: sha1:4a47085eb6290098c1034daad069d287f1d463aa + pristine_git_object: f0c3b0625e20d22afac6a7efea6506e13e62d748 + Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs: + id: f9a308fdef8b + last_write_checksum: sha1:bffd80e422695da2e919a157529d385efe511c1b + pristine_git_object: e6048b1cabefd802796f43674e191e77ef279275 + Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs: + id: 1427922977b5 + last_write_checksum: sha1:5139ad2f94b42b36baaa784c157351885100d9ed + pristine_git_object: 1b118a85a16ef9b68b469a59387d63e63aa3d177 + Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs: + id: e716a4cb73d7 + last_write_checksum: sha1:e9eebe8841ac3fa91f26730446bc0d8f7892e912 + pristine_git_object: cd13d7627899cfccea94bc3bf7072259bba45920 + Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs: + id: 81c4bf3f29a2 + last_write_checksum: sha1:37d8ea988c3d1d95c276b976cc2a887c7845fc4c + pristine_git_object: d7bff87bc31c636c8383f184b0cb61ecba7df26d + Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs: + id: 9c72887dde05 + last_write_checksum: sha1:4a40d8d267830d92919982b1ad5f23300e09b98b + pristine_git_object: 43c3490909e82200416a2e4de3a1c0c1ded124cd + Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs: + id: baa25376c482 + last_write_checksum: sha1:50cff7eb8785bfb15140b699c646c7ab07bbbc25 + pristine_git_object: fe8317d5393d4377f2ee7cc471e0da84c7a1abb0 + Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs: + id: 033e5eef70d9 + last_write_checksum: sha1:cd23d310a216b5954ed3d3f0eedfabc1c0c16e49 + pristine_git_object: f7805dbc091295912a88a55c4ec8d27e9592eeb0 + Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs: + id: c4d2b466e84b + last_write_checksum: sha1:9159564dcf9b67341a5468aa3766c3d2f038bf2e + pristine_git_object: 56a4843ba589a592260b63820e018cdf30062c60 + Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs: + id: a1f6d5a37549 + last_write_checksum: sha1:be59f0efb45fd730f22082c04f7c6299b66ca548 + pristine_git_object: d952ccde97eafa4ab475f7fc9c4a6c8dbb2dd679 + Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs: + id: afaa43ff0a42 + last_write_checksum: sha1:4aafe631d4b5a825bf93b9faf67e8fe58cd874ec + pristine_git_object: 1c18be38beff14c56cf6db54c1ac7d20f111caa0 + Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs: + id: 4748f120e5dd + last_write_checksum: sha1:933b48fd1f32b71e55b9d0785d7fc4452ad4d050 + pristine_git_object: f21ac7390b74f384a3083b6614f37478d82fe733 + Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs: + id: 2aa6c033da27 + last_write_checksum: sha1:7c2b92f3829ff3b1aec90be3d73657e9f8e343e5 + pristine_git_object: f2c65374582ccbb9bfafcdba6c8f6e5d4ec9e24c + Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs: + id: 073a316149bb + last_write_checksum: sha1:5be2553d6be687e445d06cc59536f03f77ada54a + pristine_git_object: 06bd6133830d581f7e27af460eb683c141bc9bc6 + Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs: + id: 64eba4d68c95 + last_write_checksum: sha1:04d8fb4eab23da723f3d03ca7b1e142e5b2293ec + pristine_git_object: d554d152909591f1aa33f3451c84711c0fbdd088 + Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs: + id: 44f7df6de3ee + last_write_checksum: sha1:726ccf6f64a3225fbc0e4611c15f3019a247f1d0 + pristine_git_object: d3a4b370cce51005498def2f7ef48999c247734d + Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs: + id: 14be07bbc6a9 + last_write_checksum: sha1:700d2e8d8ade28a535b84fdb3b647e46c6f0b6e6 + pristine_git_object: 0b63b658eff07c6f73a375a8d4d5ca22d275ec6e + Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs: + id: 875fb98d8675 + last_write_checksum: sha1:feb8c36ef84bc9cefa652bcee0e2a1d0274e0c5b + pristine_git_object: ee3cb900dea1183699507042a02820038e78f535 + Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs: + id: c7cd0191d228 + last_write_checksum: sha1:1ff9fb3dc3d70a08b1cff208528e6533b0306e42 + pristine_git_object: 69adc60874261289679eae013d308efdd4e38aaf + Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs: + id: 08d693fe1e26 + last_write_checksum: sha1:0f384a9907ba6278aa1a6d7b41f0b5d7285256b9 + pristine_git_object: b464320beb80a0db5bf29fb672a785b470c0c765 + Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs: + id: 90d3103812c1 + last_write_checksum: sha1:dd75d789472d951461b41f0bd85e9a13121fc746 + pristine_git_object: a86eba03610cbd233aaafc61f92c081a88cc6be8 + Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs: + id: 54b7afe1812a + last_write_checksum: sha1:42098a1658979afbaf3201fea630e4ccb5c8b339 + pristine_git_object: d6e8dad7cafb111ae077e6693b00de7b7c4fd1bd + Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs: + id: 90d9852f5f4d + last_write_checksum: sha1:df6974d83078a1cf812497574e97466074912e07 + pristine_git_object: 0faace09e1b8098702435c5ad6fa9c0655494d67 + Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs: + id: 7e2a0ea75cc4 + last_write_checksum: sha1:b2692719457e62101225de015c580faeeed40916 + pristine_git_object: d470737adb412139a4954da3a435003f2b6b90d6 + Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs: + id: af6a634119c1 + last_write_checksum: sha1:d277d5cf9dcf5662f0b96817b37f13c229bd65b0 + pristine_git_object: f24f92b4e14de38c990b0b5e84618f3e99d57ce7 + Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs: + id: 9be279df8046 + last_write_checksum: sha1:971a0db06b65f7b162d80926464c41e7030cc815 + pristine_git_object: cdb415390b1ca38252662d41ad4754f65fab5397 + Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs: + id: d45fbc491a29 + last_write_checksum: sha1:c9722a96193d5977f70197ed3414f57704cfc951 + pristine_git_object: 8eb69433fe2ba64192005f9fd5d95edb00d0df72 + Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs: + id: 7b23125a0eca + last_write_checksum: sha1:5f170357af19d653c2737a3384079b1e7ae73d3b + pristine_git_object: ed966e1592eebe5fbca62fe5ff04aeb63b264fb8 + Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs: + id: 49a0e1ca5da0 + last_write_checksum: sha1:90b66d5fdb16929eece8ea5fbeee3501958cad1d + pristine_git_object: f870d2b8d602531f0d9cea4f724d9703de5ab751 + Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs: + id: 6b615dfea40a + last_write_checksum: sha1:08f72ece7b51b5261ad7442664f52cdf06a1bd21 + pristine_git_object: 9cb6881fb1c353b60426cc6bc673d1f7c328a593 + Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs: + id: 005ec3d874af + last_write_checksum: sha1:c41a99004666e79623ae512cac478ca4a78d2bf8 + pristine_git_object: ea32319f0485ab43f1b01d8a1e19d2b508050f6f + Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs: + id: d932f6f3a239 + last_write_checksum: sha1:7007b9de961e8f1df0e9fba0ed18d92b0d4aa19e + pristine_git_object: 80e98b3b186ccdbc4b2b266204f4a10b8d3d30fa + Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs: + id: 091826bfbfc6 + last_write_checksum: sha1:f80f01785366f754bb5f98ba19e9226e282389b4 + pristine_git_object: aa4581bac7cb517b82f07a877a1a68cba42e7307 + Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs: + id: 15ce3ff4e47e + last_write_checksum: sha1:f586776ae1acb8b7d8079a1233ec5420640301b3 + pristine_git_object: 740429a066cea26410961d9a5c4c25f2aae7f901 + Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs: + id: 31211a023e53 + last_write_checksum: sha1:b602ebb04a158e683596c5b8160c2b24593a71dc + pristine_git_object: d9c86c01b3efb722f81675ca6c9bf822d3b4ad6e + Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs: + id: 6629f6656064 + last_write_checksum: sha1:e8d80ab8da0b4aeb77bc9c5a683ee52a2fa99cba + pristine_git_object: 1eb5851864ef50c8acd4d5477a72c5d07a76e9c2 + Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs: + id: d2bb7eae773a + last_write_checksum: sha1:737dcc92adb15f654dd59ff5bc36aef499f4550c + pristine_git_object: bc1929ab324eec8a21bc1f9eabb8b395ee23cad9 + Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs: + id: 0b53d6bddbd2 + last_write_checksum: sha1:418963f4448795acee82e9eee4bb39612a5e7aec + pristine_git_object: eb67dfbbedd6410b2acf22155935a938ea87ac69 + Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs: + id: b932134b5cd3 + last_write_checksum: sha1:094524740ec2e32e6c3710be3c25b43bbd396d48 + pristine_git_object: a2fc7e586a81879a381542306294ad5214ec4743 + Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs: + id: 461a377a1651 + last_write_checksum: sha1:9e7ea3bd4c00d73ed89fa99a29ebe7cc1b4e2056 + pristine_git_object: 9c57f8f721c15da40bf616c806ae9884c0845033 + Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs: + id: 86fb4b7193a2 + last_write_checksum: sha1:8b99cd6dc9e346eafcf25a5e9901734b22b111cd + pristine_git_object: 4a111de1e26f1a5f4824a4bbcb6aff73ef94582a + Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs: + id: 9aa3fbfdc038 + last_write_checksum: sha1:2afa40c64405159ba9a32ffa122fa2d43171127a + pristine_git_object: e2af04044d42d4f095ae3eb15bc16d2d3b278166 + Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs: + id: 263a906ad830 + last_write_checksum: sha1:a0db6acabf3fb70e715dd8347adb76902c9cb4f7 + pristine_git_object: 6cdfb43d53b02e046be979c92c440b5493f1fb9e + Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs: + id: dae52a5eb758 + last_write_checksum: sha1:1a84e05f992869b9a92f14fcf0a3a9db8bf5854e + pristine_git_object: 675b8c0aa1eb2ba7e321397823aa0a5d4351f5c9 + Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs: + id: 4cf89ac67eeb + last_write_checksum: sha1:30be3a5a9217facd1466ea23d5ea77b5735d305b + pristine_git_object: ab6842ef75c90a3ac6278ed957f6dbd8e7b94842 + Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs: + id: 49bd582d5c64 + last_write_checksum: sha1:50f4190e0cc36d196952256b0d044c2d38d96a47 + pristine_git_object: ce3d08716e23cc4e191aff7e4f70215f731a53e1 + Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs: + id: 4eb123b88b5a + last_write_checksum: sha1:ee7000f81013b4caa031f594402d383d06648ab0 + pristine_git_object: 51b74642f0b7c12dde0f1b13d43eb3736be25d00 + Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs: + id: 25c69290e30f + last_write_checksum: sha1:5668663085118c4e17f3e3cfe111ae3c9df6213d + pristine_git_object: c6b8762339b296d969772d9192c6fc4012701630 + Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs: + id: 0e0f2d3e1d02 + last_write_checksum: sha1:c2af8bcda8bed0ff15156d380b560ecf4223e7e6 + pristine_git_object: fe22488aa2be03a2dca6af64cdae23c5373c9c99 + Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs: + id: 61e0e67824a3 + last_write_checksum: sha1:60ab539001c98e48926b9c16de4ac55fc2a27205 + pristine_git_object: 0889cdf647234c41387f7c0fe5a6f0f671067bdb + Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs: + id: 4843ace4e5ac + last_write_checksum: sha1:7a74bf820d8a9358bb1d469b7a7a21fc081c6d5b + pristine_git_object: 8407922e1973b5dfeac9e243dac0097577db6dc0 + Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs: + id: f8c10b008494 + last_write_checksum: sha1:8b968b96dfce59cdcd99b88a19e89244d613f573 + pristine_git_object: 19c76a06ce1ad9236217511cb4c89b75d25f3979 + Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs: + id: a898fbe7f8a6 + last_write_checksum: sha1:7fa427ce9c5f241b271e1149f8055fca6a314ca5 + pristine_git_object: de0226cb28677a5020bc96b64a1236e7078ce2da + Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs: + id: 28c7e45e708a + last_write_checksum: sha1:7857580381494299a17b9bbe21c303a999936ba9 + pristine_git_object: feda737429025bf58ad8bc20d3a5f2f90af6d9d6 + Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs: + id: 62d4573aee8b + last_write_checksum: sha1:348502dd52534d90fcdf53484d994bb83804b265 + pristine_git_object: eb6b04bfcdf81215ca7fac52ce267613610a5b73 + Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs: + id: f18fc7585899 + last_write_checksum: sha1:fe00c8e7449cadc16aca8d83cae93c7d637214ef + pristine_git_object: caff39aebaadfb0e18ffc204a340a8858bbc4a2c + Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs: + id: 57f7b06c873c + last_write_checksum: sha1:aaa9927ab4edbee81519602619049bc1ee517399 + pristine_git_object: fd4cf2340028ab5e987190de6aec830ba8f1a276 + Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs: + id: 944446d52ef2 + last_write_checksum: sha1:4df6b8f0a119253d38ae6ed6519cc2cda5e52fd7 + pristine_git_object: 0d7f714078fb8d6141839438858512d4c3084f30 + Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs: + id: e4b140858897 + last_write_checksum: sha1:32d7692a50f676ca1977c1da7d1afa6aa06dbcf7 + pristine_git_object: 424e6e90c6b8c993423496828ac67fa33fd3a6aa + Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs: + id: 36f13968ef66 + last_write_checksum: sha1:794f17e07069ac7285a0eb0c7e3230d5042f896a + pristine_git_object: 51e9152c6301d645a86782343c79df865103d07f + Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs: + id: 08c971ba351c + last_write_checksum: sha1:ee8f73ad1ce1492a07344501f09dfec49256297e + pristine_git_object: 1672f1622869bea8057ed4838ea981ce3847bdf0 + Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs: + id: f828730492ba + last_write_checksum: sha1:2ab21cdeff56d92e66e3cc7db836ae941b6e88ad + pristine_git_object: f3be8b50823ced468f438de58ef9d522b5795c78 + Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs: + id: 0efbb43b1c07 + last_write_checksum: sha1:19a0aa0b92fe120a737232458c3a8dcd807d83f8 + pristine_git_object: af8f836f4bf213f049516d402d0cb561f15aa8b2 + Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs: + id: cc4cd7f032a0 + last_write_checksum: sha1:d74a709cc4f9bbdbeb835d0bd6f16e304dbcd79e + pristine_git_object: d3bef1d37203963e000403cfd8be8259e3e3d2da + Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs: + id: 6f126445c0e7 + last_write_checksum: sha1:51a5a51246b2ff44bf8e1b8a008a7a7873b81a91 + pristine_git_object: 207ee7ccdd025e034aedbed4e457f11f6775764a + Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs: + id: a9203706f8bf + last_write_checksum: sha1:da1a3ff029c6016e5df69a0ce7efe17351d2fcb1 + pristine_git_object: 903f7296cc6bf609cdea63f711b83a3eb6f3d602 + Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs: + id: d4ccef1f787d + last_write_checksum: sha1:cdd3f6c87ff2acbbdbce748e35860aab221305ca + pristine_git_object: 570ba3d50ef5af507d4e507a4c53bdf89e3823d0 + Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs: + id: 6202533e8f5f + last_write_checksum: sha1:b9f7e4e7848023f9a17d316e08a1df208860a38a + pristine_git_object: a332ec728fe5162f149233d1b5b0d9157fbb59b0 + Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs: + id: daf41ec5cd5d + last_write_checksum: sha1:4c2a8a920b47c2b034bd045934d79c9b31041e0b + pristine_git_object: 60533d1238cced7d2de925a6246330f5e0c95165 + Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs: + id: 7fdc8d470c46 + last_write_checksum: sha1:c94d342f68a46572e6d5ba58a628aca357667cc7 + pristine_git_object: cb4a42f998a9768eea456577464d8bd5fa4a8764 + Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs: + id: 94f3dfa7bbcf + last_write_checksum: sha1:7d6fd701b0c325edee16c9a685d636b9f3322de6 + pristine_git_object: 2a6555beba4683738bb53ba3fcc0f52b3150eafc + Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs: + id: a8604a95bb7d + last_write_checksum: sha1:30c7af75dd3a4a28a696a7e831e83aeb7715de3c + pristine_git_object: 0d037cb46dce828ce9b87bf9b800953573ca0638 + Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs: + id: 8d85abbf5553 + last_write_checksum: sha1:3d2ca3a62bf260b042549d4b3a49e6a1beebbb38 + pristine_git_object: 7acdb8fb4c94ac9955d180175cc4c052443d6165 + Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs: + id: 4c0d933b1c95 + last_write_checksum: sha1:e84df7bd4eea18e63a48a07c93c13ccef54a9b21 + pristine_git_object: 19e60dc0d5d7e9aed5fdf0e0b9b0c3a3115b750a + Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs: + id: f276677badc5 + last_write_checksum: sha1:c3667d83bc84620395f1db3155fcf64aa595ff09 + pristine_git_object: 251d7dd4e0e5f2a9efbbe5061690ee9d90e08e78 + Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs: + id: 10593579e53b + last_write_checksum: sha1:7dafa07420fe0eae5d9535fd7929cb4266ca2cb3 + pristine_git_object: 8ae5513b0c1be271a3c10c36a4bec5213f608a24 + Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs: + id: 6a603077bffe + last_write_checksum: sha1:0242a7a7e94499872ec0154ca809dee73fe41cdc + pristine_git_object: 9ee13ea126cf8c6bd753afcc5256c21945d92643 + Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs: + id: f62217333260 + last_write_checksum: sha1:6a544bf75ad74b0d63c5b891c132465a93ef3a5c + pristine_git_object: ee44c77d475efc6595f444300237c1b03aeb1160 + Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs: + id: 3b82a9d1254e + last_write_checksum: sha1:bedc1669825e18905cebafab0e77be0a655af2e7 + pristine_git_object: 88ccea074d3f6dc896de96c9df643fe6d68ea8f8 + Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs: + id: 205d50fdf843 + last_write_checksum: sha1:8066e8fe3c4c6908ca70f485875d0084f19f0cd7 + pristine_git_object: 791d338c15cdfd5506b52d4a6ade94e01f82593b + Codat/Sync/Expenses/Models/Requests/ReplaceCompanyRequest.cs: + id: e8079060e5b8 + last_write_checksum: sha1:03e8e15faa7be528b138ec7efc0f003ea4af9b2d + pristine_git_object: 4edf39400bfd4ac43b5f87d964c3b9b4d812fda0 + Codat/Sync/Expenses/Models/Requests/ReplaceCompanyResponse.cs: + id: 58ea4365cfc2 + last_write_checksum: sha1:7ea7e1b6a1bdfe5bbb3b94e0d0125f262728e669 + pristine_git_object: 3b78df3f0378832d15b3ee7a63ed61bcd65016ed + Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs: + id: 665ff0e0c063 + last_write_checksum: sha1:fbc097a637e1ab3d4b80eae449264472dc3a1932 + pristine_git_object: 3f78a74263a321e242f59041c0a992d20273c216 + Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs: + id: 38bb27f55108 + last_write_checksum: sha1:c82a4a80f0da1726ea9da934e20cd7d566163db3 + pristine_git_object: ac9dcd3895bf902b8a5707b71955c46c7390933c + Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs: + id: 6a8659d93f98 + last_write_checksum: sha1:eaecc2d57efd60dcfd6a57cafe96237dba844b00 + pristine_git_object: 900ff5b66861e72dc2848a8e3da5dfe842eb0bf9 + Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs: + id: 158f1cb67e14 + last_write_checksum: sha1:8bdcdcbaaacb29bd4a634b41d12c8e8641c477c5 + pristine_git_object: 651a10f47f76b13e7ca29d922519c2bdc5f21d63 + Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs: + id: 4936f4a379aa + last_write_checksum: sha1:e71820f92e9c6bf4614afc26d75b008caf44fef9 + pristine_git_object: b7288b35a19563fb3c0df227332157e4fbc38560 + Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs: + id: debe3d057478 + last_write_checksum: sha1:ecb6a7228367f541651828c4bd700b22558b12cc + pristine_git_object: 30846f0f00ba98cb7e923e2e2c59baa8f338ab3f + Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs: + id: 133087a2c1da + last_write_checksum: sha1:9f5d5cd76a1b4d1ad9ea0f8b237cee99b8bf7c06 + pristine_git_object: dffb32efe07e7f96850065051d6f9789f41a41da + Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs: + id: 38348077fae9 + last_write_checksum: sha1:124ccea28713b0d51339223324ddaca68c83ed8a + pristine_git_object: 89e9003b2c2986901c20c07307e5e97bc4f83dd3 + Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs: + id: 46f98b6cc1bc + last_write_checksum: sha1:29513ade01b0b6c6ecf93dbfbb2579293101b56a + pristine_git_object: c058e334e7476c2a385c7084ba74945bd6452b86 + Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs: + id: af57f025c792 + last_write_checksum: sha1:865d209ed46d5efd0ffda1a322e3e858cf8c547b + pristine_git_object: bf5fb197a17aad1c8c453c0181ba2dbed193704d + Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs: + id: dbbf110d00d8 + last_write_checksum: sha1:95001cd5bd80b64450c32ed02c93bf600b3c0e30 + pristine_git_object: ae2fa704e3b3c0824db97847a4fce3c746e49b4c + Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs: + id: 7a03b2e2dc77 + last_write_checksum: sha1:52d8cad9ff371c087dac5183e7a149806a7f389e + pristine_git_object: 6304fa5d78df40fa012250d8fe44c73b173b1e10 + Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs: + id: cbb124f54d73 + last_write_checksum: sha1:044ca42241e04c9068c0bdf4248a79b78718a616 + pristine_git_object: b5033dada250a1cdbaf6068be38129eb5a553626 + Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs: + id: 878657d61651 + last_write_checksum: sha1:510833ca9c3636f0e0dcc2b86d1bbaa8a67d3123 + pristine_git_object: 89391a7420132333a2df0f89da60fcceebda6050 + Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs: + id: ecfd0c4c746b + last_write_checksum: sha1:6f203c6f0291f26931d2b4437db857bcdeb3e6ea + pristine_git_object: 8869a59484dcbf3bf300bbb9315096e8c615b465 + Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs: + id: 69d7f95e75b1 + last_write_checksum: sha1:073d70e13993bf08226ac8c95471b585965cf611 + pristine_git_object: 15948d9599e2fa62a9e1d998367abd86548bf68b + Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs: + id: 2887e6bb9e1d + last_write_checksum: sha1:683d19361bcedb6b8490834542eb3cae17caa7eb + pristine_git_object: d042f8c65fe5a68e2eda96640bdda66841d372f7 + Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs: + id: 406d5a319efb + last_write_checksum: sha1:0b917a065f730401c15a791ae5e7c21ca1ec1e3e + pristine_git_object: 929bf74428d9f0835ce1cb9e0d2c4fdbc6aab939 + Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs: + id: 87cbe26eff49 + last_write_checksum: sha1:c918fa43ea378bac070286fffadc05c378f2fe5a + pristine_git_object: 20f77c4541760439ea452f2949e4879d46afaf0d + Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs: + id: 78a493289156 + last_write_checksum: sha1:4444ec22897e4f47a532c8197c48e3feedf5c186 + pristine_git_object: 61391e6db97648be323a5b8f9babb7f54e8a7ee6 + Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs: + id: 631170f5a05e + last_write_checksum: sha1:753c73d22fccc4a1bee9c3635b5828fa6fe7380d + pristine_git_object: 613238ec596890f211169fbc6f0df3b92f1fb4e3 + Codat/Sync/Expenses/PushOperations.cs: + id: 9f68bdda829a + last_write_checksum: sha1:d0b2eed1690ceda619d9fcd2b77f15261b149ce3 + pristine_git_object: 7609667d39598327e654e8f14194e2b297052933 + Codat/Sync/Expenses/Reimbursements.cs: + id: 3567cf5aa29a + last_write_checksum: sha1:5b11f0cdb5e00301b16d84240100b508ce48ff68 + pristine_git_object: 255d2a245cea8a2ff673a66d53845bddd0130f05 + Codat/Sync/Expenses/SDKConfig.cs: + id: a1f98b4a0c58 + last_write_checksum: sha1:2192be548458b68e322506c6fe77d3730798bc5d + pristine_git_object: cade67a132f8fd31000e069260361f4d8cea821e + Codat/Sync/Expenses/Suppliers.cs: + id: a9e03614b5f4 + last_write_checksum: sha1:d9284b7b3da999c73a3bb0b327057f878acb7a05 + pristine_git_object: d666a0b515f6216a8763d337b642795481556507 + Codat/Sync/Expenses/Sync.cs: + id: b5421ca3ac1b + last_write_checksum: sha1:700e6e71c04d338abdf61bf467f96af80a4323da + pristine_git_object: 2e043ec10aa2703cc8789e334ac6ad6667a1b00d + Codat/Sync/Expenses/TransactionStatus.cs: + id: e14b002f5f3b + last_write_checksum: sha1:7e34b32abd134a20bda7f907ec701050d43dc1ca + pristine_git_object: 3a820e206961a4242cb0edd7a5670d214d985bb3 + Codat/Sync/Expenses/Transfers.cs: + id: fb50654effd3 + last_write_checksum: sha1:7e7c141f3fa083ef2b506914f2dbfb539e83a8b2 + pristine_git_object: 53b6b368e3b4596a6f9f7acec6f74b362335e9e0 + Codat/Sync/Expenses/Utils/AnyDeserializer.cs: + id: d3f002ddb6b5 + last_write_checksum: sha1:d3bfb8f388ba3075492cee9b7a177966d6c916d2 + pristine_git_object: 352b733b3341379cf070e14cf43a0b0da69d0c0c + Codat/Sync/Expenses/Utils/BigIntStrConverter.cs: + id: 9c984073b49e + last_write_checksum: sha1:4f3ec9816c4c282187dbff0bc9b76ff0ce1f22ed + pristine_git_object: 944a372bbfa6f9d32d3fabec3e3f622a9b044f0e + Codat/Sync/Expenses/Utils/Constants.cs: + id: 54df56378cbf + last_write_checksum: sha1:c6c3452605f75d0ffdc662869fa76a1fd59e5d8d + pristine_git_object: f1e475b5833ac4ed9633fcb37a1c6f6e769ba1f5 + Codat/Sync/Expenses/Utils/DecimalStrConverter.cs: + id: 3367a988e547 + last_write_checksum: sha1:3bda730fb6157443e944918ed1060d78fa609b59 + pristine_git_object: f25f6976692a751dfe1edb47a277aca5a18cd90d + Codat/Sync/Expenses/Utils/EnumConverter.cs: + id: 85f3c82e281b + last_write_checksum: sha1:1adfb08cce73c4cd91153a99137e9d45cd9d3d2e + pristine_git_object: 83dfc6e6b4216a35d0d55ac20f86aa82e37fdefc + Codat/Sync/Expenses/Utils/FlexibleObjectDeserializer.cs: + id: b153911026bd + last_write_checksum: sha1:c08eea5512d36473bc2381f0b98d2a82e710d8b8 + pristine_git_object: b6019c0e4630f40f705e4d3d708e17a31a60c593 + Codat/Sync/Expenses/Utils/HeaderSerializer.cs: + id: 3f1212c6b424 + last_write_checksum: sha1:590998e9d648569bab0f64164dc4ebb5ea45f9f1 + pristine_git_object: f3ab8e627810804553400ba2cd62cc817c836326 + Codat/Sync/Expenses/Utils/IsoDateTimeSerializer.cs: + id: 0a7eff43f77b + last_write_checksum: sha1:fbed69b8d87e74e10adc85279110b43907598421 + pristine_git_object: aaa1a8bd09482d62d2a3bd560028108348103556 + Codat/Sync/Expenses/Utils/OpenEnumConverter.cs: + id: 699d687de514 + last_write_checksum: sha1:e6af722a04c717fcaf8c1dce2c0d98dc77fa7c39 + pristine_git_object: 509c637ffc98cbcaa90bb97f401e0997575a2655 + Codat/Sync/Expenses/Utils/RequestBodySerializer.cs: + id: e60ae327ee25 + last_write_checksum: sha1:4b92bd58c757f1a83745cc76e18d445806301a5a + pristine_git_object: 964d39ffddebfb89c1a2c2ce9ca919d4f96a5121 + Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs: + id: 139169de0cd7 + last_write_checksum: sha1:6e263d5a14d1345b026da7b5a7cd08234c700dc2 + pristine_git_object: 114ed4572066e9af3ead23a98f91a302d94e6ea1 + Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs: + id: 5339c27e8745 + last_write_checksum: sha1:29ba62cd4e06a9d0d8bd78d175dc355dcb1bd285 + pristine_git_object: 727bcc868ce517414d56541e6f08637f7964ce48 + Codat/Sync/Expenses/Utils/Retries/Retries.cs: + id: cc08d9d61add + last_write_checksum: sha1:7acede7389effb1727b72c249f757d0d5ed2df33 + pristine_git_object: e2ed2a909562ed903f486373532fdf8ce68a5e75 + Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs: + id: d2f6048e4307 + last_write_checksum: sha1:229fe39e682f266edb888a81f6ba4ba355debd21 + pristine_git_object: 7c3ec59a5d8eaf87a12fd933d826ae5e03aad500 + Codat/Sync/Expenses/Utils/SecurityMetadata.cs: + id: e3463e1438ab + last_write_checksum: sha1:8866b5f4a6a1cbe685a07f1873073a1e405fd381 + pristine_git_object: 581b96e543fff0dacf67ade27e454e071ea6f7e4 + Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs: + id: b1b11b6ede07 + last_write_checksum: sha1:5e81284b480c8d84f9db59f0083041cfd59e941d + pristine_git_object: 64a595ee89738941b56f73cffd7dd8d371c23b62 + Codat/Sync/Expenses/Utils/SpeakeasyMetadata.cs: + id: 562e9a94850f + last_write_checksum: sha1:33b9895f714a7a07cd641d07242d71e7bfe7b832 + pristine_git_object: b9716f21a2e41f28caacbef835b4d1c7b4af6cfb + Codat/Sync/Expenses/Utils/URLBuilder.cs: + id: 684ae300f26b + last_write_checksum: sha1:d916bff880ecb89110d709b155a48872a0007732 + pristine_git_object: 27c5d063eb36ea4d5c3f6b3118c6513e3f482106 + Codat/Sync/Expenses/Utils/Utilities.cs: + id: fe358d13e3d0 + last_write_checksum: sha1:0add85fc14546278bc58d2dea158b034cb0352dd + pristine_git_object: 334838c1dfc119117894aef076caa3ea57541ea7 + NUGET.md: + id: f4c8a442a6e5 + last_write_checksum: sha1:44076d5cb5116568062a7cfbee6fe3762bfd01e6 + pristine_git_object: 78dad91340076673e74116584c54f83f33ce1824 + USAGE.md: + id: 3aed33ce6e6f + last_write_checksum: sha1:576d332e8917a962813ca6afade08ff125863c88 + pristine_git_object: 2ce94d24b310622f55551261b02e2acc15a38797 + docs/Models/Components/AccountMappingInfo.md: + id: 52958ccd85f4 + last_write_checksum: sha1:6f9040d3ea740f6fe448286077204666c1ae86cf + pristine_git_object: c93eca18aaf2c71de1418ad3ce8d4b4c053d99da + docs/Models/Components/AccountMappingInfoAccountType.md: + id: be281a3a7f26 + last_write_checksum: sha1:970f4cb28f13d713a90f3b78a5e5cf560ab215fb + pristine_git_object: 7497047a5a5ce36010b0c995bb2a2f46c338ba48 + docs/Models/Components/AccountPrototype.md: + id: 8cdcad64c0db + last_write_checksum: sha1:448b3f854f3b3850b06621efaab4721530debda4 + pristine_git_object: 5c5b4671dcd9bcb360a4f7906a7d3484b93647c8 + docs/Models/Components/AccountReference.md: + id: 8732d80242be + last_write_checksum: sha1:98ca6947434171e58dc7d374468d3567d112ffde + pristine_git_object: e25f8016b79881eb8b1318a16038f79bd6ceb396 + docs/Models/Components/AccountStatus.md: + id: e56505065ab2 + last_write_checksum: sha1:01100fb52a7a1465e1dda4267f230b342f3bb2f7 + pristine_git_object: 3b31b1d5a240c83ad0e66ecf82ec4096c07bd64a + docs/Models/Components/AccountType.md: + id: 2b954dbcc0b2 + last_write_checksum: sha1:6cf654ffd5154f5ca592558121ec601708039085 + pristine_git_object: 1f465068bba2a174195af77670c8ea51dbf3ad96 + docs/Models/Components/AccountingAccount.md: + id: 9f3d83bb3728 + last_write_checksum: sha1:bf402450f48c793c0bb253abd30dfd9f36253f46 + pristine_git_object: 0545ee0c3c55bc4361e92c27ed23c93ef23542f4 + docs/Models/Components/AccountingAddress.md: + id: 52b8d15788b9 + last_write_checksum: sha1:20e52e6a6f09ba9aa011fa303beacbe3b0282897 + pristine_git_object: e71789507d79ed6cf3af08843e9311f67ee8e930 + docs/Models/Components/AccountingAddressType.md: + id: 22d4d6f3f407 + last_write_checksum: sha1:da1ffeec2432713d23f3ef6c2be47e8b4f2c730f + pristine_git_object: d92dee1f23bfdabaf218e1fc2ebf9ceb5f42fed1 + docs/Models/Components/AccountingBankAccount.md: + id: 415b7dc929ff + last_write_checksum: sha1:5247d81289249bfb524dd5f101596036aaf4ce5c + pristine_git_object: 3ce58ea7e58be246bdd06b87372a0aa5ea632dfb + docs/Models/Components/AccountingCustomer.md: + id: 46f59a268511 + last_write_checksum: sha1:5c6497dadacd3cba124f61d864ee4d43ed31c4e2 + pristine_git_object: 066b5da1d34ee8bb47edc129f7e78f366c7390c6 + docs/Models/Components/AccountingSupplier.md: + id: d4aea112b674 + last_write_checksum: sha1:434e954f0b88d9e3bfb7572dabdbab6782721477 + pristine_git_object: 53fe1c6e00e4b6200d7afd079b2834782bced4c8 + docs/Models/Components/AdjustmentTransactionLine.md: + id: 3443ca14f920 + last_write_checksum: sha1:656cf545b0e7e950a65d5c88e75d2441829e25e7 + pristine_git_object: 15542e3aa048f8038c2e800f9e1a4d62b8ffb1fa + docs/Models/Components/AdjustmentTransactionRequest.md: + id: e6fa1b009f2c + last_write_checksum: sha1:cab231cc50ab8d3fb529aa0897102b05d4378beb + pristine_git_object: bf67bfeb8cad1f5bebbca111762b6ee6ab819870 + docs/Models/Components/AdjustmentTransactionResponse.md: + id: 865555ddf649 + last_write_checksum: sha1:11d179a01da88082a53a683902fded623265e0e7 + pristine_git_object: 51c81dcfee8a42aa7e188a72357250998c21376a + docs/Models/Components/ApAccountRef.md: + id: 43fee2721eca + last_write_checksum: sha1:8e8b6eb53005557a331ef339a13606d4a3156f4b + pristine_git_object: 789a836a61352e5811d83ac01cce69817a181ab5 + docs/Models/Components/Attachment.md: + id: df237b715365 + last_write_checksum: sha1:1c5f26d5e1e8f08b5b48e51385bb302fde2cd8c5 + pristine_git_object: bed1c82b27a35dbadda290db18d62d131c1c67e9 + docs/Models/Components/AttachmentUpload.md: + id: 23332d819ce0 + last_write_checksum: sha1:5c8d5315005bffabc16e5b97f50e10057d28b53a + pristine_git_object: ce2b64654de55fb1b14fe8ead338aa9212724db2 + docs/Models/Components/BankAccount.md: + id: f63219418217 + last_write_checksum: sha1:1c15a5673f332c15d0fe5804f6dcbc933b37204f + pristine_git_object: 14d4b9a3ceb0f61b0c8448eaff2bf7253edec0a3 + docs/Models/Components/BankAccountDetails.md: + id: 4c8ca59ca0ff + last_write_checksum: sha1:fce146b57ad9c24f25b23f9b9b375925e900566d + pristine_git_object: 011d8c95e0d45800afd088fbfb332ff67d841bff + docs/Models/Components/BankAccountReference.md: + id: 4ab12f9ca14b + last_write_checksum: sha1:4e7d09c633dba82e95a15c0e7da80472a599a658 + pristine_git_object: 6568309e498ab6aca1e174a26188c7b22442478b + docs/Models/Components/BankAccountStatus.md: + id: 2e04c2652cc7 + last_write_checksum: sha1:11382652fb81f773f4aa32ff269625635cbdb9e3 + pristine_git_object: c27c76e6cc5d44998bba459c48a25fdd2bddfc3a + docs/Models/Components/BankAccountType.md: + id: 0560e30f7d5f + last_write_checksum: sha1:2462ec2ddb1d7987fbfb008dece10998b27050e6 + pristine_git_object: 44266602dd70add49608260a52c53748c72f41bb + docs/Models/Components/ClientRateLimitWebhook.md: + id: 76c3a2ac70a1 + last_write_checksum: sha1:2484e6e6a26741193199400c161723f5c372ce4c + pristine_git_object: b5ded115e678cd1fba759ce350b25c66bad90f26 + docs/Models/Components/ClientRateLimitWebhookPayload.md: + id: 56e0e7798a5e + last_write_checksum: sha1:1a7795dd1007642791299f3ec78d349d1ebb47ec + pristine_git_object: ba85388946a28ad7793134a481f5ae3cd7896f3d + docs/Models/Components/CodatFile.md: + id: 0cca107479b0 + last_write_checksum: sha1:e6c646213692731f42360190fa282d4eb84e6861 + pristine_git_object: 21a4956c29ce17027ce75d35d0e950907112b77f + docs/Models/Components/Companies.md: + id: 246c1946d2f7 + last_write_checksum: sha1:6767cd36f46b34a075db4da70d4bfc8a540a4ecf + pristine_git_object: 8aacbd8d53cd9a85ac67035a6c6eeff3cfd9eddb + docs/Models/Components/Company.md: + id: 4827695a19b4 + last_write_checksum: sha1:21c48315cfe4d5d812e1c39054d992e1f94c512e + pristine_git_object: dab61d6c13bc008c4b99e706efab155e1cdaefa0 + docs/Models/Components/CompanyConfiguration.md: + id: 80c07ffaca14 + last_write_checksum: sha1:121e6e12758870affb55a8a0b98ec39b15d4886f + pristine_git_object: ccb8ef31f2e98b89bd599da5c30a8d09930b9c77 + docs/Models/Components/CompanyInformation.md: + id: 046f1da41902 + last_write_checksum: sha1:3a06b7d1c911ffa6e7922480009c5cac10acf6dc + pristine_git_object: 58c53db1e23e50989720904fdaaa19c3c17d5cba + docs/Models/Components/CompanyInformationPhoneNumbersType.md: + id: 16ea1809b5c3 + last_write_checksum: sha1:324cc4496302c1af54e112eb27076935660e8760 + pristine_git_object: 59bab60d3c1abe4e79074108bbfb1a95d99c82c6 + docs/Models/Components/CompanyInformationType.md: + id: 689e357bcf50 + last_write_checksum: sha1:ce8bc5e5216bf421338614b6722f9e9ba6948d5b + pristine_git_object: fd5147e8c4bbcaa4f9d829bd78adb7db9c564e23 + docs/Models/Components/CompanyReference.md: + id: 7e01a182a597 + last_write_checksum: sha1:d8d4c91b6a53b56c9f5e2f5870d5f67c948b0409 + pristine_git_object: e1795c96792a675687fc583f9eb848d51ec4c24f + docs/Models/Components/CompanyReferenceLinks.md: + id: 64c32b92b754 + last_write_checksum: sha1:4dd0733752e32a5e740d6036d40df386e4329e82 + pristine_git_object: bbabdd5293c37d951b3557d0029a5c5a92d4666b + docs/Models/Components/CompanyRequestBody.md: + id: 442daaa3841e + last_write_checksum: sha1:c9efd43219c61b60c8787e0f5a1fb59d3f13e868 + pristine_git_object: 11705efb355c106127797a13170b01cea15140a6 + docs/Models/Components/CompanySyncStatus.md: + id: e42b080d4c2b + last_write_checksum: sha1:abf888de70dbca946d1cebb818cf5dcf06f43551 + pristine_git_object: c13c76bd816babfc1dbcf1d35d767eb4b3a1a8c0 + docs/Models/Components/CompanyUpdateRequest.md: + id: a56f577b7dd1 + last_write_checksum: sha1:04fb553b98adc9c012c4316827ad8b9bbb165f3d + pristine_git_object: 2e5fa23d7bb058f3ae24ddb1dd16b618858575c2 + docs/Models/Components/Connection.md: + id: 5688c7e8f7e9 + last_write_checksum: sha1:2899000a35f3fd220d59341f48e20356d4f97b8b + pristine_git_object: fbb1ac7e935c3949dce8ccc43711aeeef3e1e03d + 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:345f1e3bc0b7f4ea0d91c8daa9afaf9e3d00852d + pristine_git_object: 6ef6290118e0c43f7c7a32cd1e2c223382501f35 + docs/Models/Components/CreateAccountResponse.md: + id: 9abb6b4fa5b8 + last_write_checksum: sha1:d6267f310f371c854a325a127188cf5a4931987d + pristine_git_object: 47d00c1eaaf0fd7ec7ae4c06400a0150be348699 + docs/Models/Components/CreateAccountResponseMetadata.md: + id: 07d0cac60000 + last_write_checksum: sha1:aef25b438fd0fd933367d63a2d532f7a11a27754 + pristine_git_object: be17d6475d655384441558d319488f46b6d72305 + docs/Models/Components/CreateAccountResponseValidDataTypeLinks.md: + id: 82a1c4a54e04 + last_write_checksum: sha1:5d44710f72df4691b59bd9ce56709f53e42dd2b6 + pristine_git_object: 3ad957a3243e9aab868582bed8e9c41010c95422 + docs/Models/Components/CreateBankAccountResponse.md: + id: 7df361b089f3 + last_write_checksum: sha1:074a819f0730463be3f1f486cfce2fdf29e292e9 + pristine_git_object: 8e2bd056718105f144f64fd5221092757751a935 + docs/Models/Components/CreateBankAccountResponseBankAccountType.md: + id: ffc3cf6fda5c + last_write_checksum: sha1:eb3ff184dfab2c176246efb74650a9ba55ab5f3e + pristine_git_object: e5391ff156982f9def8e80ef0fd6f9ad7a72d487 + docs/Models/Components/CreateCustomerResponse.md: + id: a03ee39fd1a3 + last_write_checksum: sha1:61d8ef25f4fd03b9d06e10ba860ee61a97a1fa62 + pristine_git_object: ff2aae97a6d0104c5d4f377464942484297f76ee + docs/Models/Components/CreateExpenseResponse.md: + id: 36927361146d + last_write_checksum: sha1:8638ff204f6265b0bc61db372a5b915d0944dc58 + pristine_git_object: 54ae8e3bfea8252fea0300c6d7b43fb3b17585ee + docs/Models/Components/CreateReimbursableExpenseResponse.md: + id: 82f333b76a8b + last_write_checksum: sha1:ee4d7ea69624e1cd877a5170cffebdc5a835cb32 + pristine_git_object: 6f17a5483f6199ae6f5d7e0dc20771738d1ce61c + docs/Models/Components/CreateSupplierResponse.md: + id: 948cd688f41f + last_write_checksum: sha1:cf8238bd8a907095f6b312e36ba576bbf34325d9 + pristine_git_object: 67c7b462e18465bce0cbdba9294805722a95aec5 + docs/Models/Components/Customer.md: + id: 83d0cae7e9bc + last_write_checksum: sha1:b1d627129225d2fccaeb392d6b181a15d20b02fe + pristine_git_object: d6a6a00a2a969504e35375e589339c7850518429 + docs/Models/Components/CustomerDetails.md: + id: b5e88c3cea0e + last_write_checksum: sha1:f4c78442fa0699da652c5cecb68ded9d23411974 + pristine_git_object: 51cd4966b92ae02087d364fff2c0ff69e15c45d0 + docs/Models/Components/CustomerStatus.md: + id: 70c868344603 + last_write_checksum: sha1:668ce42b2c0cb8b6cfb1027e31080082fdeef91d + pristine_git_object: 59a54f7dedbe1ee4507dc10e91f707d7f56ee809 + docs/Models/Components/Customers.md: + id: dde9914e8675 + last_write_checksum: sha1:0fa12d5f4726d813a7e6dbc1de44563997b5b529 + pristine_git_object: a441414df0f6a1ec5b12e70d8538b0f7b9a92bd9 + docs/Models/Components/DataConnectionError.md: + id: 5dd8d2166aa9 + last_write_checksum: sha1:b4d88a730a6e98e92763c87ed51620b1eeaf45ae + pristine_git_object: 2e7779da343adc3bcde777c9dacc76734a8f223c + docs/Models/Components/DataConnectionStatus.md: + id: 100db3cb3431 + last_write_checksum: sha1:70e9a00b8b8b1270f32447b7f5b656e35ddcc1ae + pristine_git_object: 62f8cdd660854187e7c7c9428a4539dd99d797a9 + docs/Models/Components/DataStatus.md: + id: 0711ec31c484 + last_write_checksum: sha1:9b87ae1251554d0cd1f4e87554c9e696a89734b4 + pristine_git_object: 800c638efdd0c95df98ae965da29a345d80b9448 + docs/Models/Components/DataType.md: + id: ea9ccd5a7c4d + last_write_checksum: sha1:32ab613e5980268c37ce5660f3f5ab79548dfbef + pristine_git_object: 1de84b65123a4a309f99a264d430df862a3ee1dc + docs/Models/Components/DataTypes.md: + id: 5686eb82a4b9 + last_write_checksum: sha1:5d560c4f52e7189465829798344c77a182b79816 + pristine_git_object: c4602f1fd42f901c006080b608f9a66a01dd7803 + docs/Models/Components/DatasetStatus.md: + id: dacf1151ffb2 + last_write_checksum: sha1:c98558fddb037634d5cd641d0a2e4b338608e05a + pristine_git_object: 9c238e264af9d3ed7841ac752ec4b1c5193aa3ff + docs/Models/Components/DefinitionTransaction.md: + id: 18c4748645e8 + last_write_checksum: sha1:2ffae2ea040b6d23b55823d37576db6db2e02448 + pristine_git_object: 6b34907b2ff446f15cf14abcce893cf01f1c57a1 + docs/Models/Components/ErrorStatus.md: + id: 8de8545283c4 + last_write_checksum: sha1:05d4f8b74db3e7c267778d9925a9f67ffae69bf8 + pristine_git_object: 9b9eabd0119cbc762c7b11bc32b7ccca8b393652 + docs/Models/Components/ErrorValidation.md: + id: b9d95ce89516 + last_write_checksum: sha1:677582395d374eef93c9fab9ec1e069e6bdc1530 + pristine_git_object: 9d49d6fa622a06fa65c156bfdc58a5fc50e32361 + docs/Models/Components/ErrorValidationItem.md: + id: cdf407a86027 + last_write_checksum: sha1:726fb6472066f59a3bcbac265430235499e100ae + pristine_git_object: 6e0b6e5e3945b1fa7ad710c2b30d977332e20abe + docs/Models/Components/ExpenseContactRef.md: + id: 11b8e6518569 + last_write_checksum: sha1:fea477364d9eba725cc2a6051aae3faff5c38223 + pristine_git_object: 8c14ab853faffdf39908bae0d710f2f3716ea436 + docs/Models/Components/ExpenseContactRefType.md: + id: aa6c11eaa92b + last_write_checksum: sha1:366fac29e263d83b21f3f751f28531c8b7a9b88d + pristine_git_object: d456a9be2854f48b0b444c8264ac32c06a238549 + docs/Models/Components/ExpenseTransaction.md: + id: 45e490fdf26a + last_write_checksum: sha1:bc55362158385882f025970a73c3230849067726 + pristine_git_object: 6224fe06d61215b09bfe381c5323ec0d248b3b31 + docs/Models/Components/ExpenseTransactionLine.md: + id: 2209f5f9ed71 + last_write_checksum: sha1:6cd988f3d4b9cd3d597bab3c0b364f2859d3881f + pristine_git_object: 4abea8d47716d7f1483ba02181b930f702014c6c + docs/Models/Components/ExpensesSyncWebhook.md: + id: 267f2625f8b0 + last_write_checksum: sha1:8cd49e3303b7a4b1534cb96fbcef99843e0b9402 + pristine_git_object: 1958bc600511051d48fd5ae719d5f2f8823229fe + docs/Models/Components/ExpensesSyncWebhookPayload.md: + id: 71ec85e8d043 + last_write_checksum: sha1:9a3f36a89379bc4d48ea1156ae06fb5f56be4b3e + pristine_git_object: d923d4dc9bbc065b20b06a3d7804bb06fdd2a0e2 + docs/Models/Components/From.md: + id: 7599858f4583 + last_write_checksum: sha1:21f8e75465438a107e3e8b9f615492490722974e + pristine_git_object: c16d7a70e1af6c635ca5f6efc686b591764ee74d + docs/Models/Components/HalRef.md: + id: 4ef57d2f8806 + last_write_checksum: sha1:e939b73619984d87dd17850152acb1df5ec0e313 + pristine_git_object: ca171430470c4cefd9b63ff1872f9d4e02c6f083 + docs/Models/Components/IntegrationType.md: + id: 8b7ec261e7d4 + last_write_checksum: sha1:1d214250722043bf54d23b3b71ac25995c702311 + pristine_git_object: 1c5c26c0a99ddf0f47ab09153e2939d95a1c3fc8 + docs/Models/Components/InvoiceTo.md: + id: f0b96d7de650 + last_write_checksum: sha1:608442c83a82cbe7e8bbb55b7f669b603e788d11 + pristine_git_object: dfaf7cbc324a8db1288c1e44fe31f3b1dad70836 + docs/Models/Components/InvoiceToType.md: + id: e2cf0e532e14 + last_write_checksum: sha1:5f75ceff60511d5786c42d529a821d7543219584 + pristine_git_object: a3ea2358b9b9b943ff125a7af07c4a6dd01dbe16 + docs/Models/Components/ItemRef.md: + id: 46c5142a9b17 + last_write_checksum: sha1:afa44ee55d44935594d4dfa4b5ee6993df438db0 + pristine_git_object: 264a0e27d1185dc72ec11cc84d1773f636d46e95 + docs/Models/Components/Items.md: + id: f0ab0d1459e3 + last_write_checksum: sha1:205d0b49d407f9a0c8aa27a594f5ca2560bffe12 + pristine_git_object: c946ed9ae3ad9d3d9570f0f05ceb62d4985c5189 + docs/Models/Components/ItemsType.md: + id: c5a9f99558dc + last_write_checksum: sha1:e191aad792ee4e0922707c9e04b8f735b60c81b2 + pristine_git_object: 0fecb51a68ba84794e3b0e51c2dceb8571c2794d + docs/Models/Components/Links.md: + id: 96c82369ab69 + last_write_checksum: sha1:ca26d2590a5ec377cb1479f96f392963c8b32c59 + pristine_git_object: 0f1008779ac0f290bde00fcd4be663fa0c4753b6 + docs/Models/Components/MappingOptions.md: + id: 9b5fc050b347 + last_write_checksum: sha1:86c290834b6908bbe6ec085cff10ec53bd9ea87f + pristine_git_object: 9d730e03e06880a79ea2dbd058dde4057df870d5 + docs/Models/Components/Metadata.md: + id: 5b37a8eb1a69 + last_write_checksum: sha1:cf72e3408eb8b26e434c121af2b28d0645ba640f + pristine_git_object: df60bed3a1d2692595fcf38cbb688726bac60682 + docs/Models/Components/Phone.md: + id: 368a6b60a20e + last_write_checksum: sha1:494612130d52d1d5674bd1994c21d8446f5ded1b + pristine_git_object: 20c262b5f604e9c58a88064451c942155ad177f1 + docs/Models/Components/PhoneNumberItems.md: + id: 873fce12e3e7 + last_write_checksum: sha1:b2cd6dcc75d879d0398771fabd383a26d7a5a76a + pristine_git_object: b3af9cc121662e84b1a86b176a5ca510876fe68b + docs/Models/Components/PropertieDataType.md: + id: 762ec38da488 + last_write_checksum: sha1:4c5456e94abd1d95c29dc62427d16c10f2422fa7 + pristine_git_object: fa837c967894eb0eebbce76fb21e3050823485e2 + docs/Models/Components/PullOperation.md: + id: a8fc1e3b5979 + last_write_checksum: sha1:3212e7fa1f8a349658670aa49d809c07b5817d25 + pristine_git_object: 936c87ec5b596a13e1e465d77d255ad11b4324b9 + docs/Models/Components/PullOperations.md: + id: e0267625338f + last_write_checksum: sha1:0128b4a63904dcf68e352a0c4a4a96294e810776 + pristine_git_object: 1182fedc48eb770648d95755902f4b3de2dc924a + docs/Models/Components/PushChangeType.md: + id: 5685effee77b + last_write_checksum: sha1:549cb75fa73747387706c6c7d6129072f09a54d4 + pristine_git_object: 498c0ac926131e1981ffe9f995f02771236163ce + 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:5865d39364dd19f7f4772efaf7160a95fd39255f + pristine_git_object: e3a760fb2f2a13b81631ed8e613889912f9752ee + docs/Models/Components/PushOperationChange.md: + id: edcf91f1325f + last_write_checksum: sha1:ee2c15c62c0d6d8f0162132f565c2109478b6774 + pristine_git_object: 2f3c5bf26a5cb0c67ee69d89afb7bb35fef92d2f + docs/Models/Components/PushOperationRef.md: + id: a1bcf3d48092 + last_write_checksum: sha1:83a92bd478e57d0e8d6f01af2de506a951b3a5bb + pristine_git_object: 484517235eb18da7da15156e98d5b2986dd41868 + docs/Models/Components/PushOperationStatus.md: + id: 3359930e9d1a + last_write_checksum: sha1:fee9bedf40ab3416593b76d48a533edbd15afc04 + pristine_git_object: f34308de678f43db0759a460b025f68b52dfce86 + docs/Models/Components/PushOperations.md: + id: 3dfee1c26472 + last_write_checksum: sha1:ccc4d07173cfc456bc71de81715be4e1bc4b76f7 + pristine_git_object: be71718da375d7cba2e28258176a23ccc5c674f2 + docs/Models/Components/PushOption.md: + id: 9bdb5f1a9882 + last_write_checksum: sha1:0b3840625764d0beaa71498161a2b5ae78b0fb06 + pristine_git_object: b0045fb9381c82e4d4f4b2a72edb8767fa3ebad2 + docs/Models/Components/PushOptionChoice.md: + id: 91aeb1cd21a1 + last_write_checksum: sha1:81d622b00c395e1431a5dc44f15e8c6f91d8a45c + pristine_git_object: 8d69e5803ecac86e0d5748fcf52d581e66d05858 + docs/Models/Components/PushOptionProperty.md: + id: 33a6fa3ad626 + last_write_checksum: sha1:bdaee4640c760e48416c5805b3df926debb3966e + pristine_git_object: 30d421effdca873f3c4047fab0741f8b54153e0e + docs/Models/Components/PushOptionType.md: + id: 8aa224aff3cf + last_write_checksum: sha1:96f2e8cb537cefd4b779b857fe0bafde5160946b + pristine_git_object: 74da58c9259aa3400043cb5a25dd242acb4de2f7 + docs/Models/Components/PushValidationInfo.md: + id: a47e1d5b7c43 + last_write_checksum: sha1:7221d753ed7ecccff1ccede4bebcedc70c8c0dca + pristine_git_object: 56325691ae1317b1bf81ba4106c41db0b0c3f8b3 + docs/Models/Components/RecordRef.md: + id: c653e390527b + last_write_checksum: sha1:5d872a2bd0c9c5b61d45586369e4eefcbfa51a26 + pristine_git_object: 76e564d25bda93efd1eb823c9e4eeeb2a67f3113 + docs/Models/Components/ReimbursableExpenseTransaction.md: + id: 74cf334e9930 + last_write_checksum: sha1:41fdcf578a212cab02617d645fdd0d0c1fd5393a + pristine_git_object: 6de86b0073933d907286e468fcb925324fcba1ca + docs/Models/Components/ReimbursableExpenseTransactionLine.md: + id: b7c0c9e1eb1a + last_write_checksum: sha1:dfe0864fa99d781b8c9257faf58845ab8f26a1fb + pristine_git_object: 3953fed1484a98f3fde990e31b653c8152de2127 + docs/Models/Components/ReimbursementContactRef.md: + id: 4e1d1a7af01a + last_write_checksum: sha1:6fd20f2732516ab29ed3f72e31d2b7013914d187 + pristine_git_object: 657b590e55e6ebc7d68b3906f6afea50a8ea58a7 + docs/Models/Components/Security.md: + id: 7bcd54fda13a + last_write_checksum: sha1:afb3c4b0cb11e752dd6bf6890c9331d4d0adc0cd + pristine_git_object: a997c0213ebb03783bfda0a7559d0e1f0fd7d463 + docs/Models/Components/SourceType.md: + id: c28bbe36cebc + last_write_checksum: sha1:979a4c5c2e6b383eda5b298e4bb259558b806e44 + pristine_git_object: 42de0d7c7e1f2fe80c673c92a8a864aa5d3039a1 + docs/Models/Components/Status.md: + id: 71d0264ee613 + last_write_checksum: sha1:cb46dde1636aaa3b7e0ebbc8378d2a271adac55b + pristine_git_object: 860c4a888094f0796230a171fcf2867653dd78dd + docs/Models/Components/SupplementalData.md: + id: 6df6a4f00739 + last_write_checksum: sha1:c28abaeeee700c566fb4ee1288f22f8f9e2a7ad5 + pristine_git_object: 4dcab936a913b0f6ecf5140c50864608a5863ed4 + docs/Models/Components/Supplier.md: + id: 39dd0f0a8bd0 + last_write_checksum: sha1:2ff1f49ce0b37337a2ea8aee35c21045386c4546 + pristine_git_object: c088eb4027056b38004d66f716993d2b14c52275 + docs/Models/Components/SupplierDetails.md: + id: 07e4d0ea3420 + last_write_checksum: sha1:3ff29452e58326f9c1bca7b1fe9990eed0fcbd08 + pristine_git_object: 3fe1f7e6f9850647f1a2df32f3df648ed8218ccd + docs/Models/Components/SupplierStatus.md: + id: bcdaa17ab65f + last_write_checksum: sha1:6afd601ba976e1548602cc6bb0afb9193bd31c39 + pristine_git_object: 67d973034b01cddd27126b97f2ebfff570d396d9 + docs/Models/Components/Suppliers.md: + id: f3463fb08a9a + last_write_checksum: sha1:29170af232a2fd1788395561f7a264aac79b29d0 + pristine_git_object: 48cb69aae18afce4b3e508cd4650b7a468014bbe + docs/Models/Components/TaxRateMappingInfo.md: + id: a667c00cb9eb + last_write_checksum: sha1:5c9d2ba4f3e0ef21b81b9e652e991a3ae463a510 + pristine_git_object: 73a961d0ede1150be4a097b500fee21cc7de6a38 + docs/Models/Components/To.md: + id: b73f39a24e35 + last_write_checksum: sha1:42d5905d55964594aada3ccfb50171b9f78a8259 + pristine_git_object: a2b9c709535b3f9cbec843047f8cb409b8bb1cec + docs/Models/Components/TrackingCategoryMappingInfo.md: + id: b95507207c85 + last_write_checksum: sha1:6da8a4b4622efe83ecb90e730837840e5550c14c + pristine_git_object: fc4e1b0ddc9096937d7110de863a83ad7ea7b39d + docs/Models/Components/TrackingRef.md: + id: 2f5ee35bd7d6 + last_write_checksum: sha1:eb3d7d09bb1ad5a8b18689e7a98dc8770a0c6790 + pristine_git_object: 6bd67e4725a3973745348efcbd41020632bead93 + docs/Models/Components/TrackingRefAdjustmentTransaction.md: + id: fd8fcad86e4d + last_write_checksum: sha1:c3f8f16702fef2a542c59bd058a15b696bfca7b7 + pristine_git_object: 944566c1577de2f40a0635fef3f338630e6e34af + docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md: + id: 3c8707455769 + last_write_checksum: sha1:94f8b58ff89eb478163728302972d5d97a43afb9 + pristine_git_object: eef81d0d6c7d420b078e19db0f725405a4ca3bd4 + docs/Models/Components/TrackingRefDataType.md: + id: 2bfc0db9f1ac + last_write_checksum: sha1:031551c62029c00061309fb0d8b0cbd16051ca54 + pristine_git_object: dd4325629a1effa879314979dd396e988b94bdee + docs/Models/Components/Transaction.md: + id: 1c3c7e280d90 + last_write_checksum: sha1:037e9357fdc69e86b9f3bfcf914a46f0c4e7ef4d + pristine_git_object: 5e5ec4a4d448c1dcae1f2ebc9251ee321c60b124 + docs/Models/Components/TransactionStatus.md: + id: 0f6d28fb8d4c + last_write_checksum: sha1:cc6b0d80b83fffb919ec8be0f642c3777fe9ce94 + pristine_git_object: eb1447f77661a6fd0f6a9518d3aa22771b50341c + docs/Models/Components/TransactionStatus1.md: + id: b1d08ee11e1a + last_write_checksum: sha1:8a8e399720611021bd39bffbb9358886da70049e + pristine_git_object: 033bb3b570c5ceea89d5757a3b477da44691ec6d + docs/Models/Components/Transactions.md: + id: ff1a93f80f7d + last_write_checksum: sha1:8d9eac83aa9cf6824a10488e3dbbae2239c1d8dd + pristine_git_object: bbcfea38be0a996f03631ce8a067c2354876e92c + docs/Models/Components/TransferTransactionRequest.md: + id: bb07ddc73c6f + last_write_checksum: sha1:c64d4725a66e4f760dcb6ca0be77b1cca55def13 + pristine_git_object: c0b62814f3a4c6f3404ad4b19f3258c8d62f9716 + docs/Models/Components/TransferTransactionRequestAccountReference.md: + id: 45615da080ee + last_write_checksum: sha1:598ee017c52bae9628631c76c3748007e17ee07a + pristine_git_object: 35ec5258f168d5bfa1a1bc717ab76d76c7d338d3 + docs/Models/Components/TransferTransactionResponse.md: + id: 786893b7688f + last_write_checksum: sha1:b22357ab0da9bf476e97e21d9f48008b0813d81e + pristine_git_object: 679d16179e156fe986ed43a3cfb4930e87035776 + docs/Models/Components/Type.md: + id: 78fd88144819 + last_write_checksum: sha1:2cc06661a3ffea271f5dc47870658f31509d96c8 + pristine_git_object: cd10af446258dfa485f17ef7e49ad2f77cbd2c70 + docs/Models/Components/UpdateCustomerResponse.md: + id: 4b81a55a1e38 + last_write_checksum: sha1:4858a3a9c46f5941f627ad4fde874f7a15442325 + pristine_git_object: 498718a9efeb7eaceddd10f1d2d7294f12bcb388 + docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md: + id: c90677d4fb70 + last_write_checksum: sha1:4c147e1dd61a6510edd7ba52d95832f074740be1 + pristine_git_object: 78fb1ed668898e9cc243ff81c0dcc111a873dced + docs/Models/Components/UpdateExpenseRequest.md: + id: 3c736370cc03 + last_write_checksum: sha1:7b09e23bd7261a84dd0544bfe3a13c164df9d13c + pristine_git_object: 036fe7dec3b2f78bd4ba98f207484db3c79513e8 + docs/Models/Components/UpdateExpenseRequestBankAccountReference.md: + id: 5722aeb3a600 + last_write_checksum: sha1:20defbc72f549ee8acd6b13c79bf2374feb102d0 + pristine_git_object: 3380412d31ba799dad13e91f06cd8182b480143e + docs/Models/Components/UpdateExpenseRequestType.md: + id: 00d89acb65e9 + last_write_checksum: sha1:8a3c4efd9da6ed0f87a8b3e8e8fd53306e68b92c + pristine_git_object: e5091ac19c8f2d92a34edcc8df878b34a1cbeb78 + docs/Models/Components/UpdateExpenseResponse.md: + id: 561d0ddc75a9 + last_write_checksum: sha1:a0a3a3da3dd1e558f0c37af16f0fd25c5651079f + pristine_git_object: 709b6f8bad9b8115cbd977378b7df22308c564a6 + docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md: + id: 6d92cb6fe0fd + last_write_checksum: sha1:1f28762e00e4852af6d14c2b57c7f92e406f6513 + pristine_git_object: ae88bc8fd014a4502e83cdb6b6238ffa82d8af52 + docs/Models/Components/UpdateSupplierResponse.md: + id: 0eccfadc5e55 + last_write_checksum: sha1:36028fd33cddc7e5335ba57de28b350fe5ea7e81 + pristine_git_object: b7336aa3b21de628038198e7facc16aa6b7025c3 + docs/Models/Components/UpdateSupplierResponseAccountingSupplier.md: + id: a01055053db7 + last_write_checksum: sha1:531894d43b144e71b4a7bf9b9b0fe5ddc4004e35 + pristine_git_object: 968346cfe73e7011ea4b33c1afe5a353d97e7eea + docs/Models/Components/ValidDataTypeLinks.md: + id: becca358e044 + last_write_checksum: sha1:ea8ac2833efcedad217010e022990882a3840638 + pristine_git_object: b58662ceb463ee8e7bfdb16e64b6f678a14333a6 + docs/Models/Components/ValidFor.md: + id: d225e8200e2c + last_write_checksum: sha1:c9fe68c4d391e22b55132502c7eb2ed28cbda497 + pristine_git_object: 317f809312d4a80206c02db2bca0451ab0301082 + docs/Models/Components/ValidTransactionTypes.md: + id: 61ea133a69f6 + last_write_checksum: sha1:00e236d2ce66ee9923e507c54ce152f696d6ef92 + pristine_git_object: 8b5107f7614791c062e34e83d138f8a11c5f1b26 + docs/Models/Components/Validation.md: + id: 86473ac99ce1 + last_write_checksum: sha1:7bc91dbc5fc7c115f812f74acb959eaf278aa21d + pristine_git_object: bb042fd17c0feda4aec8add5b41959b6e3ef8326 + docs/Models/Components/ValidationItem.md: + id: 7266fa63cdb3 + last_write_checksum: sha1:a2e0412f291330be530e7a245d6b93b0c169085f + pristine_git_object: 99d28579246e4ce996e7e19d50ad764794b255eb + docs/Models/Components/Weblink.md: + id: 437981a9bca0 + last_write_checksum: sha1:63485ee1afceba8b3c79e76ade1319db3ce42ac9 + pristine_git_object: 2d4ca10ad3254bd0277ea6ce20812bf46d95acba + docs/Models/Errors/ErrorMessage.md: + id: 59d72a2b78b9 + last_write_checksum: sha1:aede0aa82c9fba75a2496535d5cea95c8180f73c + pristine_git_object: 375f0caa5dc4cce2c1456a387d75c396ac187078 + docs/Models/Requests/CreateAccountRequest.md: + id: 5cb1adef30b1 + last_write_checksum: sha1:6e76e66a70aa9032fda021f0d70ccf9a8e836b43 + pristine_git_object: 256fd90bae84347302fa492667b36f69ce1d9bf4 + docs/Models/Requests/CreateAccountResponse.md: + id: 6f4908642067 + last_write_checksum: sha1:81f61eb458937fefbb22dea4bd7e3bf46ce27371 + pristine_git_object: 2ceb00ef1778714d4fc21d25aa0a59943298cc1e + docs/Models/Requests/CreateAdjustmentTransactionRequest.md: + id: 4793bafa8c30 + last_write_checksum: sha1:07d876763f6dc6e7d82526ef4ab66931c8708b51 + pristine_git_object: 5b0b2091974354dfb53360ffd863ff164b6faf92 + docs/Models/Requests/CreateAdjustmentTransactionResponse.md: + id: 507b2f43abaf + last_write_checksum: sha1:2d71ea5c5271edf849e31a53ed1b8f561163fc32 + pristine_git_object: 00d3ff6b16de1b3fd324746e0a9a942353b76d34 + docs/Models/Requests/CreateBankAccountRequest.md: + id: a25992601305 + last_write_checksum: sha1:34cf6341bc2dad20cfc27dc16e2a82a0205077e1 + pristine_git_object: 3daf57efc7c03d26a7eb73bf70dbce82450539cb + docs/Models/Requests/CreateBankAccountResponse.md: + id: 43c6716abc9a + last_write_checksum: sha1:c3f13a7480a1dde8537b4e158e3e4b23e1746593 + pristine_git_object: 5a3bea1305e8bc4abb52793e54c541c32f5a64cc + docs/Models/Requests/CreateCompanyResponse.md: + id: cfc32cab5fa2 + last_write_checksum: sha1:278dfc86bd4e09633136307908375fcc5a554584 + pristine_git_object: ebbbbda7fdc03c282b4143a53dd03fc2c75d285c + docs/Models/Requests/CreateConnectionRequest.md: + id: ea17f2f26eed + last_write_checksum: sha1:ae1f8a7a67d9ca5fc290a7611eff5daa44a7b956 + pristine_git_object: 82be5a89068b1d570aa342f33b7ae72bf462637f + docs/Models/Requests/CreateConnectionRequestBody.md: + id: 13bdb3f1e63d + last_write_checksum: sha1:3063d4c37caf5d0571fc8ed582c9a50226c9b6b2 + pristine_git_object: 303023338dfd380c8f811e80d67d61dcfa459be4 + docs/Models/Requests/CreateConnectionResponse.md: + id: 296991307ac1 + last_write_checksum: sha1:d892c341c798bc5d0548f4b5a461edc55548a584 + pristine_git_object: c9a1df658612745ce9916b7100d81505134a2f6b + docs/Models/Requests/CreateCustomerRequest.md: + id: f22b0cf3082f + last_write_checksum: sha1:f2381902d4f56b8af784b7c891d481d46f82a0d6 + pristine_git_object: c631c88cc794c87d9e4e0843b03d4bc5f0a697f5 + docs/Models/Requests/CreateCustomerResponse.md: + id: d1e43da6d815 + last_write_checksum: sha1:f90dba63405797b3e3da4005f21635c794ee2d2a + pristine_git_object: 4449aedab1c47567356c791f0fdb202155b4bc54 + docs/Models/Requests/CreateExpenseTransactionRequest.md: + id: b2eb353c2638 + last_write_checksum: sha1:ad348f33882b4fa83acd0d8eff398c997c603b9e + pristine_git_object: 0d9ca70efe7e67df3d7e8abfe1adb0acdbbd2b70 + docs/Models/Requests/CreateExpenseTransactionResponse.md: + id: 3be5f0400272 + last_write_checksum: sha1:49652a6a5447bc3da922a1127f2f03eef3e69e07 + pristine_git_object: d77690b534c2e83d2ee4e82911164f49e046449c + docs/Models/Requests/CreatePartnerExpenseConnectionRequest.md: + id: 9aee79f29e01 + last_write_checksum: sha1:03bf47807f18da6d83f3a7cd3d7ff901ef04f497 + pristine_git_object: 2e80cc2d68f396f6949eeda1b34ea53903e0d45d + docs/Models/Requests/CreatePartnerExpenseConnectionResponse.md: + id: 8f3ff8a4d8de + last_write_checksum: sha1:7f91a27f61ea90adf637213355e626f1d2efd613 + pristine_git_object: 31ec9b88caa8bcc8982f6278e6e638ad5a9545af + docs/Models/Requests/CreateReimbursableExpenseTransactionRequest.md: + id: a23e12883bed + last_write_checksum: sha1:80c31903bf2607b6b1e07723dad9b472ae0b8d15 + pristine_git_object: e9c2fd225ed9144b3adb71e3e40b5c96339376fb + docs/Models/Requests/CreateReimbursableExpenseTransactionResponse.md: + id: 43cf0ca5e916 + last_write_checksum: sha1:809bb910923255548bea0d30c122f1dc57c32092 + pristine_git_object: 3e645ad3514db1ab69528a40ae2c530f3633f836 + docs/Models/Requests/CreateSupplierRequest.md: + id: afd5c52662d7 + last_write_checksum: sha1:33e4b0964dbda94864fca58c4974de4af33fe9a3 + pristine_git_object: c30741866f968be8fb50567bf62ecb77aef99d0f + docs/Models/Requests/CreateSupplierResponse.md: + id: c15ccce7cea4 + last_write_checksum: sha1:e98c3a05df04152d4913c671701c38399cbb667d + pristine_git_object: d721fd9b91d1222a09e3541803cf41f37707cc49 + docs/Models/Requests/CreateTransferTransactionRequest.md: + id: cb5373a8d0d7 + last_write_checksum: sha1:f468624971837ff4c933e227e0095777b1fcebb4 + pristine_git_object: beeacd921411ebc78e8c71739513e2fb046dfbad + docs/Models/Requests/CreateTransferTransactionResponse.md: + id: 7dc6c01c2cce + last_write_checksum: sha1:052bc73f6a435d1b3b422cfbd4fa8e5aa249791a + pristine_git_object: bb9a01c6890c05faf3ba1c4db350d3ef5dce2740 + docs/Models/Requests/DeleteCompanyRequest.md: + id: 648af31deb8b + last_write_checksum: sha1:9e3f4f795aad6591efb73848cf2a70c617dea1ec + pristine_git_object: f904d2c84655a379449b9c31ce666760d8ec5cb3 + docs/Models/Requests/DeleteCompanyResponse.md: + id: dbe048965eca + last_write_checksum: sha1:bc14b81759bbca45b06982ddab15a0bc30094559 + pristine_git_object: 503ad022105ca787a4c4c1a6aa2ddbb87abdc49e + docs/Models/Requests/DeleteConnectionRequest.md: + id: 59a9b310a32f + last_write_checksum: sha1:b4a46a3ba3236c3c4a93819ff7bc75215c58f032 + pristine_git_object: 3132fc2cfec48e479b767e78dfedb10f4e7b4632 + docs/Models/Requests/DeleteConnectionResponse.md: + id: cb910ab4c05d + last_write_checksum: sha1:daf41415e9a63b606c07e27493af9b9b8e977d64 + pristine_git_object: ce373caba7e53b86fa3a74ff11c52914beeb22d2 + docs/Models/Requests/GetCompanyConfigurationRequest.md: + id: ef5736cacea2 + last_write_checksum: sha1:5af2bcceb4bfb0347ea79a0f35096a8bbeb5c43e + pristine_git_object: 864d4c7c30d40f65b7a5f7ea538e407b9435f6eb + docs/Models/Requests/GetCompanyConfigurationResponse.md: + id: 384d7d705b4c + last_write_checksum: sha1:fe1871d2fdd41216f8e6ebc51acae53fbb6d495d + pristine_git_object: 462e21fac879db8c09a9c7d60f8a0a9aa9cde8b5 + docs/Models/Requests/GetCompanyInfoRequest.md: + id: 19a23a63b0e4 + last_write_checksum: sha1:72aa3253ecd221c3bd209c200cf3b7c736f0ad10 + pristine_git_object: 1b05b7febf6efe11c2da13be8d029b5a1fa79991 + docs/Models/Requests/GetCompanyInfoResponse.md: + id: 9f23af67d7c3 + last_write_checksum: sha1:b46d70547b939e385646c8b564b95b0433a5c514 + pristine_git_object: 7e60ce3c2e128d6f8578f495c817ceaf9517e654 + docs/Models/Requests/GetCompanyRequest.md: + id: d3f08c665a9d + last_write_checksum: sha1:2a5d0772b58020f36b42b784120e831b0e78ecb1 + pristine_git_object: b65ac93b3e3b337fcd283b6c0dbb3fa032fcee5e + docs/Models/Requests/GetCompanyResponse.md: + id: b49d5acc8f52 + last_write_checksum: sha1:2f04c91e3cf62f74cb8becfd547c398a0a8f2200 + pristine_git_object: 816d16523a09068618867800abbba073c32a3764 + docs/Models/Requests/GetConnectionRequest.md: + id: 55116a54bd44 + last_write_checksum: sha1:96b49d46b44f852fcf182df179d60db32b4c2ed3 + pristine_git_object: 5ebe8b8e55de1e2d14ee9c2215be4f49332e1b10 + docs/Models/Requests/GetConnectionResponse.md: + id: 0d0d4300ad6e + last_write_checksum: sha1:cac42cb0ba55fd388bb06d17c9f24d572e871318 + pristine_git_object: 84db1bc0b7b7dc5382b105e701892b7d6b7cdeb1 + docs/Models/Requests/GetCreateBankAccountsModelRequest.md: + id: 22ccb0d5ae56 + last_write_checksum: sha1:d1649295780d416fd3a43d1e8da9beae0801280d + pristine_git_object: 460c211b94ce62acfcbed79c942151e63fbc7b36 + docs/Models/Requests/GetCreateBankAccountsModelResponse.md: + id: dbace3d082d6 + last_write_checksum: sha1:71ba6e41dca97a7ed97eee3794c85e2910c0c0c5 + pristine_git_object: 5419fda9e4766c391448497f963fef85942b6a7c + docs/Models/Requests/GetCreateChartOfAccountsModelRequest.md: + id: dd7a13b1acc7 + last_write_checksum: sha1:92e133a13f284c946e059bec4acbb999f6d0746d + pristine_git_object: 31c27c6ef1dfec717a311f35fcbb8cd8d0ebfcd5 + docs/Models/Requests/GetCreateChartOfAccountsModelResponse.md: + id: c758c541ef24 + last_write_checksum: sha1:45cf36521927b1db3733946cdf79fa491e46540d + pristine_git_object: 54ecaa9d8043553ab91ab025f29f37e028583944 + docs/Models/Requests/GetCustomerRequest.md: + id: aa903ae6e5b8 + last_write_checksum: sha1:4e4c5753b22f3b52ffd4e9337d4ddbcdda97ca2d + pristine_git_object: a2f1f2d2162ee99aad06a093c3f146fd6e1d2688 + docs/Models/Requests/GetCustomerResponse.md: + id: 7bd222cac70a + last_write_checksum: sha1:3980b0eeb1805ec56fe49996251f15f03178f2e8 + pristine_git_object: 3eba7d2f947885dc1c841cca4dd077241bcedd1a + docs/Models/Requests/GetDataStatusDataStatuses.md: + id: 7e10b1655f40 + last_write_checksum: sha1:47eb97018a290dd8c6546a3260aa5a50491ca6c5 + pristine_git_object: 9f34b460dc27c1ecd01379a3bbaa1cdec08706aa + docs/Models/Requests/GetDataStatusRequest.md: + id: 53f2b3d24cbb + last_write_checksum: sha1:079e4cd38d58d1c83ab573d153af668fb6cc2c9b + pristine_git_object: b9b7f2356cb5cee0966ff37e8c1a851c19d82f2a + docs/Models/Requests/GetDataStatusResponse.md: + id: 0f460d70ea18 + last_write_checksum: sha1:fe00d796a5236a0590467b786c72c8f1a20c5854 + pristine_git_object: 5216c1c6460ee865c29a026df1688f5ed53a9906 + docs/Models/Requests/GetLastSuccessfulSyncRequest.md: + id: 2e89bb8d8b85 + last_write_checksum: sha1:1846492c83db4cefa1262b9e9ace0c1dddfaad6a + pristine_git_object: 6ab9e4045c30769dd7926f3b5ca2d80af624d653 + docs/Models/Requests/GetLastSuccessfulSyncResponse.md: + id: a06d9717ef0a + last_write_checksum: sha1:9f95cf58bf8b4b18fc00e01c6064da50e407c167 + pristine_git_object: 0dc9f201ac5cb141abadbdecb04294fbb277a213 + docs/Models/Requests/GetLatestSyncRequest.md: + id: e23165a64450 + last_write_checksum: sha1:3297aa6e1719555872dc88e1a4ec2b5dc87a104d + pristine_git_object: fc8116085cb561bc7882b952849bf414ed544ae2 + docs/Models/Requests/GetLatestSyncResponse.md: + id: 4e53a71b6aef + last_write_checksum: sha1:64c1e9981ad848bfff43248aecbeea69b3a7fa43 + pristine_git_object: 80cb006a2f3150ea44808131443424ebea249875 + docs/Models/Requests/GetMappingOptionsRequest.md: + id: 35366c580a34 + last_write_checksum: sha1:fb861d010aacc225c596111ece8c76d557248450 + pristine_git_object: 07355dcadf4450aeb9ca4c2b891bacbd18c81a8d + docs/Models/Requests/GetMappingOptionsResponse.md: + id: 4e11fc26e812 + last_write_checksum: sha1:b198927e799c82c10b1a7ff187f739b8532abae5 + pristine_git_object: 9b2f4ed915f47aa6cfdd6dc4357be5aadea42363 + docs/Models/Requests/GetPullOperationRequest.md: + id: 2da3afe1de5d + last_write_checksum: sha1:d5d4b4ffcab1b5f4bec9e25bd90b900050f3ff80 + pristine_git_object: 822a731355b05a90444cfa6de326856bb6e49cf6 + docs/Models/Requests/GetPullOperationResponse.md: + id: 9612dbed1da6 + last_write_checksum: sha1:586ac8d3123143b37783f1107455502275e7d0d5 + pristine_git_object: cf6d972b4bb1d2802c7a1a3faf367970648335b4 + docs/Models/Requests/GetPushOperationRequest.md: + id: f3821475d53b + last_write_checksum: sha1:a4e0b7caf1b5564e3250c5c02433f34b6a7133ad + pristine_git_object: 7725337aee817aa0cd3ba4c866122893b5160707 + docs/Models/Requests/GetPushOperationResponse.md: + id: 942a41bf5276 + last_write_checksum: sha1:ea6cf53d021612b929aeae6e93f15b0dbf3dbb9c + pristine_git_object: d98aba614aaff0ecb0bb15b615a9645f571ffc06 + docs/Models/Requests/GetSupplierRequest.md: + id: 35f38cb643df + last_write_checksum: sha1:89a2be8f79f4653efb1c74482d3513c670a7688e + pristine_git_object: fd9b1f775f12026cfc95a2562bdbfc8cb7a1923e + docs/Models/Requests/GetSupplierResponse.md: + id: 5490c9844a2d + last_write_checksum: sha1:1d69cc308c923a6cc774f2be8ebdcb39244a3138 + pristine_git_object: 3eab6f663f8ecee5fef0f6523a1d6575bf1f5c43 + docs/Models/Requests/GetSyncByIdRequest.md: + id: 3ceedd7db5f3 + last_write_checksum: sha1:b61be2b102ca27b439c64700eab4e36016862d9b + pristine_git_object: bfc593993167a3a63397ece46f53690501528534 + docs/Models/Requests/GetSyncByIdResponse.md: + id: 4a8c4d6863c6 + last_write_checksum: sha1:d7e68cdf8698d63ab5a529fb527ece2435a0fd6a + pristine_git_object: 24d0c6ff8624e3ae9107c9321a92688717665bb8 + docs/Models/Requests/GetSyncTransactionRequest.md: + id: 1252558903fa + last_write_checksum: sha1:7cf84ccccaeced51e82a3903a9f34547af3a97c6 + pristine_git_object: ae26dc069c9b4c64e125adfe1a9af846d7c84adf + docs/Models/Requests/GetSyncTransactionResponse.md: + id: 3d876aa21cdd + last_write_checksum: sha1:f23aae43b2f8dba5d9c8d08013e1edc192b216cf + pristine_git_object: fc439d4c3ac5269359d55675a60a3abadfe5e455 + docs/Models/Requests/ListCompaniesRequest.md: + id: 7ba05c60d65b + last_write_checksum: sha1:3cde84a069f3bd199f3cb04c7f0c2444a83552ba + pristine_git_object: 350f218c0123e7f7a00693689a2efe9884b4cc93 + docs/Models/Requests/ListCompaniesResponse.md: + id: 5ace27f2f4fb + last_write_checksum: sha1:58fb1979bd7e91e39e07e4d069b0be01a1240d10 + pristine_git_object: 26e3dde528d53fa237d3562059886e4ae8b8cd5d + docs/Models/Requests/ListConnectionsRequest.md: + id: 5ea7caf28403 + last_write_checksum: sha1:b27a417f6a13466e9b9a9d952216abca56bb496e + pristine_git_object: 1da5255ce43fc01920061e662236568de0f30ae3 + docs/Models/Requests/ListConnectionsResponse.md: + id: 5d5a6916f5f4 + last_write_checksum: sha1:b351065101f403c3aaecd989e3205300e1e1aba1 + pristine_git_object: 69f421519b106dd80ae57ee85b67950fda84a03e + docs/Models/Requests/ListCustomersRequest.md: + id: 5ae7ed17496d + last_write_checksum: sha1:e87a8278e724ce1f1bd21fef27cccc4f21735c68 + pristine_git_object: 9cf3629760f27b87861ae8cfcf339e291e0d34e3 + docs/Models/Requests/ListCustomersResponse.md: + id: 03a95481f3a1 + last_write_checksum: sha1:cc4cc36125ddbe912d0b197ee4c42ba6353ea6e9 + pristine_git_object: fd3ab9ed71c31d072e4832c2e5a101c78adf8f2b + docs/Models/Requests/ListPullOperationsRequest.md: + id: b06140334ea4 + last_write_checksum: sha1:7b1a7ae7cda3438c020c79b2c05a5d94d309f00b + pristine_git_object: fbae0962974a9eef4d9b2fc873e2dbf16bc76100 + docs/Models/Requests/ListPullOperationsResponse.md: + id: e0aec33984b0 + last_write_checksum: sha1:7389708336d57b00f2452de14ed8f8a54486ca5e + pristine_git_object: 08f339ea128d16466dfc96e5928575718c8b6366 + docs/Models/Requests/ListPushOperationsRequest.md: + id: 41cd61aa1d9f + last_write_checksum: sha1:c2deff38b64772c0cc97a376b17554b4637fb9c5 + pristine_git_object: 67eeca7b59a1adb8f47f036c156a856d6c7b1101 + docs/Models/Requests/ListPushOperationsResponse.md: + id: 3939d396c1e7 + last_write_checksum: sha1:4ba86c71f4d2ebbb9febcc85b082de78466d553d + pristine_git_object: 3c320f4ce80bd24cc684a8a08d81f7b7afb8a60f + docs/Models/Requests/ListSuppliersRequest.md: + id: f9e26d61a749 + last_write_checksum: sha1:9306e4eb0cea57959d11a7c53fc6047b100826df + pristine_git_object: a1225e65b0e4656f81d505f58ad86ca3f575440c + docs/Models/Requests/ListSuppliersResponse.md: + id: dab059f2c6e7 + last_write_checksum: sha1:8e97ed8671746ef2def685ce422cd59c46cbb7fa + pristine_git_object: 5ee3578eb98cc33c07a1358041ca1977465f64e6 + docs/Models/Requests/ListSyncTransactionsRequest.md: + id: e668ed468d0e + last_write_checksum: sha1:49f6e352b58aea148d22f6455eff2cf9ced6f251 + pristine_git_object: db2a43a999625836a3d73b715024f704bc7af9ef + docs/Models/Requests/ListSyncTransactionsResponse.md: + id: 2cbdc379ce8c + last_write_checksum: sha1:1aa1cb61cfcb687d7af4b332e273202f1a1b8204 + pristine_git_object: a28e9f621218d10a039d31a7e01b9ea35e818fe5 + docs/Models/Requests/ListSyncsRequest.md: + id: 1d2f713caecf + last_write_checksum: sha1:78c0d7d00011edd4c5d341cb556dd43a519dd333 + pristine_git_object: b08bafefc42ad62b43911cf8994f319234446d1b + docs/Models/Requests/ListSyncsResponse.md: + id: 769f3c09e649 + last_write_checksum: sha1:c1114148a83a3bd8eaf7ab953188e99bf9a92702 + pristine_git_object: be556bc0c17a5ba6e53608b123eddf8373c27eaf + docs/Models/Requests/RefreshAllDataTypesRequest.md: + id: a8841e256a98 + last_write_checksum: sha1:facedf74757a0d440c3b8aba8e66780b36195ece + pristine_git_object: 5af6d48c5e9320e53dda36a87fa657b73da120b0 + docs/Models/Requests/RefreshAllDataTypesResponse.md: + id: e672aa938076 + last_write_checksum: sha1:c6775b734ada57f459e3047b7b67848f0384fa67 + pristine_git_object: d7271032309d75c8171d74ef1f03d284a237b826 + docs/Models/Requests/RefreshDataTypeRequest.md: + id: 7476a674f8d5 + last_write_checksum: sha1:9110b9026a5a057a762178ba4d14fc46b2edd715 + pristine_git_object: 97b3cd24f65004595ad3e2d792a15c2ed41f13f7 + docs/Models/Requests/RefreshDataTypeResponse.md: + id: 74ed77843082 + last_write_checksum: sha1:0abff9d23d8a77642e21eebd560727b80757914c + pristine_git_object: 3d6a6efbe3300026d8a2eb4563f6093a75e98d2c + docs/Models/Requests/ReplaceCompanyRequest.md: + id: d6cd2bd48f75 + last_write_checksum: sha1:6fe90f5bd40cf0efd7540e6d8eaaf662e3505cf2 + pristine_git_object: b3b949cbb1528c01b55b70a94357b091276becd8 + docs/Models/Requests/ReplaceCompanyResponse.md: + id: 1b8c67e8f55d + last_write_checksum: sha1:68d4366960b748ad455e8e72b3b82d684b7e88aa + pristine_git_object: 46ff9ecbac96070af896dafb8a8826597389b547 + docs/Models/Requests/SetCompanyConfigurationRequest.md: + id: 796b98426c62 + last_write_checksum: sha1:11ba4623f9b0e2abbf2e59a9daf234e3ac93e215 + pristine_git_object: d67fee1f88369ce9d7863e779f18669663d5cd45 + docs/Models/Requests/SetCompanyConfigurationResponse.md: + id: debe0a969937 + last_write_checksum: sha1:40758868e27f6b68dda1fa1246ae1a73df5cb6c2 + pristine_git_object: 6ad5cd5d7f712882637bd8dbe08d497d50260879 + docs/Models/Requests/UnlinkConnectionRequest.md: + id: ef0b6070dff1 + last_write_checksum: sha1:fcf8ba79a029059eca540594e43388dfac16aed2 + pristine_git_object: d0fb2abaa694cef4fed22614bab97c3154b85dd3 + docs/Models/Requests/UnlinkConnectionResponse.md: + id: af3184a1e765 + last_write_checksum: sha1:21f48057af188b2f1bfecf58566f53013b4e9d89 + pristine_git_object: c4c577601f0141ab24263da460adc9ef1830f761 + docs/Models/Requests/UnlinkConnectionUpdateConnection.md: + id: 6f27b351f936 + last_write_checksum: sha1:8b618ce1c800a541139fde6f3c66e5c28d8db90f + pristine_git_object: 7cdc5825da2934771b0cd5944a388469204dcf55 + docs/Models/Requests/UpdateCompanyRequest.md: + id: a9e8c8ac4776 + last_write_checksum: sha1:235a0d4a264b5a5f92d253bb1cadcac8a248a770 + pristine_git_object: 2351dd6e62e957aa6a9f0f0ecc43a2ec039e9bcc + docs/Models/Requests/UpdateCompanyResponse.md: + id: 81c4ddd700b4 + last_write_checksum: sha1:ac8e7f37088d015ddb7ec4635ffc99ed51daee22 + pristine_git_object: 7df91368deff7f172400090cbdda219f7d58c4f5 + docs/Models/Requests/UpdateCustomerRequest.md: + id: 88e0061601e1 + last_write_checksum: sha1:5838c9938e967a730b914b308feb68031aa28dfb + pristine_git_object: 105c6be5731986358e8a664bc4d79de6aa161c85 + docs/Models/Requests/UpdateCustomerResponse.md: + id: b63aafb1a2f0 + last_write_checksum: sha1:44c7799070c2196235b92ae7af2237b2640efdc8 + pristine_git_object: 8bd7b3a32abe3aebc44d3308167c29ed3109326f + docs/Models/Requests/UpdateExpenseTransactionRequest.md: + id: 62f48d90d3e1 + last_write_checksum: sha1:a878f6fadc61602643cc3bb52d6b7790cd8ef442 + pristine_git_object: 1a83934f2a051fd350411e6c68472a9aa6a503e3 + docs/Models/Requests/UpdateExpenseTransactionResponse.md: + id: 0e3dde81b1c1 + last_write_checksum: sha1:bdb1431a5dc6f8dafcef7ca99bb971e10a0b01ac + pristine_git_object: a4bedee1389ae0d6dd9c260098bcd7acf4f6b3c5 + docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md: + id: 54a4cb1c9c67 + last_write_checksum: sha1:e7fb9f925a8682d4fb2139d08bca48ad95803fc4 + pristine_git_object: 88fa50615700ecf9a3c60d14b208bae416639305 + docs/Models/Requests/UpdateReimbursableExpenseTransactionResponse.md: + id: 67344cab3cbc + last_write_checksum: sha1:17abea1f73573b7d435e8a3f4f475734f598fc9c + pristine_git_object: 279a74366d25a71383e7540771edca6d3ad222e7 + docs/Models/Requests/UpdateSupplierRequest.md: + id: f643d15213a1 + last_write_checksum: sha1:86c5b264024cf7ba17c5b6a9c3d7422d8de60132 + pristine_git_object: ba6dc9267538145aac0831b7274dacc232c2494b + docs/Models/Requests/UpdateSupplierResponse.md: + id: 8c2815c6803f + last_write_checksum: sha1:93b0bf5cffbb948ec12a4cda3000a2911506289f + pristine_git_object: 69ca38ca0a6fa1bbbdeb1fa62203e655c124a341 + docs/Models/Requests/UploadExpenseAttachmentRequest.md: + id: 9b83fd1fe574 + last_write_checksum: sha1:fd9edbb40036fba81bb27580f618dddcd7674689 + pristine_git_object: 8f920add1c283775481b23af367cb4bc215ded84 + docs/Models/Requests/UploadExpenseAttachmentResponse.md: + id: 6280a0250500 + last_write_checksum: sha1:9f9263baced861da9cc5eb5c238cefac4022fd77 + pristine_git_object: 80fbb3005fa9366dd9741d62c012e4b62a6e5959 + docs/Models/Webhooks/ClientRateLimitReachedResponse.md: + id: c2fdaff5362d + last_write_checksum: sha1:55a031899f071b43c51844bd7be6711499eb100b + pristine_git_object: 7dbf08dbf61a190316d13ad765ed741783d76f15 + docs/Models/Webhooks/ClientRateLimitResetResponse.md: + id: d57017369cdb + last_write_checksum: sha1:cc433eb763f2a4fd0bb182d03f5adb2a99a60119 + pristine_git_object: 94e8224449b12d31bae84f283649675d21c0169f + docs/Models/Webhooks/ExpensesSyncSuccessfulResponse.md: + id: 868c02c93fa9 + last_write_checksum: sha1:c59c0d64d304a211aa43ee6f35c119e90cb344d6 + pristine_git_object: 53e196c5fe0369c49b73c0e6ba1a0d369fc5bc55 + docs/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.md: + id: 624957f3b23c + last_write_checksum: sha1:0a906e2ddf11ae1a995d032d8cc16171afd9e710 + pristine_git_object: 3d278f55b077482373d00d4a5167aa8bf079deed + docs/sdks/accounts/README.md: + id: d6c754b1ca96 + last_write_checksum: sha1:3e68ce51fd85eae5f2bc20a78d340fbbfca6edec + pristine_git_object: a1deef97cbe7d2898db7f2be5e0baf34108a88c9 + docs/sdks/adjustments/README.md: + id: e7bc3bb1d249 + last_write_checksum: sha1:1e80f6f5cec25b7efdd5554f0a1cd988aeef203e + pristine_git_object: 891412621f96fb7062c642ee56133ef6d511b8ed + docs/sdks/attachments/README.md: + id: b60e6ecf628b + last_write_checksum: sha1:0b90d831ccbb35bc168150392a504b54dd857d58 + pristine_git_object: e7e763e94ea22e00a1e5e551829f48b1a3715f35 + docs/sdks/bankaccounts/README.md: + id: 510ffee224ea + last_write_checksum: sha1:6b6193903a305b6fc8b0dc603357034f474a21c7 + pristine_git_object: 430f460bbf6e1deb612d36dae06414c1b7f0b51c + docs/sdks/companies/README.md: + id: 67e8a49afa67 + last_write_checksum: sha1:af37fe2c768c829348763322db3aa5d1aefe2033 + pristine_git_object: 873f291b948247d10080f78d72e8dfe076b390e4 + docs/sdks/companyinfo/README.md: + id: 198b84d5c0c5 + last_write_checksum: sha1:371b6986ac5429b7b765e6db26cf91547fe53c08 + pristine_git_object: b8b82cb8ebf5b4e992c8c59c4bbf38942a407140 + docs/sdks/configuration/README.md: + id: d3a07ea941dd + last_write_checksum: sha1:e328391a16f72e827791391c628b99813dda704f + pristine_git_object: c2136029ef09553eac4758c530a34ed10fd0ab56 + docs/sdks/connections/README.md: + id: 3ef8931411ea + last_write_checksum: sha1:72c7f275b75a564de13d73b00618d47bdb12e023 + pristine_git_object: ea152ea33145a1e091bdb6f07029099c4a791d02 + docs/sdks/customers/README.md: + id: 9332759cffc2 + last_write_checksum: sha1:9e7ff685cf0503783f743dd174d958becad163a4 + pristine_git_object: 31f8b56bcf1bb62ecd13edaa786c534ecf2a9603 + docs/sdks/expenses/README.md: + id: 5692d1aab79d + last_write_checksum: sha1:8eec3bab9b8b4b89327cf0ae935af7038d70b4c7 + pristine_git_object: 6375e0110355a26203e4e4ebf41e8f77418c2c3c + docs/sdks/managedata/README.md: + id: 5fccd800fae5 + last_write_checksum: sha1:311464b79e6e746df4c6a76b0a11d76d4e18458a + pristine_git_object: 0bd0ed6dfdf2c902cb5943c38f069ec793071413 + docs/sdks/mappingoptions/README.md: + id: 05c1205f046b + last_write_checksum: sha1:b28ab31a73c82f152884f54f563c69a0ac13ee78 + pristine_git_object: 9cf999c867bd088cb4514bf62940f52a4890d8d0 + docs/sdks/pushoperations/README.md: + id: 5f0b3f80f615 + last_write_checksum: sha1:5b7e8a2414799ac3075609509b67322138ff5946 + pristine_git_object: 74145cdc057462f9c5934886837ad1212b1b8130 + docs/sdks/reimbursements/README.md: + id: a5d637dcab67 + last_write_checksum: sha1:69e92b635d5e56028a2240cc559359dcfcb7fce3 + pristine_git_object: fdbb244044394d8000c8d2379239dee425f50309 + docs/sdks/suppliers/README.md: + id: 85867190cd79 + last_write_checksum: sha1:c8eba73edf86fd6789c86850a033f38d2ed3a9a4 + pristine_git_object: 0db8b2d0cb048c1ad78d65a5fb9237e702471bcf + docs/sdks/sync/README.md: + id: a2e09f86bd16 + last_write_checksum: sha1:f348b7652ea8806a944702eda3ea2601a779811d + pristine_git_object: 2acae3009a3de06c006a13099d1b8ebf3b92996f + docs/sdks/transactionstatus/README.md: + id: c3d24e0bf8e7 + last_write_checksum: sha1:78eb5b7948d4e43e075093163664cbc63705d0fe + pristine_git_object: a3375df2922481343e3d92c920a4ccd1cc590e55 + docs/sdks/transfers/README.md: + id: f56918861798 + last_write_checksum: sha1:a5d1bcd7bad85571fc8561de2e9bf08d0ff2b7b6 + pristine_git_object: b7206693023fe3776b5b5681d7cf6ae89ab2a27a + global.json: + id: 908e72401bf4 + last_write_checksum: sha1:3161b880f51cd74e7d1dea069b541d8bf4736dc9 + pristine_git_object: ef3195af86a7d6ef1e34296c380fd52d85b696fd examples: list-companies: - "": + speakeasy-default-list-companies: parameters: query: page: 1 pageSize: 100 query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee" orderBy: "-modifiedDate" + tags: "region=uk && team=invoice-finance" responses: "200": - application/json: {"results": [{"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "description": "Requested early access to the new financing scheme.", "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", "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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", "dataConnectionErrors": []}]}], "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} - "400": {} + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} One company: parameters: query: @@ -616,9 +2269,10 @@ examples: pageSize: 100 query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee" orderBy: "-modifiedDate" + tags: "region=uk && team=invoice-finance" responses: "200": - application/json: {"results": [{"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "My Test Company", "description": "My Test Company make testing software", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}], "pageNumber": 1, "pageSize": 100, "totalResults": 1, "_links": {"self": {"href": "/companies"}, "current": {"href": "/companies?page=1&pageSize=100"}}} + application/json: {"results": [{"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "My Test Company", "description": "My Test Company make testing software", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "products": ["spend-insights", "lending", "expenses-v1", "commerce"], "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}], "pageNumber": 1, "pageSize": 100, "totalResults": 1, "_links": {"self": {"href": "/companies"}, "current": {"href": "/companies?page=1&pageSize=100"}}} List of Companies: parameters: query: @@ -626,9 +2280,10 @@ examples: pageSize: 100 query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee" orderBy: "-modifiedDate" + tags: "region=uk && team=invoice-finance" responses: "200": - application/json: {"results": [{"id": "d1568dde-adf6-11ed-afa1-0242ac120002", "name": "Technicalium", "description": "Technology services, including web and app design and development", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}, {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "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"}}], "dataConnections": []}, {"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "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"}]}, {"id": "db94eddc-9212-4568-9b5c-3eab0e325913", "name": "Toft stores US", "redirect": "https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "platformName": "Oracle NetSuite", "linkUrl": "https://link-api.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/connections/1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}], "pageNumber": 1, "pageSize": 100, "totalResults": 3, "_links": {"self": {"href": "/companies"}, "current": {"href": "/companies?page=1&pageSize=100"}}} + application/json: {"results": [{"id": "d1568dde-adf6-11ed-afa1-0242ac120002", "name": "Technicalium", "description": "Technology services, including web and app design and development", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "products": ["spend-insights", "lending", "payables-v2"], "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}, {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "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"}}], "dataConnections": []}, {"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["lending", "spend-insights", "payables"], "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "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"}]}, {"id": "db94eddc-9212-4568-9b5c-3eab0e325913", "name": "Toft stores US", "redirect": "https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "platformName": "Oracle NetSuite", "linkUrl": "https://link-api.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/connections/1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}], "pageNumber": 1, "pageSize": 100, "totalResults": 3, "_links": {"self": {"href": "/companies"}, "current": {"href": "/companies?page=1&pageSize=100"}}} Malformed query: parameters: query: @@ -636,9 +2291,12 @@ examples: pageSize: 100 query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee" orderBy: "-modifiedDate" + tags: "region=uk && team=invoice-finance" responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: query: @@ -646,54 +2304,53 @@ examples: pageSize: 100 query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee" orderBy: "-modifiedDate" + tags: "region=uk && team=invoice-finance" responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-company: With no description: requestBody: - application/json: {"name": "Technicalium", "description": "Requested early access to the new financing scheme."} + application/json: {"name": "Technicalium"} responses: "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "referenceSubsidiaryCompanies": [], "dataConnections": []} - "400": {} + application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceSubsidiaryCompanies": [], "dataConnections": []} With a description: requestBody: application/json: {"name": "Technicalium", "description": "Technology services, including web and app design and development"} responses: "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "Technology services, including web and app design and development", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "referenceSubsidiaryCompanies": [], "dataConnections": []} - "400": {} - With a group: + application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "Technology services, including web and app design and development", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceSubsidiaryCompanies": [], "dataConnections": []} + With a tag: requestBody: - application/json: {"name": "Technicalium", "description": "Requested early access to the new financing scheme.", "groups": [{"id": "d7a6c4b4-dc87-45f6-b803-62f466398680"}]} + application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."} responses: "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": []} - "400": {} + application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "tags": {"region": "us"}, "referenceSubsidiaryCompanies": [], "dataConnections": []} Malformed query: requestBody: application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} - With a tag: - requestBody: - application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."} - responses: - "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "tags": {"region": "us"}, "referenceSubsidiaryCompanies": [], "dataConnections": []} - update-company: + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + replace-company: Update name: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"name": "New Name", "description": "Requested early access to the new financing scheme."} + application/json: {"name": "New Name"} responses: "200": - application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "description": "Requested early access to the new financing scheme.", "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", "sourceType": "Banking", "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"}]} - "401": {} + application/json: {"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", "products": ["spend-insights", "lending"], "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", "sourceType": "Banking", "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"}]} + "401": + application/json: {} + "500": + application/json: {} Update description: parameters: path: @@ -702,8 +2359,11 @@ examples: application/json: {"name": "Same name", "description": "Additional documents required"} responses: "200": - application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "description": "Requested early access to the new financing scheme.", "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", "sourceType": "Banking", "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"}]} - "401": {} + application/json: {"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", "products": ["spend-insights", "lending"], "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", "sourceType": "Banking", "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"}]} + "401": + application/json: {} + "500": + application/json: {} Unauthorized: parameters: path: @@ -713,29 +2373,73 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} - delete-company: - Unauthorized: + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-replace-company: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + requestBody: + application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."} responses: + "200": + application/json: {"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", "products": ["spend-insights", "lending"], "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", "sourceType": "Banking", "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"}]} "401": - application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} - get-company: - Simple company: + application/json: {} + "500": + application/json: {} + update-company: + Update tags: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + requestBody: + application/json: {"tags": {"refrence": "new reference"}} + responses: + "200": + application/json: {"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", "products": ["spend-insights", "lending"], "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", "sourceType": "Banking", "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"}]} + "401": + application/json: {} + "500": + application/json: {} + Update name: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + requestBody: + application/json: {"name": "New Name"} responses: "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores holdings", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "referenceSubsidiaryCompanies": [], "dataConnections": []} - With groups: + application/json: {"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", "products": ["spend-insights", "lending"], "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", "sourceType": "Banking", "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"}]} + "401": + application/json: {} + "500": + application/json: {} + Unauthorized: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + requestBody: + application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."} + responses: + "401": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-update-company: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + requestBody: + application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."} responses: "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "My First Company", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": []} + application/json: {"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", "products": ["spend-insights", "lending"], "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", "sourceType": "Banking", "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"}]} + "401": + application/json: {} + "500": + application/json: {} + delete-company: Unauthorized: parameters: path: @@ -743,22 +2447,50 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-delete-company: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "401": + application/json: {} + "500": + application/json: {} + get-company: + Simple company: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores holdings", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights", "lending", "expenses-v1", "commerce"], "referenceSubsidiaryCompanies": [], "dataConnections": []} Parent multi-entity company: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" responses: "200": - application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "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"}}], "dataConnections": []} + application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "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"}}], "dataConnections": []} Subsidiary multi-entity company: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" responses: "200": - application/json: {"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "description": "", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "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"}]} + application/json: {"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "description": "", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "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": [], "dataConnections": [{"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "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"}]} + Unauthorized: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "401": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} list-connections: - "": + speakeasy-default-list-connections: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" @@ -769,8 +2501,11 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"results": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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", "dataConnectionErrors": []}], "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} - "400": {} + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} Connections: parameters: path: @@ -795,6 +2530,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: path: @@ -807,6 +2544,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-connection: Connection: parameters: @@ -816,7 +2555,7 @@ examples: application/json: {"platformKey": "gbol"} responses: "200": - application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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", "dataConnectionErrors": []} + application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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"} Unauthorized: parameters: path: @@ -826,6 +2565,8 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} get-connection: Connection: parameters: @@ -834,7 +2575,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" responses: "200": - application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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", "dataConnectionErrors": []} + application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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"} Unauthorized: parameters: path: @@ -843,6 +2584,8 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} delete-connection: Unauthorized: parameters: @@ -852,6 +2595,18 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-delete-connection: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + responses: + "401": + application/json: {} + "500": + application/json: {} unlink-connection: Example: parameters: @@ -862,8 +2617,11 @@ examples: application/json: {"status": "Unlinked"} responses: "200": - application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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", "dataConnectionErrors": []} - "401": {} + application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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"} + "401": + application/json: {} + "500": + application/json: {} Unauthorized: parameters: path: @@ -872,6 +2630,20 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-unlink-connection: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + responses: + "200": + application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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"} + "401": + application/json: {} + "500": + application/json: {} create-partner-expense-connection: Malformed query: parameters: @@ -880,6 +2652,36 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-create-partner-expense-connection: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "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"} + "400": + application/json: {} + "500": + application/json: {} + get-company-info: + Example 1: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"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"} + Unauthorized: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "401": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} get-company-configuration: Unauthorized: parameters: @@ -888,16 +2690,44 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-company-configuration: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"bankAccount": {"id": "32"}, "supplier": {}, "customer": {}} + "401": + application/json: {} + "500": + application/json: {} set-company-configuration: Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"bankAccount": {"id": "32"}} + application/json: {"bankAccount": {"id": "32"}, "supplier": {}, "customer": {}} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-set-company-configuration: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + requestBody: + application/json: {"bankAccount": {"id": "32"}, "supplier": {}, "customer": {}} + responses: + "200": + application/json: {"bankAccount": {"id": "32"}, "supplier": {}, "customer": {}} + "400": + application/json: {} + "500": + application/json: {} get-mapping-options: Unauthorized: parameters: @@ -906,6 +2736,19 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-mapping-options: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"expenseProvider": "Partner Expense", "accounts": [{"id": "127f3b99-8dc2-4b7e-854c-91ef9bd2757b", "nominalCode": "300", "name": "Purchases", "currency": "GBP", "accountType": "Expense", "fullyQualifiedCategory": "Expense.DirectCosts", "validTransactionTypes": ["Payment"], "validFor": ["expense-transactions.Payment"]}], "trackingCategories": [{"id": "DEPARTMENT_2", "name": "New York", "parentId": "DEPARTMENTS"}], "taxRates": [{"id": "23_Bills", "name": "20% Bill tax Bills", "code": "20% Bill tax", "effectiveTaxRate": 20, "totalTaxRate": 20, "validTransactionTypes": ["Payment"]}]} + "401": + application/json: {} + "500": + application/json: {} get-last-successful-sync: Unauthorized: parameters: @@ -914,6 +2757,19 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-last-successful-sync: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"companyId": "d4d73051-ed31-42b6-99f6-d288cd940992", "syncId": "a6a22aff-a43a-411d-a910-2dae73217cce", "syncStatusCode": 2000, "syncStatus": "Complete", "syncUtc": "2022-10-23T00:00:00Z"} + "401": + application/json: {} + "500": + application/json: {} get-latest-sync: Unauthorized: parameters: @@ -922,6 +2778,19 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-latest-sync: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"companyId": "d4d73051-ed31-42b6-99f6-d288cd940992", "syncId": "a6a22aff-a43a-411d-a910-2dae73217cce", "syncStatusCode": 2000, "syncStatus": "Complete", "syncUtc": "2022-10-23T00:00:00Z"} + "401": + application/json: {} + "500": + application/json: {} list-syncs: Unauthorized: parameters: @@ -930,6 +2799,19 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-list-syncs: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: [{"companyId": "d4d73051-ed31-42b6-99f6-d288cd940992", "syncId": "a6a22aff-a43a-411d-a910-2dae73217cce", "syncStatusCode": 2000, "syncStatus": "Complete", "syncUtc": "2022-10-23T00:00:00Z"}] + "401": + application/json: {} + "500": + application/json: {} get-sync-by-id: Unauthorized: parameters: @@ -939,6 +2821,20 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-sync-by-id: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + syncId: "6fb40d5e-b13e-11ed-afa1-0242ac120002" + responses: + "200": + application/json: {"companyId": "d4d73051-ed31-42b6-99f6-d288cd940992", "syncId": "a6a22aff-a43a-411d-a910-2dae73217cce", "syncStatusCode": 2000, "syncStatus": "Complete", "syncUtc": "2022-10-23T00:00:00Z"} + "401": + application/json: {} + "500": + application/json: {} list-sync-transactions: Malformed query: parameters: @@ -951,6 +2847,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: path: @@ -962,6 +2860,23 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-list-sync-transactions: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + syncId: "6fb40d5e-b13e-11ed-afa1-0242ac120002" + query: + page: 1 + pageSize: 100 + responses: + "200": + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} get-sync-transaction: Unauthorized: parameters: @@ -972,6 +2887,21 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-sync-transaction: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + syncId: "6fb40d5e-b13e-11ed-afa1-0242ac120002" + transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" + responses: + "200": + application/json: [{"transactionId": "aa02271d-ed5f-47f5-be76-778d5905225a", "status": "Completed", "integrationType": "expenses"}] + "401": + application/json: {} + "500": + application/json: {} create-expense-transaction: Payment: parameters: @@ -982,23 +2912,29 @@ examples: responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} - "400": {} + "400": + application/json: {} + "500": + application/json: {} Refund: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"id": "7008d3f2-aeb4-11ed-afa1-0242ac120002", "type": "Refund", "issueDate": "2024-02-17T00:00:00+00:00", "currency": "GBP", "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "42"}, "trackingRefs": [{"id": "DEPARTMENT_6"}]}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590"}] + application/json: [{"id": "7008d3f2-aeb4-11ed-afa1-0242ac120002", "type": "Refund", "issueDate": "2024-02-17T00:00:00+00:00", "currency": "GBP", "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "42"}, "trackingRefs": [{"id": "DEPARTMENT_6", "dataType": "trackingCategories"}]}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590"}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} - "400": {} + "400": + application/json: {} + "500": + application/json: {} Example 1: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"id": "a44135b0-6882-489a-83fe-a0c57a4afb19", "type": "Payment", "issueDate": "2024-05-21T00:00:00+00:00", "currency": "GBP", "currencyRate": 1, "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "35"}, "itemRef": {"id": "80000002-1675158984"}, "trackingRefs": [{"id": "DEPARTMENT_3", "dataType": "trackingCategories"}, {"id": "e9a1b63d-9ff0-40e7-8038-016354b987e6", "dataType": "trackingCategories"}], "invoiceTo": {"id": "504", "type": "customer"}}], "notes": "amazon purchase"}] + application/json: [{"id": "a44135b0-6882-489a-83fe-a0c57a4afb19", "type": "Payment", "issueDate": "2024-05-21T00:00:00+00:00", "currency": "GBP", "currencyRate": 1, "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "35"}, "trackingRefs": [{"id": "DEPARTMENT_3", "dataType": "trackingCategories"}, {"dataType": "trackingCategories"}], "invoiceTo": {"id": "504", "type": "customer"}}], "notes": "amazon purchase"}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -1007,10 +2943,12 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"id": "a44135b0-6882-489a-83fe-a0c57a4afb19", "type": "Payment", "issueDate": "2024-05-21T00:00:00+00:00", "currency": "GBP", "currencyRate": 1, "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "35"}, "itemRef": {"id": "80000002-1675158984"}, "trackingRefs": [{"id": "DEPARTMENT_3", "dataType": "trackingCategories"}, {"id": "e9a1b63d-9ff0-40e7-8038-016354b987e6", "dataType": "trackingCategories"}], "invoiceTo": {"id": "504", "type": "customer"}}], "notes": "amazon purchase"}] + application/json: [{"id": "a44135b0-6882-489a-83fe-a0c57a4afb19", "type": "Payment", "issueDate": "2024-05-21T00:00:00+00:00", "currency": "GBP", "currencyRate": 1, "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "35"}, "trackingRefs": [{"id": "DEPARTMENT_3", "dataType": "trackingCategories"}, {"dataType": "trackingCategories"}], "invoiceTo": {"id": "504", "type": "customer"}}], "notes": "amazon purchase"}] responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} update-expense-transaction: Payment: parameters: @@ -1019,16 +2957,39 @@ examples: transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: application/json: {"type": "Payment", "issueDate": "2024-05-21T00:00:00+00:00", "currency": "GBP", "currencyRate": 1, "contactRef": {"id": "430", "type": "Supplier"}, "bankAccountRef": {"id": "97"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "accountRef": {"id": "35"}, "trackingRefs": [{"id": "DEPARTMENT_5", "dataType": "trackingCategories"}], "invoiceTo": {"id": "504", "type": "customer"}}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590"} + responses: + "202": + application/json: {"syncId": "1ad0695c-4566-4715-918c-adbb03eac81e"} + "400": + application/json: {} + "500": + application/json: {} Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"type": "Payment", "issueDate": "2022-06-28T00:00:00.000Z", "currency": "GBP", "contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd", "type": "Supplier"}, "bankAccountRef": {"id": "787dfb37-5707-4dc0-8a86-8d74e4cc78ea"}, "merchantName": "Amazon UK", "lines": [], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590"} + application/json: {"type": "Payment", "issueDate": "2022-06-28T00:00:00.000Z", "currency": "GBP", "contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd", "type": "Supplier"}, "bankAccountRef": {"id": "787dfb37-5707-4dc0-8a86-8d74e4cc78ea"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "accountRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "itemRef": null, "trackingRefs": null, "invoiceTo": null}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590"} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-update-expense-transaction: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" + requestBody: + application/json: {"type": "Payment", "issueDate": "2022-06-28T00:00:00.000Z", "currency": "GBP", "contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd", "type": "Supplier"}, "bankAccountRef": {"id": "787dfb37-5707-4dc0-8a86-8d74e4cc78ea"}, "merchantName": "Amazon UK", "lines": [{"netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "accountRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "itemRef": null, "trackingRefs": null, "invoiceTo": null}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590"} + responses: + "202": + application/json: {"syncId": "1ad0695c-4566-4715-918c-adbb03eac81e"} + "400": + application/json: {} + "500": + application/json: {} create-transfer-transaction: Create transfer: parameters: @@ -1040,14 +3001,17 @@ examples: responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} - "400": {} + "400": + application/json: {} + "500": + application/json: {} Example 1: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"description": "Transfer from bank account Y to bank account Z", "date": "2022-10-23T00:00:00Z", "from": {"accountRef": {"id": ""}, "amount": "4893.82"}, "to": {"accountRef": {"id": ""}, "amount": "6384.24"}} + application/json: {"description": "Transfer from bank account Y to bank account Z", "date": "2022-10-23T00:00:00Z", "from": {"accountRef": {"id": ""}, "amount": 7329.18}, "to": {"accountRef": {"id": ""}, "amount": 522.15}} responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -1057,10 +3021,12 @@ examples: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"description": "Transfer from bank account Y to bank account Z", "date": "2022-10-23T00:00:00Z", "from": {"accountRef": {"id": ""}, "amount": "4174.58"}, "to": {"accountRef": {"id": ""}, "amount": "2884.08"}} + application/json: {"description": "Transfer from bank account Y to bank account Z", "date": "2022-10-23T00:00:00Z", "from": {"accountRef": {"id": ""}, "amount": 7329.18}, "to": {"accountRef": {"id": ""}, "amount": 522.15}} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-adjustment-transaction: Create adjustment: parameters: @@ -1071,13 +3037,16 @@ examples: responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} - "400": {} + "400": + application/json: {} + "500": + application/json: {} Example 1: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [] + application/json: [{"id": "6a13b8cf-d482-4389-9f93-08d52faa3dc0", "date": "2022-10-23T00:00:00Z", "currency": "Lilangeni", "lines": []}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -1086,10 +3055,12 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [] + application/json: [{"id": "6a13b8cf-d482-4389-9f93-08d52faa3dc0", "date": "2022-10-23T00:00:00Z", "currency": "Lilangeni", "lines": []}] responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-reimbursable-expense-transaction: Create reimbursable expense: parameters: @@ -1100,13 +3071,16 @@ examples: responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} - "400": {} + "400": + application/json: {} + "500": + application/json: {} Example 1: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [] + application/json: [{"id": "4d7c6929-7770-412b-91bb-44d3bc71d111", "contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "apAccountRef": null, "issueDate": "2022-10-23T00:00:00Z", "dueDate": "2022-10-23T00:00:00Z", "currency": "GBP", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "lines": [{"description": "2-night hotel stay", "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "accountRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "itemRef": {"id": "80000002-1675158984"}, "trackingRefs": [{"id": "e9a1b63d-9ff0-40e7-8038-016354b987e6", "dataType": "trackingCategories"}], "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}}]}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -1115,10 +3089,12 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [] + application/json: [{"id": "4d7c6929-7770-412b-91bb-44d3bc71d111", "contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "apAccountRef": null, "issueDate": "2022-10-23T00:00:00Z", "dueDate": "2022-10-23T00:00:00Z", "currency": "GBP", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "lines": [{"description": "2-night hotel stay", "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "accountRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "itemRef": {"id": "80000002-1675158984"}, "trackingRefs": [{"id": "e9a1b63d-9ff0-40e7-8038-016354b987e6", "dataType": "trackingCategories"}], "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}}]}] responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} update-reimbursable-expense-transaction: Update reimbursable expense: parameters: @@ -1130,14 +3106,17 @@ examples: responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} - "400": {} + "400": + application/json: {} + "500": + application/json: {} Example 1: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "issueDate": "2022-10-23T00:00:00Z", "dueDate": "2022-10-23T00:00:00Z", "currency": "GBP", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "lines": []} + application/json: {"contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "apAccountRef": {"id": "8000004C-1724173136"}, "issueDate": "2022-10-23T00:00:00Z", "dueDate": "2022-10-23T00:00:00Z", "currency": "GBP", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "lines": [{"description": "2-night hotel stay", "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "accountRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "itemRef": {"id": "80000002-1675158984"}, "trackingRefs": [{"id": "e9a1b63d-9ff0-40e7-8038-016354b987e6", "dataType": "trackingCategories"}], "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}}]} responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -1147,10 +3126,12 @@ examples: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "issueDate": "2022-10-23T00:00:00Z", "dueDate": "2022-10-23T00:00:00Z", "currency": "GBP", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "lines": []} + application/json: {"contactRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "apAccountRef": {"id": "8000004C-1724173136"}, "issueDate": "2022-10-23T00:00:00Z", "dueDate": "2022-10-23T00:00:00Z", "currency": "GBP", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "lines": [{"description": "2-night hotel stay", "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "accountRef": {"id": "40e3e57c-2322-4898-966c-ca41adfd23fd"}, "itemRef": {"id": "80000002-1675158984"}, "trackingRefs": [{"id": "e9a1b63d-9ff0-40e7-8038-016354b987e6", "dataType": "trackingCategories"}], "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}}]} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} upload-expense-attachment: Malformed query: parameters: @@ -1161,14 +3142,49 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-upload-expense-attachment: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + syncId: "6fb40d5e-b13e-11ed-afa1-0242ac120002" + transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" + responses: + "200": + application/json: {} + "400": + application/json: {} + "500": + application/json: {} refresh-all-data-types: - Unauthorized: + Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" responses: - "401": - application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "400": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + Unresolved property: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "400": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-refresh-all-data-types: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "400": + application/json: {} + "500": + application/json: {} get-data-status: Example: parameters: @@ -1184,18 +3200,43 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} refresh-data-type: - Unauthorized: + Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" dataType: "invoices" - query: {} responses: - "401": - application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "400": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + Unresolved property: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + dataType: "invoices" + responses: + "400": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-refresh-data-type: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + dataType: "invoices" + responses: + "200": + application/json: {"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false} + "400": + application/json: {} + "500": + application/json: {} list-pull-operations: - "": + speakeasy-default-list-pull-operations: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" @@ -1206,8 +3247,11 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"results": [{"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "completed": "2022-10-23T00:00:00Z", "progress": 10, "isCompleted": false, "isErrored": false}], "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} - "400": {} + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} Example: parameters: path: @@ -1232,6 +3276,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: path: @@ -1244,17 +3290,33 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} get-pull-operation: Unauthorized: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - datasetId: "7911a54a-c808-4f4b-b87e-b195f52b4da5" + datasetId: "fa5f3e86-bd80-49b8-853c-5fbba4b201f5" responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-pull-operation: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + datasetId: "567094de-cafa-4f13-96d3-59e21b47ebe2" + responses: + "200": + application/json: {"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false} + "401": + application/json: {} + "500": + application/json: {} list-push-operations: - "": + speakeasy-default-list-push-operations: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" @@ -1265,8 +3327,11 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"results": [], "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} - "400": {} + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} Malformed query: parameters: path: @@ -1279,6 +3344,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: path: @@ -1291,27 +3358,62 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} get-push-operation: Unauthorized: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - pushOperationKey: "b18d8d81-fd7b-4764-a31e-475cb1f36591" + pushOperationKey: "660e8684-c0fb-4468-9e2a-b2e3b115d747" responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-get-push-operation: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + pushOperationKey: "86946e36-000f-4e6e-b76f-84a3be88f2b5" + responses: + "200": + application/json: {"changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "e12fb736-33cd-4b97-8d90-32b5be7c8586", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 480134} + "401": + application/json: {} + "500": + application/json: {} create-account: Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: - application/json: {"nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Cash On Hand", "currency": "USD", "currentBalance": 0, "type": "Asset", "status": "Active"} + application/json: {"nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Cash On Hand", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active"} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-create-account: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + query: + allowSyncOnPushComplete: true + requestBody: + application/json: {"nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Cash On Hand", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active"} + responses: + "200": + application/json: {"data": {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "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": "Cash On Hand", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active"}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "936358e8-4e4d-4663-93c0-e27c0d06dd56", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Failed", "statusCode": 239266} + "400": + application/json: {} + "500": + application/json: {} get-create-chartOfAccounts-model: Exact (Netherlands): parameters: @@ -1344,7 +3446,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" responses: "200": - application/json: {"type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "required": true, "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", "required": true, "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}]}, "currentBalance": {"type": "Number", "displayName": "Current Balance", "description": "The current balance in the account", "required": false}}} + application/json: {"type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "required": true, "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", "required": true, "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}]}, "currentBalance": {"type": "Number", "displayName": "Current Balance", "description": "The current balance in the account", "required": false}}} QuickBooks Online Sandbox: parameters: path: @@ -1384,7 +3486,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" responses: "200": - application/json: {"type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "required": true, "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", "required": true}, "metadata": {"type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "required": true}}} + application/json: {"type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "required": true, "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", "required": true, "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}}}, "metadata": {"type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "required": true, "properties": {"isDeleted": {"type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true}}}}} Xero: parameters: path: @@ -1401,42 +3503,71 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-bank-account: QuickBooks Online: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: - application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "accountName": "GBP Bank Account", "accountType": "Debit", "accountNumber": "12345678", "currency": "GBP", "status": "Active"} + application/json: {"accountName": "GBP Bank Account", "accountType": "Debit", "accountNumber": "12345678", "currency": "GBP", "status": "Active"} responses: "200": - application/json: {"changes": [], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "c1fc6fe0-7241-4bcd-989d-c7fa504e0833", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 829142} - "400": {} + application/json: {"data": {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "currency": "GBP", "status": "Active"}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "bbf55378-5e09-4654-9ce4-ff3208e30267", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 16290} + "400": + application/json: {} + "500": + application/json: {} Xero: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: - application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "accountName": "Xero GBP Bank Account", "accountType": "Debit", "sortCode": "445566", "accountNumber": "12345678", "currency": "GBP", "status": "Active"} + application/json: {"accountName": "Xero GBP Bank Account", "accountType": "Debit", "sortCode": "445566", "accountNumber": "12345678", "currency": "GBP", "status": "Active"} responses: "200": - application/json: {"changes": [], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "5e261915-a25d-40d9-aa13-20e8504aa8ce", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Success", "statusCode": 496323} - "400": {} + application/json: {"data": {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "currency": "GBP", "status": "Active"}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "bbf55378-5e09-4654-9ce4-ff3208e30267", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 16290} + "400": + application/json: {} + "500": + application/json: {} Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "currency": "GBP", "status": "Active"} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-create-bank-account: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + query: + allowSyncOnPushComplete: true + requestBody: + application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "currency": "GBP", "status": "Active"} + responses: + "200": + application/json: {"data": {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "currency": "GBP", "status": "Active"}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "bbf55378-5e09-4654-9ce4-ff3208e30267", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 16290} + "400": + application/json: {} + "500": + application/json: {} get-create-bankAccounts-model: Dynamics 365 Business Central: parameters: @@ -1485,7 +3616,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" responses: "200": - application/json: {"type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "required": true, "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}}} + application/json: {"type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "required": true, "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}}} QuickBooks Online Sandbox: parameters: path: @@ -1509,7 +3640,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" responses: "200": - application/json: {"type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "required": true, "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", "required": true}}} + application/json: {"type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "required": true, "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", "required": true, "properties": {"isDeleted": {"type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true}}}}} Unauthorized: parameters: path: @@ -1518,8 +3649,10 @@ examples: responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} list-customers: - "": + speakeasy-default-list-customers: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" @@ -1530,8 +3663,11 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"results": [], "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} - "400": {} + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} Clear Books: parameters: path: @@ -1760,6 +3896,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: path: @@ -1772,12 +3910,14 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} get-customer: Clear Books: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "7110701885" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-04-26T12:38:16Z", "sourceModifiedDate": "2022-07-03T01:27:00", "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", "metadata": {"isDeleted": false}} @@ -1785,7 +3925,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "7110701885" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2023-01-17T14:50:54Z", "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", "metadata": {"isDeleted": false}} @@ -1793,7 +3933,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "7110701885" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2022-10-26T13:32:05Z", "sourceModifiedDate": "2021-06-14T15:26:37Z", "id": "555f8251-c65a-433a-a813-5dbe04321d1e", "customerName": "Ab Netherlands", "defaultCurrency": "EUR", "addresses": [{"type": "Billing", "country": "NL"}], "contacts": [], "status": "Active"} @@ -1801,7 +3941,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "7110701885" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2020-02-26T11:23:50Z", "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"} @@ -1809,15 +3949,15 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "EILBDVJVNUAGVKRQ" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-17T06:02:46Z", "id": "11526230", "customerName": "-", "contactName": "Test 1", "defaultCurrency": "EUR", "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", "metadata": {"isDeleted": false}} + application/json: {"modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-17T06:02:46Z", "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", "metadata": {"isDeleted": false}} FreshBooks: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2022-05-18T09:23:56", "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", "metadata": {"isDeleted": false}} @@ -1825,15 +3965,15 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2022-09-30T10:29:15Z", "sourceModifiedDate": "0001-01-01T00:00:00", "id": "92227673", "customerName": "Chekko Customer Test 01", "contactName": "", "emailAddress": "", "defaultCurrency": "EUR", "phone": "", "addresses": [], "contacts": [{"name": "", "email": "", "phone": [], "status": "Active"}], "taxNumber": "", "status": "Active"} + application/json: {"modifiedDate": "2022-09-30T10:29:15Z", "sourceModifiedDate": "0001-01-01T00:00:00", "id": "92227673", "customerName": "Chekko Customer Test 01", "contactName": "", "emailAddress": "", "phone": "", "addresses": [], "contacts": [{"name": "", "email": "", "phone": [], "status": "Active"}], "taxNumber": "", "status": "Active"} Oracle NetSuite: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-01-30T14:48:02Z", "sourceModifiedDate": "2022-01-11T12:28:49", "id": "773", "customerName": "119 Test Customer", "contactName": "Mr Test Customer", "defaultCurrency": "GBP", "addresses": [], "contacts": [], "status": "Active"} @@ -1849,7 +3989,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "EILBDVJVNUAGVKRQ" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-01-18T11:02:35Z", "sourceModifiedDate": "2022-12-08T15:42:59Z", "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"} @@ -1857,7 +3997,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "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", "metadata": {"isDeleted": false}} @@ -1865,7 +4005,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "EILBDVJVNUAGVKRQ" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2022-10-14T09:35:53Z", "sourceModifiedDate": "2022-04-27T15:17:36Z", "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"} @@ -1889,7 +4029,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-04-04T16:32:21Z", "sourceModifiedDate": "2022-09-06T12:58:27", "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", "metadata": {"isDeleted": false}} @@ -1905,15 +4045,15 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "7110701885" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "customerName": "24 Locks", "emailAddress": "", "defaultCurrency": "USD", "addresses": [], "contacts": [], "status": "Active", "metadata": {"isDeleted": false}} + application/json: {"modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "customerName": "24 Locks", "emailAddress": "", "addresses": [], "contacts": [], "status": "Active", "metadata": {"isDeleted": false}} Zoho Books: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "EILBDVJVNUAGVKRQ" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-09T14:36:47", "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"} @@ -1921,37 +4061,80 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-customer: Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: - application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "USD", "contacts": [], "status": "Archived"} + application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "GBP", "contacts": [{"phone": null, "status": "Unknown", "modifiedDate": "2022-10-23T00:00:00Z"}], "status": "Unknown"} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-create-customer: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + query: + allowSyncOnPushComplete: true + requestBody: + application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "GBP", "contacts": [{"phone": null, "status": "Unknown", "modifiedDate": "2022-10-23T00:00:00Z"}], "status": "Unknown"} + responses: + "200": + application/json: {"data": {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "GBP", "contacts": [{"phone": null, "status": "Unknown", "modifiedDate": "2022-10-23T00:00:00Z"}], "status": "Active"}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "6df7882c-3b9a-422b-806d-10a8882c0066", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "TimedOut", "statusCode": 973924} + "400": + application/json: {} + "500": + application/json: {} update-customer: Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - customerId: "EILBDVJVNUAGVKRQ" - query: {} + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + query: + allowSyncOnPushComplete: true + forceUpdate: false requestBody: - application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "USD", "contacts": [], "status": "Unknown"} + application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "GBP", "contacts": [{"phone": [{"number": "+44 25691 154789", "type": "Primary"}], "status": "Unknown", "modifiedDate": "2022-10-23T00:00:00Z"}], "status": "Active"} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-update-customer: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + query: + allowSyncOnPushComplete: true + forceUpdate: false + requestBody: + application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "GBP", "contacts": [{"phone": [{"number": "+44 25691 154789", "type": "Primary"}], "status": "Unknown", "modifiedDate": "2022-10-23T00:00:00Z"}], "status": "Active"} + responses: + "200": + application/json: {"data": {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "defaultCurrency": "GBP", "contacts": [{"phone": [{"number": "+44 25691 154789", "type": "Primary"}], "status": "Unknown", "modifiedDate": "2022-10-23T00:00:00Z"}], "status": "Archived"}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "da9d96e3-14de-4669-8614-4a94010074c2", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 671250} + "400": + application/json: {} + "500": + application/json: {} list-suppliers: - "": + speakeasy-default-list-suppliers: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" @@ -1962,8 +4145,11 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"results": [{"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}}], "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} - "400": {} + application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} + "400": + application/json: {} + "500": + application/json: {} Clear Books: parameters: path: @@ -2192,6 +4378,8 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} Unresolved property: parameters: path: @@ -2204,12 +4392,14 @@ examples: responses: "400": application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0} get-supplier: Clear Books: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "1660-11-28T23:18:00", "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", "defaultCurrency": "GBP", "metadata": {"isDeleted": false}} @@ -2217,7 +4407,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-03-27T14:21:12Z", "sourceModifiedDate": "2020-11-04T11:44:22Z", "id": "78623f13-931e-eb11-bbf8-0022481b3585", "supplierName": "", "contactName": "", "emailAddress": "", "phone": "", "addresses": [{"type": "Billing", "line1": "", "line2": "", "city": "", "region": "", "country": "GB", "postalCode": ""}], "taxNumber": "", "status": "Active", "defaultCurrency": "GBP", "metadata": {"isDeleted": false}} @@ -2225,7 +4415,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2022-10-26T13:32:05Z", "sourceModifiedDate": "2022-07-15T12:01:15Z", "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", "defaultCurrency": "EUR"} @@ -2233,31 +4423,31 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2017-08-02T10:58:54Z", "id": "0185fea2-0298-445b-909a-0db685118a9e", "supplierName": "a", "phone": "+44 25691 154789", "addresses": [{"type": "Billing", "country": "GB"}], "status": "Active", "defaultCurrency": "GBP"} + application/json: {"modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2017-08-02T10:58:54Z", "id": "0185fea2-0298-445b-909a-0db685118a9e", "supplierName": "a", "addresses": [{"type": "Billing", "country": "GB"}], "status": "Active", "defaultCurrency": "GBP"} FreeAgent: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-17T06:02:46", "id": "11526230", "supplierName": "-", "contactName": "Test 1", "phone": "(877) 492-8687", "addresses": [{"type": "Billing", "line1": "1 Place House", "line2": "", "city": "London", "country": "United Kingdom", "postalCode": "WC1X 1AH"}], "status": "Active", "metadata": {"isDeleted": false}} + application/json: {"modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-17T06:02:46", "id": "11526230", "supplierName": "-", "contactName": "Test 1", "addresses": [{"type": "Billing", "line1": "1 Place House", "line2": "", "city": "London", "country": "United Kingdom", "postalCode": "WC1X 1AH"}], "status": "Active", "metadata": {"isDeleted": false}} FreshBooks: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2023-03-24T16:07:25Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "id": "api vendor", "supplierName": "api vendor", "phone": "01224 658 999", "addresses": [], "status": "Active", "metadata": {"isDeleted": false}} + application/json: {"modifiedDate": "2023-03-24T16:07:25Z", "id": "api vendor", "supplierName": "api vendor", "addresses": [], "status": "Active", "metadata": {"isDeleted": false}} KashFlow: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2022-09-30T10:29:15Z", "sourceModifiedDate": "2017-05-09T00:00:00", "id": "6202387", "supplierName": "Dell", "contactName": "", "emailAddress": "", "phone": "", "addresses": [], "taxNumber": "", "status": "Unknown"} @@ -2265,7 +4455,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-01-30T14:47:02Z", "sourceModifiedDate": "2022-02-04T14:24:43", "id": "779", "supplierName": "Test Vendor", "contactName": "Test Vendor", "emailAddress": "", "phone": "", "addresses": [], "status": "Active", "defaultCurrency": "GBP"} @@ -2281,15 +4471,15 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2022-12-07T10:48:18Z", "id": "41", "supplierName": "AI Support", "contactName": "AI Support", "phone": "01224 658 999", "addresses": [{"type": "Billing", "line1": "test", "region": "string", "country": "Djibouti"}], "status": "Active", "defaultCurrency": "GBP"} + application/json: {"modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2022-12-07T10:48:18Z", "id": "41", "supplierName": "AI Support", "contactName": "AI Support", "addresses": [{"type": "Billing", "line1": "test", "region": "string", "country": "Djibouti"}], "status": "Active", "defaultCurrency": "GBP"} QuickBooks Online Sandbox: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-13T01:51:08Z", "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", "defaultCurrency": "GBP", "metadata": {"isDeleted": false}} @@ -2297,10 +4487,10 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2022-10-14T09:35:58Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "id": "776", "supplierName": "Aaren", "contactName": "", "emailAddress": "", "phone": "", "addresses": [{"type": "Unknown", "line1": "", "line2": "", "city": "", "region": "", "country": "Great Britain", "postalCode": ""}], "taxNumber": "", "status": "Archived", "defaultCurrency": "GBP", "metadata": {"isDeleted": true}} + application/json: {"modifiedDate": "2022-10-14T09:35:58Z", "id": "776", "supplierName": "Aaren", "contactName": "", "emailAddress": "", "phone": "", "addresses": [{"type": "Unknown", "line1": "", "line2": "", "city": "", "region": "", "country": "Great Britain", "postalCode": ""}], "taxNumber": "", "status": "Archived", "defaultCurrency": "GBP", "metadata": {"isDeleted": true}} Sage 50 (UK): parameters: path: @@ -2316,12 +4506,12 @@ examples: supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-25T17:23:33Z", "id": "65179671e9ef424caff8b9006cd111c8", "supplierName": "5555 Abdul's Test Name", "contactName": "Main Contact", "phone": "01224 658 999", "addresses": [{"type": "Billing", "country": "United Kingdom (GB)"}], "status": "Active", "defaultCurrency": "GBP"} + application/json: {"modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-25T17:23:33Z", "id": "65179671e9ef424caff8b9006cd111c8", "supplierName": "5555 Abdul's Test Name", "contactName": "Main Contact", "addresses": [{"type": "Billing", "country": "United Kingdom (GB)"}], "status": "Active", "defaultCurrency": "GBP"} Sage Intacct: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"modifiedDate": "2023-04-04T16:32:20Z", "sourceModifiedDate": "2023-02-16T09:48:27", "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", "defaultCurrency": "USD", "metadata": {"isDeleted": false}} @@ -2332,81 +4522,681 @@ examples: supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:28:02Z", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "supplierName": "Computer Shop", "contactName": "", "emailAddress": "", "phone": "+44 25691 154789", "addresses": [], "status": "Active", "defaultCurrency": "GBP"} + application/json: {"modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:28:02Z", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "supplierName": "Computer Shop", "contactName": "", "emailAddress": "", "addresses": [], "status": "Active", "defaultCurrency": "GBP"} Xero: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "supplierName": "24 Locks", "emailAddress": "", "phone": "(877) 492-8687", "addresses": [], "status": "Active", "metadata": {"isDeleted": false}} + application/json: {"modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "supplierName": "24 Locks", "emailAddress": "", "addresses": [], "status": "Active", "metadata": {"isDeleted": false}} Zoho Books: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-16T13:09:56", "id": "104957000001494001", "supplierName": "Acme Corporation", "emailAddress": "", "phone": "+44 25691 154789", "addresses": [], "status": "Active", "defaultCurrency": "GBP"} + application/json: {"modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-16T13:09:56", "id": "104957000001494001", "supplierName": "Acme Corporation", "emailAddress": "", "addresses": [], "status": "Active", "defaultCurrency": "GBP"} Unauthorized: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "401": application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} create-supplier: Sage Intacct: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: - application/json: {"modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "id": "73593", "supplierName": "test 20230420 1004", "contactName": "Joe Bloggs", "phone": "(877) 492-8687", "status": "Active"} + application/json: {"id": "73593", "supplierName": "test 20230420 1004", "contactName": "Joe Bloggs", "status": "Active"} responses: "200": - application/json: {"changes": [], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "d642c1fc-6fe0-4724-9bcd-d89dc7fa504e", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 207565} - "400": {} + application/json: {"data": {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "a724c908-5d52-46dc-ac48-5fbb4ff4bff9", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Failed", "statusCode": 416715} + "400": + application/json: {} + "500": + application/json: {} Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - query: {} + query: + allowSyncOnPushComplete: true requestBody: application/json: {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}} responses: "400": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} - update-supplier: - Malformed query: + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-create-supplier: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - supplierId: "EILBDVJVNUAGVKRQ" - query: {} + query: + allowSyncOnPushComplete: true requestBody: application/json: {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}} responses: + "200": + application/json: {"data": {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "a724c908-5d52-46dc-ac48-5fbb4ff4bff9", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Failed", "statusCode": 416715} "400": - application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} - get-company-info: - Example 1: + application/json: {} + "500": + application/json: {} + update-supplier: + Malformed query: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + query: + allowSyncOnPushComplete: true + forceUpdate: false + requestBody: + application/json: {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}} responses: - "200": - application/json: {"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"} - Unauthorized: + "400": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + speakeasy-default-update-supplier: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + query: + allowSyncOnPushComplete: true + forceUpdate: false + requestBody: + application/json: {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}} responses: - "401": - application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "200": + application/json: {"data": {"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": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": {"isDeleted": true}, "supplementalData": {"content": {"property1": {"property1": "", "property2": ""}, "property2": {"property1": "", "property2": ""}}}}, "changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "221aa977-fea1-4c37-aad6-2bae775afc58", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "Pending", "statusCode": 663803} + "400": + application/json: {} + "500": + application/json: {} +examplesVersion: 1.0.2 generatedTests: {} +releaseNotes: "## Csharp SDK Changes:\n* `Codat.sync.expenses.Connections.Create()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Companies.List()`: \n * `request.Tags` **Added**\n * `response.results[].DataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Companies.Create()`: `response.dataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Companies.Update()`: \n * `request` **Changed** (Breaking ⚠️)\n * `response.dataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Companies.Get()`: `response.dataConnections[].ConnectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Connections.List()`: `response.results[].ConnectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Connections.Get()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Connections.Unlink()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Connections.CreatePartnerExpenseConnection()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️)\n* `Codat.sync.expenses.Companies.Replace()`: **Added**\n* `Codat.sync.expenses.ManageData.RefreshAllDataTypes()`: `error.status[400]` **Added**\n* `Codat.sync.expenses.ManageData.Get()`: `response.accountTransactions.LastSuccessfulSync` **Changed**\n* `Codat.sync.expenses.ManageData.RefreshDataType()`: `error.status[400]` **Added**\n" +generatedFiles: + - .gitattributes + - CONTRIBUTING.md + - Codat.Sync.Expenses.sln + - Codat/Sync/Expenses/Accounts.cs + - Codat/Sync/Expenses/Adjustments.cs + - Codat/Sync/Expenses/Attachments.cs + - Codat/Sync/Expenses/BankAccounts.cs + - Codat/Sync/Expenses/Codat.Sync.Expenses.csproj + - Codat/Sync/Expenses/CodatSyncExpenses.cs + - Codat/Sync/Expenses/Companies.cs + - Codat/Sync/Expenses/CompanyInfo.cs + - Codat/Sync/Expenses/Configuration.cs + - Codat/Sync/Expenses/Connections.cs + - Codat/Sync/Expenses/Customers.cs + - Codat/Sync/Expenses/Expenses.cs + - Codat/Sync/Expenses/Hooks/HookTypes.cs + - Codat/Sync/Expenses/Hooks/SDKHooks.cs + - Codat/Sync/Expenses/ManageData.cs + - Codat/Sync/Expenses/MappingOptions.cs + - Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs + - Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs + - Codat/Sync/Expenses/Models/Components/AccountPrototype.cs + - Codat/Sync/Expenses/Models/Components/AccountReference.cs + - Codat/Sync/Expenses/Models/Components/AccountStatus.cs + - Codat/Sync/Expenses/Models/Components/AccountType.cs + - Codat/Sync/Expenses/Models/Components/AccountingAccount.cs + - Codat/Sync/Expenses/Models/Components/AccountingAddress.cs + - Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs + - Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs + - Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs + - Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs + - Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs + - Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs + - Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs + - Codat/Sync/Expenses/Models/Components/ApAccountRef.cs + - Codat/Sync/Expenses/Models/Components/Attachment.cs + - Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs + - Codat/Sync/Expenses/Models/Components/BankAccount.cs + - Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs + - Codat/Sync/Expenses/Models/Components/BankAccountReference.cs + - Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs + - Codat/Sync/Expenses/Models/Components/BankAccountType.cs + - Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhook.cs + - Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhookData.cs + - Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhook.cs + - Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhookData.cs + - Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs + - Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs + - Codat/Sync/Expenses/Models/Components/CodatFile.cs + - Codat/Sync/Expenses/Models/Components/Companies.cs + - Codat/Sync/Expenses/Models/Components/Company.cs + - Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs + - Codat/Sync/Expenses/Models/Components/CompanyInformation.cs + - Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs + - Codat/Sync/Expenses/Models/Components/CompanyReference.cs + - Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs + - Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs + - Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs + - Codat/Sync/Expenses/Models/Components/Connection.cs + - Codat/Sync/Expenses/Models/Components/Connections.cs + - Codat/Sync/Expenses/Models/Components/Contact.cs + - Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs + - Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs + - Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs + - Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs + - Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs + - Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs + - Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs + - Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs + - Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs + - Codat/Sync/Expenses/Models/Components/Customer.cs + - Codat/Sync/Expenses/Models/Components/CustomerDetails.cs + - Codat/Sync/Expenses/Models/Components/CustomerStatus.cs + - Codat/Sync/Expenses/Models/Components/Customers.cs + - Codat/Sync/Expenses/Models/Components/DataConnectionError.cs + - Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs + - Codat/Sync/Expenses/Models/Components/DataStatus.cs + - Codat/Sync/Expenses/Models/Components/DataType.cs + - Codat/Sync/Expenses/Models/Components/DataTypes.cs + - Codat/Sync/Expenses/Models/Components/DatasetStatus.cs + - Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs + - Codat/Sync/Expenses/Models/Components/ErrorStatus.cs + - Codat/Sync/Expenses/Models/Components/ErrorValidation.cs + - Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs + - Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs + - Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs + - Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs + - Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs + - Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs + - Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs + - Codat/Sync/Expenses/Models/Components/From.cs + - Codat/Sync/Expenses/Models/Components/HalRef.cs + - Codat/Sync/Expenses/Models/Components/IntegrationType.cs + - Codat/Sync/Expenses/Models/Components/InvoiceTo.cs + - Codat/Sync/Expenses/Models/Components/InvoiceToType.cs + - Codat/Sync/Expenses/Models/Components/ItemRef.cs + - Codat/Sync/Expenses/Models/Components/Items.cs + - Codat/Sync/Expenses/Models/Components/Links.cs + - Codat/Sync/Expenses/Models/Components/MappingOptions.cs + - Codat/Sync/Expenses/Models/Components/Metadata.cs + - Codat/Sync/Expenses/Models/Components/Phone.cs + - Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs + - Codat/Sync/Expenses/Models/Components/PhoneNumberType.cs + - Codat/Sync/Expenses/Models/Components/PropertieDataType.cs + - Codat/Sync/Expenses/Models/Components/PullOperation.cs + - Codat/Sync/Expenses/Models/Components/PullOperations.cs + - Codat/Sync/Expenses/Models/Components/PushChangeType.cs + - Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs + - Codat/Sync/Expenses/Models/Components/PushOperation.cs + - Codat/Sync/Expenses/Models/Components/PushOperationChange.cs + - Codat/Sync/Expenses/Models/Components/PushOperationRef.cs + - Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs + - Codat/Sync/Expenses/Models/Components/PushOperations.cs + - Codat/Sync/Expenses/Models/Components/PushOption.cs + - Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs + - Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs + - Codat/Sync/Expenses/Models/Components/PushOptionType.cs + - Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs + - Codat/Sync/Expenses/Models/Components/RecordRef.cs + - Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs + - Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs + - Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs + - Codat/Sync/Expenses/Models/Components/Security.cs + - Codat/Sync/Expenses/Models/Components/SourceType.cs + - Codat/Sync/Expenses/Models/Components/Status.cs + - Codat/Sync/Expenses/Models/Components/SupplementalData.cs + - Codat/Sync/Expenses/Models/Components/Supplier.cs + - Codat/Sync/Expenses/Models/Components/SupplierDetails.cs + - Codat/Sync/Expenses/Models/Components/SupplierStatus.cs + - Codat/Sync/Expenses/Models/Components/Suppliers.cs + - Codat/Sync/Expenses/Models/Components/SyncCompleteWebhook.cs + - Codat/Sync/Expenses/Models/Components/SyncCompleteWebhookData.cs + - Codat/Sync/Expenses/Models/Components/SyncFailedWebhook.cs + - Codat/Sync/Expenses/Models/Components/SyncFailedWebhookData.cs + - Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs + - Codat/Sync/Expenses/Models/Components/To.cs + - Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs + - Codat/Sync/Expenses/Models/Components/TrackingRef.cs + - Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs + - Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs + - Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs + - Codat/Sync/Expenses/Models/Components/Transaction.cs + - Codat/Sync/Expenses/Models/Components/TransactionStatus.cs + - Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs + - Codat/Sync/Expenses/Models/Components/Transactions.cs + - Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs + - Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs + - Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs + - Codat/Sync/Expenses/Models/Components/Type.cs + - Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs + - Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs + - Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs + - Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs + - Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs + - Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs + - Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs + - Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs + - Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs + - Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs + - Codat/Sync/Expenses/Models/Components/ValidFor.cs + - Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs + - Codat/Sync/Expenses/Models/Components/Validation.cs + - Codat/Sync/Expenses/Models/Components/ValidationItem.cs + - Codat/Sync/Expenses/Models/Components/Weblink.cs + - Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs + - Codat/Sync/Expenses/Models/Errors/SDKException.cs + - Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs + - Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs + - Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs + - Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs + - Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs + - Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs + - Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs + - Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs + - Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs + - Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs + - Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs + - Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs + - Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs + - Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs + - Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs + - Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs + - Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs + - Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs + - Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs + - Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs + - Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs + - Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs + - Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs + - Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs + - Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs + - Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs + - Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs + - Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs + - Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs + - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs + - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse1.cs + - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs + - Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse1.cs + - Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs + - Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs + - Codat/Sync/Expenses/Models/Webhooks/SyncCompletedResponse.cs + - Codat/Sync/Expenses/Models/Webhooks/SyncFailedResponse.cs + - Codat/Sync/Expenses/PushOperations.cs + - Codat/Sync/Expenses/Reimbursements.cs + - Codat/Sync/Expenses/Suppliers.cs + - Codat/Sync/Expenses/Sync.cs + - Codat/Sync/Expenses/TransactionStatus.cs + - Codat/Sync/Expenses/Transfers.cs + - Codat/Sync/Expenses/Utils/AnyDeserializer.cs + - Codat/Sync/Expenses/Utils/BigIntStrConverter.cs + - Codat/Sync/Expenses/Utils/DecimalStrConverter.cs + - Codat/Sync/Expenses/Utils/EnumConverter.cs + - Codat/Sync/Expenses/Utils/FlexibleObjectDeserializer.cs + - Codat/Sync/Expenses/Utils/HeaderSerializer.cs + - Codat/Sync/Expenses/Utils/IsoDateTimeSerializer.cs + - Codat/Sync/Expenses/Utils/RequestBodySerializer.cs + - Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs + - Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs + - Codat/Sync/Expenses/Utils/Retries/Retries.cs + - Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs + - Codat/Sync/Expenses/Utils/SecurityMetadata.cs + - Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs + - Codat/Sync/Expenses/Utils/SpeakeasyMetadata.cs + - Codat/Sync/Expenses/Utils/URLBuilder.cs + - Codat/Sync/Expenses/Utils/Utilities.cs + - NUGET.md + - USAGE.md + - docs/Models/Components/AccountMappingInfo.md + - docs/Models/Components/AccountMappingInfoAccountType.md + - docs/Models/Components/AccountPrototype.md + - docs/Models/Components/AccountReference.md + - docs/Models/Components/AccountStatus.md + - docs/Models/Components/AccountType.md + - docs/Models/Components/AccountingAccount.md + - docs/Models/Components/AccountingAddress.md + - docs/Models/Components/AccountingAddressType.md + - docs/Models/Components/AccountingBankAccount.md + - docs/Models/Components/AccountingCustomer.md + - docs/Models/Components/AccountingSupplier.md + - docs/Models/Components/AdjustmentTransactionLine.md + - docs/Models/Components/AdjustmentTransactionRequest.md + - docs/Models/Components/AdjustmentTransactionResponse.md + - docs/Models/Components/ApAccountRef.md + - docs/Models/Components/Attachment.md + - docs/Models/Components/AttachmentUpload.md + - docs/Models/Components/BankAccount.md + - docs/Models/Components/BankAccountDetails.md + - docs/Models/Components/BankAccountReference.md + - docs/Models/Components/BankAccountStatus.md + - docs/Models/Components/BankAccountType.md + - docs/Models/Components/ClientRateLimitReachedWebhook.md + - docs/Models/Components/ClientRateLimitReachedWebhookData.md + - docs/Models/Components/ClientRateLimitResetWebhook.md + - docs/Models/Components/ClientRateLimitResetWebhookData.md + - docs/Models/Components/ClientRateLimitWebhook.md + - docs/Models/Components/ClientRateLimitWebhookPayload.md + - docs/Models/Components/CodatFile.md + - docs/Models/Components/Companies.md + - docs/Models/Components/Company.md + - docs/Models/Components/CompanyConfiguration.md + - docs/Models/Components/CompanyInformation.md + - docs/Models/Components/CompanyInformationType.md + - docs/Models/Components/CompanyReference.md + - docs/Models/Components/CompanyReferenceLinks.md + - docs/Models/Components/CompanyRequestBody.md + - docs/Models/Components/CompanySyncStatus.md + - docs/Models/Components/Connection.md + - docs/Models/Components/Connections.md + - docs/Models/Components/Contact.md + - docs/Models/Components/CreateAccountResponse.md + - docs/Models/Components/CreateAccountResponseMetadata.md + - docs/Models/Components/CreateAccountResponseValidDataTypeLinks.md + - docs/Models/Components/CreateBankAccountResponse.md + - docs/Models/Components/CreateBankAccountResponseBankAccountType.md + - docs/Models/Components/CreateCustomerResponse.md + - docs/Models/Components/CreateExpenseResponse.md + - docs/Models/Components/CreateReimbursableExpenseResponse.md + - docs/Models/Components/CreateSupplierResponse.md + - docs/Models/Components/Customer.md + - docs/Models/Components/CustomerDetails.md + - docs/Models/Components/CustomerStatus.md + - docs/Models/Components/Customers.md + - docs/Models/Components/DataConnectionError.md + - docs/Models/Components/DataConnectionStatus.md + - docs/Models/Components/DataStatus.md + - docs/Models/Components/DataType.md + - docs/Models/Components/DataTypes.md + - docs/Models/Components/DatasetStatus.md + - docs/Models/Components/DefinitionTransaction.md + - docs/Models/Components/ErrorStatus.md + - docs/Models/Components/ErrorValidation.md + - docs/Models/Components/ErrorValidationItem.md + - docs/Models/Components/ExpenseContactRef.md + - docs/Models/Components/ExpenseContactRefType.md + - docs/Models/Components/ExpenseTransaction.md + - docs/Models/Components/ExpenseTransactionLine.md + - docs/Models/Components/ExpensesSyncWebhook.md + - docs/Models/Components/ExpensesSyncWebhookPayload.md + - docs/Models/Components/From.md + - docs/Models/Components/HalRef.md + - docs/Models/Components/IntegrationType.md + - docs/Models/Components/InvoiceTo.md + - docs/Models/Components/InvoiceToType.md + - docs/Models/Components/ItemRef.md + - docs/Models/Components/Items.md + - docs/Models/Components/Links.md + - docs/Models/Components/MappingOptions.md + - docs/Models/Components/Metadata.md + - docs/Models/Components/Phone.md + - docs/Models/Components/PhoneNumberItems.md + - docs/Models/Components/PhoneNumberType.md + - docs/Models/Components/PropertieDataType.md + - docs/Models/Components/PullOperation.md + - docs/Models/Components/PullOperations.md + - docs/Models/Components/PushChangeType.md + - docs/Models/Components/PushFieldValidation.md + - docs/Models/Components/PushOperation.md + - docs/Models/Components/PushOperationChange.md + - docs/Models/Components/PushOperationRef.md + - docs/Models/Components/PushOperationStatus.md + - docs/Models/Components/PushOperations.md + - docs/Models/Components/PushOption.md + - docs/Models/Components/PushOptionChoice.md + - docs/Models/Components/PushOptionProperty.md + - docs/Models/Components/PushOptionType.md + - docs/Models/Components/PushValidationInfo.md + - docs/Models/Components/RecordRef.md + - docs/Models/Components/ReimbursableExpenseTransaction.md + - docs/Models/Components/ReimbursableExpenseTransactionLine.md + - docs/Models/Components/ReimbursementContactRef.md + - docs/Models/Components/Security.md + - docs/Models/Components/SourceType.md + - docs/Models/Components/Status.md + - docs/Models/Components/SupplementalData.md + - docs/Models/Components/Supplier.md + - docs/Models/Components/SupplierDetails.md + - docs/Models/Components/SupplierStatus.md + - docs/Models/Components/Suppliers.md + - docs/Models/Components/SyncCompleteWebhook.md + - docs/Models/Components/SyncCompleteWebhookData.md + - docs/Models/Components/SyncFailedWebhook.md + - docs/Models/Components/SyncFailedWebhookData.md + - docs/Models/Components/TaxRateMappingInfo.md + - docs/Models/Components/To.md + - docs/Models/Components/TrackingCategoryMappingInfo.md + - docs/Models/Components/TrackingRef.md + - docs/Models/Components/TrackingRefAdjustmentTransaction.md + - docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md + - docs/Models/Components/TrackingRefDataType.md + - docs/Models/Components/Transaction.md + - docs/Models/Components/TransactionStatus.md + - docs/Models/Components/TransactionStatus1.md + - docs/Models/Components/Transactions.md + - docs/Models/Components/TransferTransactionRequest.md + - docs/Models/Components/TransferTransactionRequestAccountReference.md + - docs/Models/Components/TransferTransactionResponse.md + - docs/Models/Components/Type.md + - docs/Models/Components/UpdateCustomerResponse.md + - docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md + - docs/Models/Components/UpdateExpenseRequest.md + - docs/Models/Components/UpdateExpenseRequestBankAccountReference.md + - docs/Models/Components/UpdateExpenseRequestType.md + - docs/Models/Components/UpdateExpenseResponse.md + - docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md + - docs/Models/Components/UpdateSupplierResponse.md + - docs/Models/Components/UpdateSupplierResponseAccountingSupplier.md + - docs/Models/Components/ValidDataTypeLinks.md + - docs/Models/Components/ValidFor.md + - docs/Models/Components/ValidTransactionTypes.md + - docs/Models/Components/Validation.md + - docs/Models/Components/ValidationItem.md + - docs/Models/Components/Weblink.md + - docs/Models/Errors/ErrorMessage.md + - docs/Models/Requests/CreateAccountRequest.md + - docs/Models/Requests/CreateAccountResponse.md + - docs/Models/Requests/CreateAdjustmentTransactionRequest.md + - docs/Models/Requests/CreateAdjustmentTransactionResponse.md + - docs/Models/Requests/CreateBankAccountRequest.md + - docs/Models/Requests/CreateBankAccountResponse.md + - docs/Models/Requests/CreateCompanyResponse.md + - docs/Models/Requests/CreateConnectionRequest.md + - docs/Models/Requests/CreateConnectionRequestBody.md + - docs/Models/Requests/CreateConnectionResponse.md + - docs/Models/Requests/CreateCustomerRequest.md + - docs/Models/Requests/CreateCustomerResponse.md + - docs/Models/Requests/CreateExpenseTransactionRequest.md + - docs/Models/Requests/CreateExpenseTransactionResponse.md + - docs/Models/Requests/CreatePartnerExpenseConnectionRequest.md + - docs/Models/Requests/CreatePartnerExpenseConnectionResponse.md + - docs/Models/Requests/CreateReimbursableExpenseTransactionRequest.md + - docs/Models/Requests/CreateReimbursableExpenseTransactionResponse.md + - docs/Models/Requests/CreateSupplierRequest.md + - docs/Models/Requests/CreateSupplierResponse.md + - docs/Models/Requests/CreateTransferTransactionRequest.md + - docs/Models/Requests/CreateTransferTransactionResponse.md + - docs/Models/Requests/DeleteCompanyRequest.md + - docs/Models/Requests/DeleteCompanyResponse.md + - docs/Models/Requests/DeleteConnectionRequest.md + - docs/Models/Requests/DeleteConnectionResponse.md + - docs/Models/Requests/GetCompanyConfigurationRequest.md + - docs/Models/Requests/GetCompanyConfigurationResponse.md + - docs/Models/Requests/GetCompanyInfoRequest.md + - docs/Models/Requests/GetCompanyInfoResponse.md + - docs/Models/Requests/GetCompanyRequest.md + - docs/Models/Requests/GetCompanyResponse.md + - docs/Models/Requests/GetConnectionRequest.md + - docs/Models/Requests/GetConnectionResponse.md + - docs/Models/Requests/GetCreateBankAccountsModelRequest.md + - docs/Models/Requests/GetCreateBankAccountsModelResponse.md + - docs/Models/Requests/GetCreateChartOfAccountsModelRequest.md + - docs/Models/Requests/GetCreateChartOfAccountsModelResponse.md + - docs/Models/Requests/GetCustomerRequest.md + - docs/Models/Requests/GetCustomerResponse.md + - docs/Models/Requests/GetDataStatusDataStatuses.md + - docs/Models/Requests/GetDataStatusRequest.md + - docs/Models/Requests/GetDataStatusResponse.md + - docs/Models/Requests/GetLastSuccessfulSyncRequest.md + - docs/Models/Requests/GetLastSuccessfulSyncResponse.md + - docs/Models/Requests/GetLatestSyncRequest.md + - docs/Models/Requests/GetLatestSyncResponse.md + - docs/Models/Requests/GetMappingOptionsRequest.md + - docs/Models/Requests/GetMappingOptionsResponse.md + - docs/Models/Requests/GetPullOperationRequest.md + - docs/Models/Requests/GetPullOperationResponse.md + - docs/Models/Requests/GetPushOperationRequest.md + - docs/Models/Requests/GetPushOperationResponse.md + - docs/Models/Requests/GetSupplierRequest.md + - docs/Models/Requests/GetSupplierResponse.md + - docs/Models/Requests/GetSyncByIdRequest.md + - docs/Models/Requests/GetSyncByIdResponse.md + - docs/Models/Requests/GetSyncTransactionRequest.md + - docs/Models/Requests/GetSyncTransactionResponse.md + - docs/Models/Requests/ListCompaniesRequest.md + - docs/Models/Requests/ListCompaniesResponse.md + - docs/Models/Requests/ListConnectionsRequest.md + - docs/Models/Requests/ListConnectionsResponse.md + - docs/Models/Requests/ListCustomersRequest.md + - docs/Models/Requests/ListCustomersResponse.md + - docs/Models/Requests/ListPullOperationsRequest.md + - docs/Models/Requests/ListPullOperationsResponse.md + - docs/Models/Requests/ListPushOperationsRequest.md + - docs/Models/Requests/ListPushOperationsResponse.md + - docs/Models/Requests/ListSuppliersRequest.md + - docs/Models/Requests/ListSuppliersResponse.md + - docs/Models/Requests/ListSyncTransactionsRequest.md + - docs/Models/Requests/ListSyncTransactionsResponse.md + - docs/Models/Requests/ListSyncsRequest.md + - docs/Models/Requests/ListSyncsResponse.md + - docs/Models/Requests/RefreshAllDataTypesRequest.md + - docs/Models/Requests/RefreshAllDataTypesResponse.md + - docs/Models/Requests/RefreshDataTypeRequest.md + - docs/Models/Requests/RefreshDataTypeResponse.md + - docs/Models/Requests/SetCompanyConfigurationRequest.md + - docs/Models/Requests/SetCompanyConfigurationResponse.md + - docs/Models/Requests/UnlinkConnectionRequest.md + - docs/Models/Requests/UnlinkConnectionResponse.md + - docs/Models/Requests/UnlinkConnectionUpdateConnection.md + - docs/Models/Requests/UpdateCompanyRequest.md + - docs/Models/Requests/UpdateCompanyResponse.md + - docs/Models/Requests/UpdateCustomerRequest.md + - docs/Models/Requests/UpdateCustomerResponse.md + - docs/Models/Requests/UpdateExpenseTransactionRequest.md + - docs/Models/Requests/UpdateExpenseTransactionResponse.md + - docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md + - docs/Models/Requests/UpdateReimbursableExpenseTransactionResponse.md + - docs/Models/Requests/UpdateSupplierRequest.md + - docs/Models/Requests/UpdateSupplierResponse.md + - docs/Models/Requests/UploadExpenseAttachmentRequest.md + - docs/Models/Requests/UploadExpenseAttachmentResponse.md + - docs/Models/Webhooks/ClientRateLimitReachedResponse.md + - docs/Models/Webhooks/ClientRateLimitReachedResponse1.md + - docs/Models/Webhooks/ClientRateLimitResetResponse.md + - docs/Models/Webhooks/ClientRateLimitResetResponse1.md + - docs/Models/Webhooks/ExpensesSyncSuccessfulResponse.md + - docs/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.md + - docs/Models/Webhooks/SyncCompletedResponse.md + - docs/Models/Webhooks/SyncFailedResponse.md + - docs/sdks/accounts/README.md + - docs/sdks/adjustments/README.md + - docs/sdks/attachments/README.md + - docs/sdks/bankaccounts/README.md + - docs/sdks/codatsyncexpenses/README.md + - docs/sdks/companies/README.md + - docs/sdks/companyinfo/README.md + - docs/sdks/configuration/README.md + - docs/sdks/connections/README.md + - docs/sdks/customers/README.md + - docs/sdks/expenses/README.md + - docs/sdks/managedata/README.md + - docs/sdks/mappingoptions/README.md + - docs/sdks/pushoperations/README.md + - docs/sdks/reimbursements/README.md + - docs/sdks/suppliers/README.md + - docs/sdks/sync/README.md + - docs/sdks/transactionstatus/README.md + - docs/sdks/transfers/README.md + - global.json diff --git a/sync-for-expenses/.speakeasy/gen.yaml b/sync-for-expenses/.speakeasy/gen.yaml index 7898a3c57..fba739db8 100644 --- a/sync-for-expenses/.speakeasy/gen.yaml +++ b/sync-for-expenses/.speakeasy/gen.yaml @@ -4,26 +4,46 @@ generation: maintainOpenAPIOrder: true usageSnippets: optionalPropertyRendering: withExample + sdkInitStyle: constructor useClassNamesForArrayFields: true fixes: nameResolutionDec2023: true + nameResolutionFeb2025: false parameterOrderingFeb2024: true requestResponseComponentNamesFeb2024: true + securityFeb2025: false + sharedErrorComponentsApr2025: false + sharedNestedComponentsJan2026: false + nameOverrideFeb2026: false auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false + hoistGlobalSecurity: true + schemas: + allOfMergeStrategy: shallowMerge + requestBodyFieldName: "" + versioningStrategy: automatic + persistentEdits: {} + tests: + generateTests: true + generateNewTests: false + skipResponseBodyAssertions: false csharp: - version: 7.0.0 + version: 7.1.0 additionalDependencies: [] author: Codat + baseErrorName: CodatSyncExpensesException clientServerStatusCodesAsErrors: true defaultErrorName: SDKException description: Push expenses to accounting platforms. disableNamespacePascalCasingApr2024: true dotnetVersion: net8.0 + enableCancellationToken: false + enableFormatting: false enableSourceLink: false flattenGlobalSecurity: true flatteningOrder: "" + httpClientPrefix: Speakeasy imports: option: openapi paths: @@ -33,11 +53,15 @@ csharp: shared: Models/Components webhooks: Models/Webhooks includeDebugSymbols: false + inferUnionDiscriminators: false inputModelSuffix: input maxMethodParams: 0 methodArguments: infer-optional-args + multipartArrayFormat: legacy outputModelSuffix: output packageName: Codat.Sync.Expenses packageTags: "" + respectTitlesForPrimitiveUnionMembers: false responseFormat: envelope sourceDirectory: "" + useNodatime: true diff --git a/sync-for-expenses/Codat/Sync/Expenses/Accounts.cs b/sync-for-expenses/Codat/Sync/Expenses/Accounts.cs index aae2b4e9f..8ff569e80 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Accounts.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Accounts.cs @@ -13,50 +13,69 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Create accounts and view create account options. /// public interface IAccounts { - /// - /// Create account - /// + /// Create account. + /// /// - /// The *Create account* endpoint creates a new account for a given company's connection.
+ /// The *Create account* endpoint creates a new account for a given company's connection.
///
/// Accounts are the categories a business uses to record accounting transactions.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// Required data may vary by integration. To see what data to post, first call Get create account model. /// - /// - Task CreateAsync(CreateAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateAccountRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get create account model - /// + /// Get create account model. + /// /// /// The *Get create account model* endpoint returns the expected data for the request payload when creating an account for a given company and integration.
///
/// Accounts are the categories a business uses to record accounting transactions.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// See the *response examples* for integration-specific indicative models. /// - /// - Task GetCreateModelAsync(GetCreateChartOfAccountsModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreateChartOfAccountsModelRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -64,31 +83,54 @@ public interface IAccounts /// public class Accounts: IAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Accounts(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Accounts(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task CreateAsync(CreateAccountRequest request, RetryConfig? retryConfig = null) + /// + /// Create account. + /// + /// + /// The *Create account* endpoint creates a new account for a given company's connection.
+ ///
+ /// Accounts 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. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateAccountRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/accounts", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/accounts", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -96,12 +138,12 @@ public Accounts(ISpeakeasyHttpClient client, Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -146,7 +188,7 @@ public Accounts(ISpeakeasyHttpClient client, Func= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -155,9 +197,9 @@ public Accounts(ISpeakeasyHttpClient client, Func(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.CreateAccountResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.CreateAccountResponse.", httpResponse, httpResponseBody, ex); + } + var response = new Models.Requests.CreateAccountResponse() { StatusCode = responseStatusCode, @@ -187,40 +239,105 @@ public Accounts(ISpeakeasyHttpClient client, Func{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetCreateModelAsync(GetCreateChartOfAccountsModelRequest request, RetryConfig? retryConfig = null) + + /// + /// Get create account model. + /// + /// + /// The *Get create account model* endpoint returns the expected data for the request payload when creating an account for a given company and integration.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreateChartOfAccountsModelRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-create-chartOfAccounts-model", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-create-chartOfAccounts-model", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -254,8 +371,8 @@ public async Task GetCreateModelAsync(Get Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -265,7 +382,7 @@ public async Task GetCreateModelAsync(Get httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -274,9 +391,9 @@ public async Task GetCreateModelAsync(Get } } } - 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; @@ -295,7 +412,17 @@ public async Task GetCreateModelAsync(Get { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + PushOption obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into PushOption.", httpResponse, httpResponseBody, ex); + } + var response = new GetCreateChartOfAccountsModelResponse() { StatusCode = responseStatusCode, @@ -306,24 +433,59 @@ public async Task GetCreateModelAsync(Get return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Adjustments.cs b/sync-for-expenses/Codat/Sync/Expenses/Adjustments.cs index be571a205..9a52124a0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Adjustments.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Adjustments.cs @@ -13,26 +13,25 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// - /// Create transactions that represent your adjustments to your customers' spend. + /// Create transactions that represent your adjustments to your customers' spend. /// public interface IAdjustments { - /// - /// Create adjustment transaction - /// + /// Create adjustment transaction. + /// /// - /// Use the *Create adjustment expense* endpoint to create an adjustment in the accounting software for a given company's connection.
+ /// Use the *Create adjustment expense* endpoint to create an adjustment in the accounting software for a given company's connection.
///
/// Adjustments represent write-offs and transaction alterations, such as foreign exchange adjustments, in the form of a journal entry.
///
@@ -42,40 +41,75 @@ public interface IAdjustments /// |-----------------------|-----------|
/// | QuickBooks Desktop | Yes | /// - /// - Task CreateAsync(CreateAdjustmentTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateAdjustmentTransactionRequest request, + RetryConfig? retryConfig = null + ); } /// - /// Create transactions that represent your adjustments to your customers' spend. + /// Create transactions that represent your adjustments to your customers' spend. /// public class Adjustments: IAdjustments { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Adjustments(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Adjustments(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task CreateAsync(CreateAdjustmentTransactionRequest request, RetryConfig? retryConfig = null) + /// + /// Create adjustment transaction. + /// + /// + /// Use the *Create adjustment expense* endpoint to create an adjustment in the accounting software for a given company's connection.
+ ///
+ /// Adjustments represent write-offs and transaction alterations, such as foreign exchange adjustments, in the form of a journal entry.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-----------------------|-----------|
+ /// | QuickBooks Desktop | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateAdjustmentTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/adjustment-transactions", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/adjustment-transactions", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -83,12 +117,12 @@ public async Task CreateAsync(CreateAdjustm httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-adjustment-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-adjustment-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -122,8 +156,8 @@ public async Task CreateAsync(CreateAdjustm Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -133,7 +167,7 @@ public async Task CreateAsync(CreateAdjustm httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -142,9 +176,9 @@ public async Task CreateAsync(CreateAdjustm } } } - 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; @@ -163,7 +197,17 @@ public async Task CreateAsync(CreateAdjustm { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + AdjustmentTransactionResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into AdjustmentTransactionResponse.", httpResponse, httpResponseBody, ex); + } + var response = new CreateAdjustmentTransactionResponse() { StatusCode = responseStatusCode, @@ -174,24 +218,59 @@ public async Task CreateAsync(CreateAdjustm return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Attachments.cs b/sync-for-expenses/Codat/Sync/Expenses/Attachments.cs index 09b26009f..432b1e7c8 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Attachments.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Attachments.cs @@ -13,44 +13,54 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Attach receipts to a transaction for a complete audit trail. /// public interface IAttachments { - /// - /// Upload attachment - /// + /// Upload attachment. + /// /// /// The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId.
///
/// Expense transactions represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// Each accounting software supports different file formats and sizes.
///
- /// | Integration | File size | File extension |Supported transaction type
- /// |-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------|
- /// | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types |
- /// | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` |
- /// | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` |
- /// | **Dynamics 365 Business Central** | 350 MB | No explicit requirements outlined for text, image, and video files. | All supported types
- /// | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A |
- /// | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF + /// | Integration | File size | File extension | Supported transactions |
+ /// |-----------------------------------|-----------|-------------------------------------------------------|------------------------|
+ /// | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types |
+ /// | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `expense-transactions.Payment`, `expense-transactions.Refund`, `reimbursable-expense-transactions` |
+ /// | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`expense-transactions.Payment`, `expense-transactions.Refund` |
+ /// | **Dynamics 365 Business Central** | 350 MB | No explicit requirements outlined for text, image, and video files. | All supported types
+ /// | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A |
+ /// | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions`
+ /// | **Zoho Books** | 5MB | GIF, PNG, JPEG, JPG, BMP, PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` | /// - /// - Task UploadAsync(UploadExpenseAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UploadAsync( + UploadExpenseAttachmentRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -58,31 +68,64 @@ public interface IAttachments /// public class Attachments: IAttachments { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Attachments(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Attachments(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task UploadAsync(UploadExpenseAttachmentRequest request, RetryConfig? retryConfig = null) + /// + /// Upload attachment. + /// + /// + /// The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId.
+ ///
+ /// Expense transactions represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Each accounting software supports different file formats and sizes.
+ ///
+ /// | Integration | File size | File extension | Supported transactions |
+ /// |-----------------------------------|-----------|-------------------------------------------------------|------------------------|
+ /// | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types |
+ /// | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `expense-transactions.Payment`, `expense-transactions.Refund`, `reimbursable-expense-transactions` |
+ /// | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`expense-transactions.Payment`, `expense-transactions.Refund` |
+ /// | **Dynamics 365 Business Central** | 350 MB | No explicit requirements outlined for text, image, and video files. | All supported types
+ /// | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A |
+ /// | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions`
+ /// | **Zoho Books** | 5MB | GIF, PNG, JPEG, JPG, BMP, PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UploadAsync( + UploadExpenseAttachmentRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "AttachmentUpload", "multipart", false, true); if (serializedBody != null) @@ -90,12 +133,12 @@ public async Task UploadAsync(UploadExpenseAtta httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("upload-expense-attachment", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "upload-expense-attachment", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -129,8 +172,8 @@ public async Task UploadAsync(UploadExpenseAtta Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -140,7 +183,7 @@ public async Task UploadAsync(UploadExpenseAtta httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -149,9 +192,9 @@ public async Task UploadAsync(UploadExpenseAtta } } } - 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; @@ -170,7 +213,17 @@ public async Task UploadAsync(UploadExpenseAtta { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Attachment obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Attachment.", httpResponse, httpResponseBody, ex); + } + var response = new UploadExpenseAttachmentResponse() { StatusCode = responseStatusCode, @@ -181,24 +234,59 @@ public async Task UploadAsync(UploadExpenseAtta return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/BankAccounts.cs b/sync-for-expenses/Codat/Sync/Expenses/BankAccounts.cs index d0dccbf9a..591ff698d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/BankAccounts.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/BankAccounts.cs @@ -13,51 +13,69 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Create bank accounts and view create bank account options. /// public interface IBankAccounts { - /// - /// Create bank account - /// + /// Create bank account. + /// /// - /// The *Create bank account* endpoint creates a new bank account for a given company's connection.
+ /// The *Create bank account* endpoint creates a new bank account for a given company's connection.
///
/// Bank accounts are financial accounts maintained by a bank or other financial institution.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// Required data may vary by integration. To see what data to post, first call Get create/update bank account model. /// - /// - Task CreateAsync(CreateBankAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateBankAccountRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get create bank account model - /// + /// Get create bank account model. + /// /// /// The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a bank account for a given company and integration.
///
/// Bank accounts are financial accounts maintained by a bank or other financial institution.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
- /// See the *response examples* for integration-specific indicative models.
- /// + /// See the *response examples* for integration-specific indicative models. /// - /// - Task GetCreateModelAsync(GetCreateBankAccountsModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreateBankAccountsModelRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -65,31 +83,54 @@ public interface IBankAccounts /// public class BankAccounts: IBankAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public BankAccounts(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public BankAccounts(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task CreateAsync(CreateBankAccountRequest request, RetryConfig? retryConfig = null) + /// + /// Create bank account. + /// + /// + /// The *Create bank account* endpoint creates a new bank account for a given company's connection.
+ ///
+ /// Bank accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update bank account model. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateBankAccountRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/bankAccounts", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/bankAccounts", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "BankAccount", "json", true, true); if (serializedBody != null) @@ -97,12 +138,12 @@ public BankAccounts(ISpeakeasyHttpClient client, Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -147,7 +188,7 @@ public BankAccounts(ISpeakeasyHttpClient client, Func= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -156,9 +197,9 @@ public BankAccounts(ISpeakeasyHttpClient client, Func(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.CreateBankAccountResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.CreateBankAccountResponse.", httpResponse, httpResponseBody, ex); + } + var response = new Models.Requests.CreateBankAccountResponse() { StatusCode = responseStatusCode, @@ -188,40 +239,105 @@ public BankAccounts(ISpeakeasyHttpClient client, Func{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetCreateModelAsync(GetCreateBankAccountsModelRequest request, RetryConfig? retryConfig = null) + + /// + /// Get create bank account model. + /// + /// + /// The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a bank account for a given company and integration.
+ ///
+ /// Bank accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreateBankAccountsModelRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/options/bankAccounts", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/options/bankAccounts", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-create-bankAccounts-model", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-create-bankAccounts-model", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -255,8 +371,8 @@ public async Task GetCreateModelAsync(GetCre Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -266,7 +382,7 @@ public async Task GetCreateModelAsync(GetCre httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -275,9 +391,9 @@ public async Task GetCreateModelAsync(GetCre } } } - 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; @@ -296,7 +412,17 @@ public async Task GetCreateModelAsync(GetCre { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + PushOption obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into PushOption.", httpResponse, httpResponseBody, ex); + } + var response = new GetCreateBankAccountsModelResponse() { StatusCode = responseStatusCode, @@ -307,24 +433,59 @@ public async Task GetCreateModelAsync(GetCre return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Codat.Sync.Expenses.csproj b/sync-for-expenses/Codat/Sync/Expenses/Codat.Sync.Expenses.csproj index 94c17cd7e..1eb1e3cc6 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Codat.Sync.Expenses.csproj +++ b/sync-for-expenses/Codat/Sync/Expenses/Codat.Sync.Expenses.csproj @@ -3,43 +3,13 @@ true Codat.Sync.Expenses - 7.0.0 + 7.1.0 net8.0 Codat - Copyright (c) Codat 2024 + Copyright (c) Codat 2026 https://github.com/codatio/client-sdk-csharp.git git - Sync for Expenses: The API for Sync for Expenses.
-
-Sync for Expenses is an API and a set of supporting tools. It has been built to
-enable corporate card and expense management platforms to provide high-quality
-integrations with multiple accounting software through a standardized API.
-
-Explore product | See our OpenAPI spec
-
-Not seeing the endpoints you're expecting? We've reorganized our products, and you may be using a different version of Sync for Expenses.
-
----
-<!-- Start Codat Tags Table -->
-## Endpoints
-
-| Endpoints | Description |
-| :- |:- |
-| Companies | Create and manage your SMB users' companies. |
-| Connections | Create new and manage existing data connections for a company. |
-| Configuration | View and manage mapping configuration and defaults for expense transactions. |
-| Sync | Monitor the status of data syncs. |
-| Expenses | Create and update transactions that represent your customers' spend. |
-| Transfers | Create and update transactions that represent the movement of your customers' money. |
-| Reimbursements | Create and update transactions that represent your customers' repayable spend. |
-| Attachments | Attach receipts to a transaction for a complete audit trail. |
-| Transaction status | Monitor the status of individual transactions in data syncs. |
-| Manage data | Control and monitor the retrieval of data from an integration. |
-| Push operations | View historic push operations. |
-| Accounts | Create accounts and view account schemas. |
-| Customers | Get, create, and update customers. |
-| Suppliers | Get, create, and update suppliers. |
-<!-- End Codat Tags Table --> + Push expenses to accounting platforms. diff --git a/sync-for-expenses/Codat/Sync/Expenses/CodatSyncExpenses.cs b/sync-for-expenses/Codat/Sync/Expenses/CodatSyncExpenses.cs index a4ce652b3..621cf9cb9 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/CodatSyncExpenses.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/CodatSyncExpenses.cs @@ -12,26 +12,23 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Hooks; using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; - using System; - /// - /// Sync for Expenses: The API for Sync for Expenses.
- /// - /// + /// Expenses: The API for Codat's Expenses solution.
///
- /// Sync for Expenses is an API and a set of supporting tools. It has been built to
+ /// Expenses is an API and a set of supporting tools. It has been built to
/// enable corporate card and expense management platforms to provide high-quality
/// integrations with multiple accounting software through a standardized API.
///
- /// Explore product | See our OpenAPI spec
+ /// Explore solution | See our OpenAPI spec ///
- /// Not seeing the endpoints you're expecting? We've reorganized our products, and you may be using a different version of Sync for Expenses.
+ /// Not seeing the endpoints you're expecting? We've reorganized our solutions, and you may be using a different version of Expenses.
///
/// ---
/// <!-- Start Codat Tags Table -->
@@ -39,13 +36,13 @@ namespace Codat.Sync.Expenses ///
/// | Endpoints | Description |
/// | :- |:- |
- /// | Companies | Create and manage your SMB users' companies. |
+ /// | Companies | Create and manage your SMB users' companies. |
/// | Connections | Create new and manage existing data connections for a company. |
/// | Configuration | View and manage mapping configuration and defaults for expense transactions. |
/// | Sync | Monitor the status of data syncs. |
- /// | Expenses | Create and update transactions that represent your customers' spend. |
- /// | Transfers | Create and update transactions that represent the movement of your customers' money. |
- /// | Reimbursements | Create and update transactions that represent your customers' repayable spend. |
+ /// | Expenses | Create and update transactions that represent your customers' spend. |
+ /// | Transfers | Create and update transactions that represent the movement of your customers' money. |
+ /// | Reimbursements | Create and update transactions that represent your customers' repayable spend. |
/// | Attachments | Attach receipts to a transaction for a complete audit trail. |
/// | Transaction status | Monitor the status of individual transactions in data syncs. |
/// | Manage data | Control and monitor the retrieval of data from an integration. |
@@ -54,13 +51,11 @@ namespace Codat.Sync.Expenses /// | Customers | Get, create, and update customers. |
/// | Suppliers | Get, create, and update suppliers. |
/// <!-- End Codat Tags Table --> - /// /// public interface ICodatSyncExpenses { - /// - /// Create and manage your SMB users' companies. + /// Create and manage your SMB users' companies. /// public ICompanies Companies { get; } @@ -70,7 +65,7 @@ public interface ICodatSyncExpenses public IConnections Connections { get; } /// - /// View the company information of your customers' linked accounting software. + /// View the company information of your customers' linked accounting software. /// public ICompanyInfo CompanyInfo { get; } @@ -95,22 +90,22 @@ public interface ICodatSyncExpenses public ITransactionStatus TransactionStatus { get; } /// - /// Create and update transactions that represent your customers' spend. + /// Create and update transactions that represent your customers' spend. /// public IExpenses Expenses { get; } /// - /// Create and update transactions that represent the movement of your customers' money. + /// Create and update transactions that represent the movement of your customers' money. /// public ITransfers Transfers { get; } /// - /// Create transactions that represent your adjustments to your customers' spend. + /// Create transactions that represent your adjustments to your customers' spend. /// public IAdjustments Adjustments { get; } /// - /// Create and update transactions that represent your customers' repayable spend. + /// Create and update transactions that represent your customers' repayable spend. /// public IReimbursements Reimbursements { get; } @@ -150,53 +145,16 @@ public interface ICodatSyncExpenses public ISuppliers Suppliers { get; } } - public class SDKConfig - { - /// - /// List of server URLs available to the SDK. - /// - public static readonly string[] ServerList = { - "https://api.codat.io", - }; - - public string ServerUrl = ""; - public int ServerIndex = 0; - public SDKHooks Hooks = new SDKHooks(); - public RetryConfig? RetryConfig = null; - - public string GetTemplatedServerUrl() - { - if (!String.IsNullOrEmpty(this.ServerUrl)) - { - return Utilities.TemplateUrl(Utilities.RemoveSuffix(this.ServerUrl, "/"), new Dictionary()); - } - return Utilities.TemplateUrl(SDKConfig.ServerList[this.ServerIndex], new Dictionary()); - } - - public ISpeakeasyHttpClient InitHooks(ISpeakeasyHttpClient client) - { - string preHooksUrl = GetTemplatedServerUrl(); - var (postHooksUrl, postHooksClient) = this.Hooks.SDKInit(preHooksUrl, client); - if (preHooksUrl != postHooksUrl) - { - this.ServerUrl = postHooksUrl; - } - return postHooksClient; - } - } - /// - /// Sync for Expenses: The API for Sync for Expenses.
- /// - /// + /// Expenses: The API for Codat's Expenses solution.
///
- /// Sync for Expenses is an API and a set of supporting tools. It has been built to
+ /// Expenses is an API and a set of supporting tools. It has been built to
/// enable corporate card and expense management platforms to provide high-quality
/// integrations with multiple accounting software through a standardized API.
///
- /// Explore product | See our OpenAPI spec
+ /// Explore solution | See our OpenAPI spec ///
- /// Not seeing the endpoints you're expecting? We've reorganized our products, and you may be using a different version of Sync for Expenses.
+ /// Not seeing the endpoints you're expecting? We've reorganized our solutions, and you may be using a different version of Expenses.
///
/// ---
/// <!-- Start Codat Tags Table -->
@@ -204,13 +162,13 @@ public ISpeakeasyHttpClient InitHooks(ISpeakeasyHttpClient client) ///
/// | Endpoints | Description |
/// | :- |:- |
- /// | Companies | Create and manage your SMB users' companies. |
+ /// | Companies | Create and manage your SMB users' companies. |
/// | Connections | Create new and manage existing data connections for a company. |
/// | Configuration | View and manage mapping configuration and defaults for expense transactions. |
/// | Sync | Monitor the status of data syncs. |
- /// | Expenses | Create and update transactions that represent your customers' spend. |
- /// | Transfers | Create and update transactions that represent the movement of your customers' money. |
- /// | Reimbursements | Create and update transactions that represent your customers' repayable spend. |
+ /// | Expenses | Create and update transactions that represent your customers' spend. |
+ /// | Transfers | Create and update transactions that represent the movement of your customers' money. |
+ /// | Reimbursements | Create and update transactions that represent your customers' repayable spend. |
/// | Attachments | Attach receipts to a transaction for a complete audit trail. |
/// | Transaction status | Monitor the status of individual transactions in data syncs. |
/// | Manage data | Control and monitor the retrieval of data from an integration. |
@@ -219,49 +177,160 @@ public ISpeakeasyHttpClient InitHooks(ISpeakeasyHttpClient client) /// | Customers | Get, create, and update customers. |
/// | Suppliers | Get, create, and update suppliers. |
/// <!-- End Codat Tags Table --> - /// /// public class CodatSyncExpenses: ICodatSyncExpenses { + /// + /// The main SDK Configuration. + /// public SDKConfig SDKConfiguration { get; private set; } - - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private int _serverIndex = 0; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; + /// + /// The Companies sub-SDK. + /// public ICompanies Companies { get; private set; } + /// + /// The Connections sub-SDK. + /// public IConnections Connections { get; private set; } + /// + /// The CompanyInfo sub-SDK. + /// public ICompanyInfo CompanyInfo { get; private set; } + /// + /// The Configuration sub-SDK. + /// public IConfiguration Configuration { get; private set; } + /// + /// The MappingOptions sub-SDK. + /// public IMappingOptions MappingOptions { get; private set; } + /// + /// The Sync sub-SDK. + /// public ISync Sync { get; private set; } + /// + /// The TransactionStatus sub-SDK. + /// public ITransactionStatus TransactionStatus { get; private set; } + /// + /// The Expenses sub-SDK. + /// public IExpenses Expenses { get; private set; } + /// + /// The Transfers sub-SDK. + /// public ITransfers Transfers { get; private set; } + /// + /// The Adjustments sub-SDK. + /// public IAdjustments Adjustments { get; private set; } + /// + /// The Reimbursements sub-SDK. + /// public IReimbursements Reimbursements { get; private set; } + /// + /// The Attachments sub-SDK. + /// public IAttachments Attachments { get; private set; } + /// + /// The ManageData sub-SDK. + /// public IManageData ManageData { get; private set; } + /// + /// The PushOperations sub-SDK. + /// public IPushOperations PushOperations { get; private set; } + /// + /// The Accounts sub-SDK. + /// public IAccounts Accounts { get; private set; } + /// + /// The BankAccounts sub-SDK. + /// public IBankAccounts BankAccounts { get; private set; } + /// + /// The Customers sub-SDK. + /// public ICustomers Customers { get; private set; } + /// + /// The Suppliers sub-SDK. + /// public ISuppliers Suppliers { get; private set; } - public CodatSyncExpenses(string? authHeader = null, Func? authHeaderSource = null, int? serverIndex = null, string? serverUrl = null, Dictionary? urlParams = null, ISpeakeasyHttpClient? client = null, RetryConfig? retryConfig = null) + /// + /// Initializes a new instance of the SDK based on a configuration object. + /// + /// The SDK configuration object. + public CodatSyncExpenses(SDKConfig config) + { + SDKConfiguration = config; + InitHooks(); + + Companies = new Companies(SDKConfiguration); + + Connections = new Connections(SDKConfiguration); + + CompanyInfo = new CompanyInfo(SDKConfiguration); + + Configuration = new Configuration(SDKConfiguration); + + MappingOptions = new MappingOptions(SDKConfiguration); + + Sync = new Sync(SDKConfiguration); + + TransactionStatus = new TransactionStatus(SDKConfiguration); + + Expenses = new Expenses(SDKConfiguration); + + Transfers = new Transfers(SDKConfiguration); + + Adjustments = new Adjustments(SDKConfiguration); + + Reimbursements = new Reimbursements(SDKConfiguration); + + Attachments = new Attachments(SDKConfiguration); + + ManageData = new ManageData(SDKConfiguration); + + PushOperations = new PushOperations(SDKConfiguration); + + Accounts = new Accounts(SDKConfiguration); + + BankAccounts = new BankAccounts(SDKConfiguration); + + Customers = new Customers(SDKConfiguration); + + Suppliers = new Suppliers(SDKConfiguration); + } + + /// + /// Initializes a new instance of the SDK with optional configuration parameters. + /// + /// The security configuration to use for API requests. If provided, this will be used as a static security configuration. + /// A function that returns the security configuration dynamically. This takes precedence over the static security parameter if both are provided. + /// The index of the server to use from the predefined server list. Must be between 0 and the length of the server list. Defaults to 0 if not specified. + /// A custom server URL to use instead of the predefined server list. If provided with urlParams, the URL will be templated with the provided parameters. + /// A dictionary of parameters to use for templating the serverUrl. Only used when serverUrl is provided. + /// A custom HTTP client implementation to use for making API requests. If not provided, the default SpeakeasyHttpClient will be used. + /// Configuration for retry behavior when API requests fail. Defines retry strategies, backoff policies, and maximum retry attempts. + /// Invalid value provided for : must be between 0 (inclusive) and 1 (exclusive). + /// None of and were provided. + public CodatSyncExpenses( + string? authHeader = null, + Func? authHeaderSource = null, + int? serverIndex = null, + string? serverUrl = null, + Dictionary? urlParams = null, + ISpeakeasyHttpClient? client = null, + RetryConfig? retryConfig = null + ) { if (serverIndex != null) { if (serverIndex.Value < 0 || serverIndex.Value >= SDKConfig.ServerList.Length) { - throw new Exception($"Invalid server index {serverIndex.Value}"); + throw new ArgumentOutOfRangeException($"Invalid server index {serverIndex}: must be between 0 (inclusive) and {SDKConfig.ServerList.Length} (exclusive)." ); } - _serverIndex = serverIndex.Value; } if (serverUrl != null) @@ -270,10 +339,8 @@ public CodatSyncExpenses(string? authHeader = null, Func? authHeaderSour { serverUrl = Utilities.TemplateUrl(serverUrl, urlParams); } - _serverUrl = serverUrl; } - - _client = client ?? new SpeakeasyHttpClient(); + Func? _securitySource = null; if(authHeaderSource != null) { @@ -285,71 +352,153 @@ public CodatSyncExpenses(string? authHeader = null, Func? authHeaderSour } else { - throw new Exception("authHeader and authHeaderSource cannot both be null"); + throw new ArgumentException("authHeader and authHeaderSource cannot both be null"); } - SDKConfiguration = new SDKConfig() + SDKConfiguration = new SDKConfig(client) { - ServerIndex = _serverIndex, - ServerUrl = _serverUrl, + ServerIndex = serverIndex == null ? 0 : serverIndex.Value, + ServerUrl = serverUrl == null ? "" : serverUrl, + SecuritySource = _securitySource, RetryConfig = retryConfig }; - _client = SDKConfiguration.InitHooks(_client); - - - Companies = new Companies(_client, _securitySource, _serverUrl, SDKConfiguration); - - - Connections = new Connections(_client, _securitySource, _serverUrl, SDKConfiguration); - + InitHooks(); - CompanyInfo = new CompanyInfo(_client, _securitySource, _serverUrl, SDKConfiguration); + Companies = new Companies(SDKConfiguration); + Connections = new Connections(SDKConfiguration); - Configuration = new Configuration(_client, _securitySource, _serverUrl, SDKConfiguration); + CompanyInfo = new CompanyInfo(SDKConfiguration); + Configuration = new Configuration(SDKConfiguration); - MappingOptions = new MappingOptions(_client, _securitySource, _serverUrl, SDKConfiguration); + MappingOptions = new MappingOptions(SDKConfiguration); + Sync = new Sync(SDKConfiguration); - Sync = new Sync(_client, _securitySource, _serverUrl, SDKConfiguration); + TransactionStatus = new TransactionStatus(SDKConfiguration); + Expenses = new Expenses(SDKConfiguration); - TransactionStatus = new TransactionStatus(_client, _securitySource, _serverUrl, SDKConfiguration); + Transfers = new Transfers(SDKConfiguration); + Adjustments = new Adjustments(SDKConfiguration); - Expenses = new Expenses(_client, _securitySource, _serverUrl, SDKConfiguration); + Reimbursements = new Reimbursements(SDKConfiguration); + Attachments = new Attachments(SDKConfiguration); - Transfers = new Transfers(_client, _securitySource, _serverUrl, SDKConfiguration); + ManageData = new ManageData(SDKConfiguration); + PushOperations = new PushOperations(SDKConfiguration); - Adjustments = new Adjustments(_client, _securitySource, _serverUrl, SDKConfiguration); + Accounts = new Accounts(SDKConfiguration); + BankAccounts = new BankAccounts(SDKConfiguration); - Reimbursements = new Reimbursements(_client, _securitySource, _serverUrl, SDKConfiguration); - - - Attachments = new Attachments(_client, _securitySource, _serverUrl, SDKConfiguration); + Customers = new Customers(SDKConfiguration); + Suppliers = new Suppliers(SDKConfiguration); + } - ManageData = new ManageData(_client, _securitySource, _serverUrl, SDKConfiguration); + private void InitHooks() + { + string preHooksUrl = SDKConfiguration.GetTemplatedServerUrl(); + var (postHooksUrl, postHooksClient) = SDKConfiguration.Hooks.SDKInit(preHooksUrl, SDKConfiguration.Client); + var config = SDKConfiguration; + if (preHooksUrl != postHooksUrl) + { + config.ServerUrl = postHooksUrl; + } + config.Client = postHooksClient; + SDKConfiguration = config; + } + /// + /// Builder class for constructing an instance of the SDK. + /// + public class SDKBuilder + { + private SDKConfig _sdkConfig = new SDKConfig(client: new SpeakeasyHttpClient()); - PushOperations = new PushOperations(_client, _securitySource, _serverUrl, SDKConfiguration); + public SDKBuilder() { } + /// + /// Overrides the default server by index. + /// + public SDKBuilder WithServerIndex(int serverIndex) + { + if (serverIndex < 0 || serverIndex >= SDKConfig.ServerList.Length) + { + throw new ArgumentOutOfRangeException($"Invalid server index {serverIndex}: must be between 0 (inclusive) and {SDKConfig.ServerList.Length} (exclusive)." ); + } + _sdkConfig.ServerIndex = serverIndex; + return this; + } - Accounts = new Accounts(_client, _securitySource, _serverUrl, SDKConfiguration); + /// + /// Overrides the default server URL for the SDK. + /// + public SDKBuilder WithServerUrl(string serverUrl, Dictionary? serverVariables = null) + { + if (serverVariables != null) + { + serverUrl = Utilities.TemplateUrl(serverUrl, serverVariables); + } + _sdkConfig.ServerUrl = serverUrl; + return this; + } + /// + /// Sets the authHeaderSource security parameter for the SDK. + /// + public SDKBuilder WithAuthHeaderSource(Func authHeaderSource) + { + _sdkConfig.SecuritySource = () => new Codat.Sync.Expenses.Models.Components.Security() { AuthHeader = authHeaderSource() }; + return this; + } - BankAccounts = new BankAccounts(_client, _securitySource, _serverUrl, SDKConfiguration); + /// + /// Sets the authHeader security parameter for the SDK. + /// + public SDKBuilder WithAuthHeader(string authHeader) + { + _sdkConfig.SecuritySource = () => new Codat.Sync.Expenses.Models.Components.Security() { AuthHeader = authHeader }; + return this; + } + /// + /// Sets a custom HTTP client to be used by the SDK. + /// + public SDKBuilder WithClient(ISpeakeasyHttpClient client) + { + _sdkConfig.Client = client; + return this; + } - Customers = new Customers(_client, _securitySource, _serverUrl, SDKConfiguration); + /// + /// Sets the retry configuration for the SDK. + /// + public SDKBuilder WithRetryConfig(RetryConfig retryConfig) + { + _sdkConfig.RetryConfig = retryConfig; + return this; + } + /// + /// Builds and returns the SDK instance. + /// + public CodatSyncExpenses Build() + { + if (_sdkConfig.SecuritySource == null) { + throw new ArgumentException("securitySource cannot be null. One of `AuthHeader` or `authHeaderSource` needs to be defined."); + } + return new CodatSyncExpenses(_sdkConfig); + } - Suppliers = new Suppliers(_client, _securitySource, _serverUrl, SDKConfiguration); } + + public static SDKBuilder Builder() => new SDKBuilder(); } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Companies.cs b/sync-for-expenses/Codat/Sync/Expenses/Companies.cs index 8269b13cd..61d7c2d92 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Companies.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Companies.cs @@ -13,36 +13,57 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// - /// Create and manage your SMB users' companies. + /// Create and manage your SMB users' companies. /// public interface ICompanies { - /// - /// List companies - /// + /// List companies. + /// /// /// The *List companies* endpoint returns a list of companies associated to your instances.
///
/// A company represents a business sharing access to their data.
- /// Each company can have multiple connections 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. + /// Each company can have multiple connections 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.
+ ///
+ /// ## Filter by tags
+ ///
+ /// The *List companies* endpoint supports the filtering of companies using tags. It supports the following operators with Codat’s query language:
+ ///
+ /// - equals (`=`)
+ /// - not equals (`!=`)
+ /// - contains (`~`)
+ ///
+ /// For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
+ /// - Foreign key: `uid = {yourCustomerId}`
+ /// - Region: `region != uk`
+ /// - Owning team and region: `region = uk && owningTeam = invoice-finance` /// - /// - Task ListAsync(ListCompaniesRequest? request = null, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCompaniesRequest? request = null, + RetryConfig? retryConfig = null + ); /// - /// Create company - /// + /// Create company. + /// /// /// Use the *Create company* endpoint to create a new company that represents your customer in Codat.
///
@@ -51,85 +72,163 @@ public interface ICompanies ///
/// 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`. /// - /// - Task CreateAsync(CompanyRequestBody? request = null, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CompanyRequestBody? request = null, + RetryConfig? retryConfig = null + ); /// - /// Update company - /// + /// Replace company. + /// /// - /// Use the *Update company* endpoint to update both the name and description of the company.
+ /// Use 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.
///
/// A company represents a business sharing access to their data.
/// Each company can have multiple connections 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. /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ReplaceAsync(ReplaceCompanyRequest request, RetryConfig? retryConfig = null); + + /// + /// Update company. /// - Task UpdateAsync(UpdateCompanyRequest request, RetryConfig? retryConfig = null); + /// + /// Use the *Update company* endpoint to update the name, description, or tags of the company.
+ ///
+ /// The *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.
+ ///
+ /// A company represents a business sharing access to their data. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UpdateAsync(UpdateCompanyRequest request, RetryConfig? retryConfig = null); /// - /// Delete a company - /// + /// Delete a company. + /// /// /// The *Delete company* endpoint permanently deletes a company, its connections and any cached data. This operation is irreversible.
///
/// A company represents a business sharing access to their data.
- /// Each company can have multiple connections 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.
- /// + /// Each company can have multiple connections 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. /// - /// - Task DeleteAsync(DeleteCompanyRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DeleteAsync(DeleteCompanyRequest request, RetryConfig? retryConfig = null); /// - /// Get company - /// + /// Get company. + /// /// /// The *Get company* endpoint returns a single company for a given `companyId`.
///
/// A company represents a business sharing access to their data.
- /// Each company can have multiple connections 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.
- /// + /// Each company can have multiple connections 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. /// - /// - Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null); } /// - /// Create and manage your SMB users' companies. + /// Create and manage your SMB users' companies. /// public class Companies: ICompanies { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Companies(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Companies(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task ListAsync(ListCompaniesRequest? request = null, RetryConfig? retryConfig = null) + /// + /// List companies. + /// + /// + /// The *List companies* endpoint returns a list of companies associated to your instances.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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.
+ ///
+ /// ## Filter by tags
+ ///
+ /// The *List companies* endpoint supports the filtering of companies using tags. It supports the following operators with Codat’s query language:
+ ///
+ /// - equals (`=`)
+ /// - not equals (`!=`)
+ /// - contains (`~`)
+ ///
+ /// For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
+ /// - Foreign key: `uid = {yourCustomerId}`
+ /// - Region: `region != uk`
+ /// - Owning team and region: `region = uk && owningTeam = invoice-finance` + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCompaniesRequest? request = null, + RetryConfig? retryConfig = null + ) { string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies", request); + var urlString = URLBuilder.Build(baseUrl, "/companies", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("list-companies", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-companies", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -163,8 +262,8 @@ public async Task ListAsync(ListCompaniesRequest? request Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -174,7 +273,7 @@ public async Task ListAsync(ListCompaniesRequest? request httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -183,9 +282,9 @@ public async Task ListAsync(ListCompaniesRequest? 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; @@ -204,7 +303,17 @@ public async Task ListAsync(ListCompaniesRequest? request { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Include); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.Companies obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Include); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.Companies.", httpResponse, httpResponseBody, ex); + } + var response = new ListCompaniesResponse() { StatusCode = responseStatusCode, @@ -215,34 +324,94 @@ public async Task ListAsync(ListCompaniesRequest? request return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Include); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Include); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Include); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CompanyRequestBody? request = null, RetryConfig? retryConfig = null) + + /// + /// Create company. + /// + /// + /// Use the *Create company* endpoint to create a new company that represents your customer in Codat.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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.
+ ///
+ /// 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`. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CompanyRequestBody? request = null, + RetryConfig? retryConfig = null + ) { string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = baseUrl + "/companies"; var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -250,12 +419,12 @@ public async Task CreateAsync(CompanyRequestBody? request httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-company", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-company", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -289,8 +458,8 @@ public async Task CreateAsync(CompanyRequestBody? request Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -300,7 +469,7 @@ public async Task CreateAsync(CompanyRequestBody? request httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -309,9 +478,9 @@ public async Task CreateAsync(CompanyRequestBody? 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; @@ -330,7 +499,17 @@ public async Task CreateAsync(CompanyRequestBody? request { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Include); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Company obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Include); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Company.", httpResponse, httpResponseBody, ex); + } + var response = new CreateCompanyResponse() { StatusCode = responseStatusCode, @@ -341,33 +520,95 @@ public async Task CreateAsync(CompanyRequestBody? request return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Include); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Include); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Include); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UpdateAsync(UpdateCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Replace company. + /// + /// + /// Use 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.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ReplaceAsync( + ReplaceCompanyRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -375,12 +616,12 @@ public async Task UpdateAsync(UpdateCompanyRequest reques httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("update-company", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "replace-company", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -414,8 +655,8 @@ public async Task UpdateAsync(UpdateCompanyRequest reques Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -425,7 +666,7 @@ public async Task UpdateAsync(UpdateCompanyRequest reques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -434,9 +675,9 @@ public async Task UpdateAsync(UpdateCompanyRequest reques } } } - 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; @@ -455,7 +696,215 @@ public async Task UpdateAsync(UpdateCompanyRequest reques { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Company obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Company.", httpResponse, httpResponseBody, ex); + } + + var response = new ReplaceCompanyResponse() + { + StatusCode = responseStatusCode, + ContentType = contentType, + RawResponse = httpResponse + }; + response.Company = obj; + return response; + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{500, 503}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + + + /// + /// Update company. + /// + /// + /// Use the *Update company* endpoint to update the name, description, or tags of the company.
+ ///
+ /// The *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.
+ ///
+ /// A company represents a business sharing access to their data. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UpdateAsync( + UpdateCompanyRequest request, + RetryConfig? retryConfig = null + ) + { + if (request == null) throw new ArgumentNullException(nameof(request)); + + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request, null); + + 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) + { + httpRequest.Content = serializedBody; + } + + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "update-company", null, SDKConfiguration.SecuritySource); + + httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); + if (retryConfig == null) + { + if (this.SDKConfiguration.RetryConfig != null) + { + retryConfig = this.SDKConfiguration.RetryConfig; + } + else + { + var backoff = new BackoffStrategy( + initialIntervalMs: 500L, + maxIntervalMs: 60000L, + maxElapsedTimeMs: 3600000L, + exponent: 1.5 + ); + retryConfig = new RetryConfig( + strategy: RetryConfig.RetryStrategy.BACKOFF, + backoff: backoff, + retryConnectionErrors: true + ); + } + } + + List statusCodes = new List + { + "408", + "429", + "5XX", + }; + + Func> retrySend = async () => + { + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); + }; + var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); + + HttpResponseMessage httpResponse; + try + { + httpResponse = await retries.Run(); + int _statusCode = (int)httpResponse.StatusCode; + + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) + { + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); + if (_httpResponse != null) + { + httpResponse = _httpResponse; + } + } + } + catch (Exception _hookError) + { + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); + if (_httpResponse != null) + { + httpResponse = _httpResponse; + } + else + { + throw; + } + } + + httpResponse = await this.SDKConfiguration.Hooks.AfterSuccessAsync(new AfterSuccessContext(hookCtx), httpResponse); + + var contentType = httpResponse.Content.Headers.ContentType?.MediaType; + int responseStatusCode = (int)httpResponse.StatusCode; + if(responseStatusCode == 200) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Company obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Company.", httpResponse, httpResponseBody, ex); + } + var response = new UpdateCompanyResponse() { StatusCode = responseStatusCode, @@ -466,40 +915,102 @@ public async Task UpdateAsync(UpdateCompanyRequest reques return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{500, 503}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DeleteAsync(DeleteCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Delete a company. + /// + /// + /// The *Delete company* endpoint permanently deletes a company, its connections and any cached data. This operation is irreversible.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DeleteAsync( + DeleteCompanyRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Delete, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("delete-company", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "delete-company", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -533,8 +1044,8 @@ public async Task DeleteAsync(DeleteCompanyRequest reques Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -544,7 +1055,7 @@ public async Task DeleteAsync(DeleteCompanyRequest reques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -553,9 +1064,9 @@ public async Task DeleteAsync(DeleteCompanyRequest reques } } } - 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; @@ -571,7 +1082,7 @@ public async Task DeleteAsync(DeleteCompanyRequest reques var contentType = httpResponse.Content.Headers.ContentType?.MediaType; int responseStatusCode = (int)httpResponse.StatusCode; if(responseStatusCode == 204) - { + { return new DeleteCompanyResponse() { StatusCode = responseStatusCode, @@ -579,38 +1090,97 @@ public async Task DeleteAsync(DeleteCompanyRequest reques RawResponse = httpResponse }; } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Get company. + /// + /// + /// The *Get company* endpoint returns a single company for a given `companyId`.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-company", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-company", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -644,8 +1214,8 @@ public async Task GetAsync(GetCompanyRequest request, RetryC Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -655,7 +1225,7 @@ public async Task GetAsync(GetCompanyRequest request, RetryC httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -664,9 +1234,9 @@ public async Task GetAsync(GetCompanyRequest request, RetryC } } } - 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; @@ -685,7 +1255,17 @@ public async Task GetAsync(GetCompanyRequest request, RetryC { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Company obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Company.", httpResponse, httpResponseBody, ex); + } + var response = new GetCompanyResponse() { StatusCode = responseStatusCode, @@ -696,24 +1276,59 @@ public async Task GetAsync(GetCompanyRequest request, RetryC return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/CompanyInfo.cs b/sync-for-expenses/Codat/Sync/Expenses/CompanyInfo.cs index 274b23dc6..2d4b6d040 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/CompanyInfo.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/CompanyInfo.cs @@ -13,68 +13,91 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// - /// View the company information of your customers' linked accounting software. + /// View the company information of your customers' linked accounting software. /// public interface ICompanyInfo { - /// - /// Get company info - /// + /// Get company info. + /// /// /// Gets the latest basic info for a company. /// - /// - Task GetAsync(GetCompanyInfoRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetCompanyInfoRequest request, RetryConfig? retryConfig = null); } /// - /// View the company information of your customers' linked accounting software. + /// View the company information of your customers' linked accounting software. /// public class CompanyInfo: ICompanyInfo { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public CompanyInfo(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public CompanyInfo(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task GetAsync(GetCompanyInfoRequest request, RetryConfig? retryConfig = null) + /// + /// Get company info. + /// + /// + /// Gets the latest basic info for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCompanyInfoRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/info", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/info", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-company-info", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-company-info", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -108,8 +131,8 @@ public async Task GetAsync(GetCompanyInfoRequest request Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -119,7 +142,7 @@ public async Task GetAsync(GetCompanyInfoRequest request httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -128,9 +151,9 @@ public async Task GetAsync(GetCompanyInfoRequest 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; @@ -149,7 +172,17 @@ public async Task GetAsync(GetCompanyInfoRequest request { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CompanyInformation obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CompanyInformation.", httpResponse, httpResponseBody, ex); + } + var response = new GetCompanyInfoResponse() { StatusCode = responseStatusCode, @@ -160,24 +193,59 @@ public async Task GetAsync(GetCompanyInfoRequest request return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 409, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 409, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Configuration.cs b/sync-for-expenses/Codat/Sync/Expenses/Configuration.cs index a01cd8f5a..1dd912db3 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Configuration.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Configuration.cs @@ -13,38 +13,57 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// View and manage mapping configuration and defaults for expense transactions. /// public interface IConfiguration { - /// - /// Get company configuration - /// + /// Get company configuration. + /// /// - /// Gets a company's expense sync configuration + /// Gets a company's expense sync configuration. /// - /// - Task GetAsync(GetCompanyConfigurationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCompanyConfigurationRequest request, + RetryConfig? retryConfig = null + ); /// - /// Set company configuration - /// + /// Set company configuration. + /// /// - /// Sets a company's expense sync configuration + /// Sets a company's expense sync configuration. /// - /// - Task SetAsync(SetCompanyConfigurationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task SetAsync( + SetCompanyConfigurationRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -52,38 +71,55 @@ public interface IConfiguration /// public class Configuration: IConfiguration { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Configuration(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Configuration(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task GetAsync(GetCompanyConfigurationRequest request, RetryConfig? retryConfig = null) + /// + /// Get company configuration. + /// + /// + /// Gets a company's expense sync configuration. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCompanyConfigurationRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/config", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/config", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-company-configuration", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-company-configuration", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -117,8 +153,8 @@ public async Task GetAsync(GetCompanyConfigurat Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -128,7 +164,7 @@ public async Task GetAsync(GetCompanyConfigurat httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -137,9 +173,9 @@ public async Task GetAsync(GetCompanyConfigurat } } } - 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; @@ -158,7 +194,17 @@ public async Task GetAsync(GetCompanyConfigurat { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CompanyConfiguration obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CompanyConfiguration.", httpResponse, httpResponseBody, ex); + } + var response = new GetCompanyConfigurationResponse() { StatusCode = responseStatusCode, @@ -169,33 +215,92 @@ public async Task GetAsync(GetCompanyConfigurat return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{500, 503}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task SetAsync(SetCompanyConfigurationRequest request, RetryConfig? retryConfig = null) + + /// + /// Set company configuration. + /// + /// + /// Sets a company's expense sync configuration. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task SetAsync( + SetCompanyConfigurationRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/config", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/config", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "CompanyConfiguration", "json", false, true); if (serializedBody != null) @@ -203,12 +308,12 @@ public async Task SetAsync(SetCompanyConfigurat httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("set-company-configuration", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "set-company-configuration", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -242,8 +347,8 @@ public async Task SetAsync(SetCompanyConfigurat Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -253,7 +358,7 @@ public async Task SetAsync(SetCompanyConfigurat httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -262,9 +367,9 @@ public async Task SetAsync(SetCompanyConfigurat } } } - 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,7 +388,17 @@ public async Task SetAsync(SetCompanyConfigurat { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CompanyConfiguration obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CompanyConfiguration.", httpResponse, httpResponseBody, ex); + } + var response = new SetCompanyConfigurationResponse() { StatusCode = responseStatusCode, @@ -294,24 +409,59 @@ public async Task SetAsync(SetCompanyConfigurat return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Connections.cs b/sync-for-expenses/Codat/Sync/Expenses/Connections.cs index 6b5e20e7f..9713957cc 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Connections.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Connections.cs @@ -13,77 +13,130 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Create new and manage existing data connections for a company. /// public interface IConnections { - /// - /// List connections - /// + /// List connections. + /// /// /// List the connections for a company. /// - /// - Task ListAsync(ListConnectionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync(ListConnectionsRequest request, RetryConfig? retryConfig = null); /// - /// Create connection - /// + /// Create connection. + /// /// /// Creates a connection for the company by providing a valid `platformKey`.
///
- /// Use the List Integrations endpoint to access valid platform keys. + /// Use the List Integrations endpoint to access valid platform keys. /// - /// - Task CreateAsync(CreateConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateConnectionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get connection - /// + /// Get connection. + /// /// /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. /// - /// - Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null); /// - /// Delete connection - /// + /// Delete connection. + /// /// /// Revoke and remove a connection from a company.
/// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. /// - /// - Task DeleteAsync(DeleteConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DeleteAsync( + DeleteConnectionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Unlink connection - /// + /// Unlink connection. + /// /// /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. /// - /// - Task UnlinkAsync(UnlinkConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UnlinkAsync( + UnlinkConnectionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create partner expense connection - /// + /// Create partner expense connection. + /// /// - /// Creates a partner expense data connection + /// Creates a partner expense data connection. /// - /// - Task CreatePartnerExpenseConnectionAsync(CreatePartnerExpenseConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreatePartnerExpenseConnectionAsync( + CreatePartnerExpenseConnectionRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -91,38 +144,55 @@ public interface IConnections /// public class Connections: IConnections { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Connections(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Connections(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task ListAsync(ListConnectionsRequest request, RetryConfig? retryConfig = null) + /// + /// List connections. + /// + /// + /// List the connections for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListConnectionsRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("list-connections", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-connections", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -156,8 +226,8 @@ public async Task ListAsync(ListConnectionsRequest requ Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -167,7 +237,7 @@ public async Task ListAsync(ListConnectionsRequest requ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -176,9 +246,9 @@ public async Task ListAsync(ListConnectionsRequest requ } } } - 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; @@ -197,7 +267,17 @@ public async Task ListAsync(ListConnectionsRequest requ { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.Connections obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.Connections.", httpResponse, httpResponseBody, ex); + } + var response = new ListConnectionsResponse() { StatusCode = responseStatusCode, @@ -208,33 +288,94 @@ public async Task ListAsync(ListConnectionsRequest requ return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Create connection. + /// + /// + /// Creates a connection for the company by providing a valid `platformKey`.
+ ///
+ /// Use the List Integrations endpoint to access valid platform keys. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateConnectionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -242,12 +383,12 @@ public async Task CreateAsync(CreateConnectionRequest httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-connection", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-connection", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -281,8 +422,8 @@ public async Task CreateAsync(CreateConnectionRequest Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -292,7 +433,7 @@ public async Task CreateAsync(CreateConnectionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -301,9 +442,9 @@ public async Task CreateAsync(CreateConnectionRequest } } } - 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; @@ -322,7 +463,17 @@ public async Task CreateAsync(CreateConnectionRequest { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Connection obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Connection.", httpResponse, httpResponseBody, ex); + } + var response = new CreateConnectionResponse() { StatusCode = responseStatusCode, @@ -333,40 +484,96 @@ public async Task CreateAsync(CreateConnectionRequest return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{500, 503}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Get connection. + /// + /// + /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-connection", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-connection", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -400,8 +607,8 @@ public async Task GetAsync(GetConnectionRequest request, Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -411,7 +618,7 @@ public async Task GetAsync(GetConnectionRequest request, httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -420,9 +627,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; @@ -441,7 +648,17 @@ public async Task GetAsync(GetConnectionRequest request, { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Connection obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Connection.", httpResponse, httpResponseBody, ex); + } + var response = new GetConnectionResponse() { StatusCode = responseStatusCode, @@ -452,40 +669,100 @@ public async Task GetAsync(GetConnectionRequest request, return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DeleteAsync(DeleteConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Delete connection. + /// + /// + /// Revoke and remove a connection from a company.
+ /// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DeleteAsync( + DeleteConnectionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Delete, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("delete-connection", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "delete-connection", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -519,8 +796,8 @@ public async Task DeleteAsync(DeleteConnectionRequest Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -530,7 +807,7 @@ public async Task DeleteAsync(DeleteConnectionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -539,9 +816,9 @@ public async Task DeleteAsync(DeleteConnectionRequest } } } - 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; @@ -557,7 +834,7 @@ public async Task DeleteAsync(DeleteConnectionRequest var contentType = httpResponse.Content.Headers.ContentType?.MediaType; int responseStatusCode = (int)httpResponse.StatusCode; if(responseStatusCode == 200) - { + { return new DeleteConnectionResponse() { StatusCode = responseStatusCode, @@ -565,31 +842,90 @@ public async Task DeleteAsync(DeleteConnectionRequest RawResponse = httpResponse }; } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UnlinkAsync(UnlinkConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Unlink connection. + /// + /// + /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UnlinkAsync( + UnlinkConnectionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Patch, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -597,12 +933,12 @@ public async Task UnlinkAsync(UnlinkConnectionRequest httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("unlink-connection", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "unlink-connection", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -636,8 +972,8 @@ public async Task UnlinkAsync(UnlinkConnectionRequest Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -647,7 +983,7 @@ public async Task UnlinkAsync(UnlinkConnectionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -656,9 +992,9 @@ public async Task UnlinkAsync(UnlinkConnectionRequest } } } - 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; @@ -677,7 +1013,17 @@ public async Task UnlinkAsync(UnlinkConnectionRequest { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Connection obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Connection.", httpResponse, httpResponseBody, ex); + } + var response = new UnlinkConnectionResponse() { StatusCode = responseStatusCode, @@ -688,40 +1034,99 @@ public async Task UnlinkAsync(UnlinkConnectionRequest return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreatePartnerExpenseConnectionAsync(CreatePartnerExpenseConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Create partner expense connection. + /// + /// + /// Creates a partner expense data connection. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreatePartnerExpenseConnectionAsync( + CreatePartnerExpenseConnectionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/connections/partnerExpense", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/connections/partnerExpense", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("create-partner-expense-connection", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-partner-expense-connection", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -755,8 +1160,8 @@ public async Task CreatePartnerExpenseCo Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -766,7 +1171,7 @@ public async Task CreatePartnerExpenseCo httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -775,9 +1180,9 @@ public async Task CreatePartnerExpenseCo } } } - 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; @@ -796,7 +1201,17 @@ public async Task CreatePartnerExpenseCo { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Connection obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Connection.", httpResponse, httpResponseBody, ex); + } + var response = new CreatePartnerExpenseConnectionResponse() { StatusCode = responseStatusCode, @@ -807,24 +1222,59 @@ public async Task CreatePartnerExpenseCo return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Customers.cs b/sync-for-expenses/Codat/Sync/Expenses/Customers.cs index 751c1fbfc..f0edcb219 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Customers.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Customers.cs @@ -13,78 +13,109 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Get, create, and update customers. /// public interface ICustomers { - /// - /// List customers - /// + /// List customers. + /// /// - /// The *List customers* endpoint returns a list of customers for a given company's connection.
+ /// The *List customers* endpoint returns a list of customers for a given company's connection.
///
/// Customers are people or organizations that buy goods or services from the SMB.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. /// - /// - Task ListAsync(ListCustomersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync(ListCustomersRequest request, RetryConfig? retryConfig = null); /// - /// Get customer - /// + /// Get customer. + /// /// /// The *Get customer* endpoint returns a single customer for a given customerId.
///
/// Customers are people or organizations that buy goods or services from the SMB.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. /// - /// - Task GetAsync(GetCustomerRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetCustomerRequest request, RetryConfig? retryConfig = null); /// - /// Create customer - /// + /// Create customer. + /// /// - /// The *Create customer* endpoint creates a new customer for a given company's connection.
+ /// The *Create customer* endpoint creates a new customer for a given company's connection.
///
/// Customers are people or organizations that buy goods or services from the SMB.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// Required data may vary by integration. To see what data to post, first call Get create/update customer model. /// - /// - Task CreateAsync(CreateCustomerRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateCustomerRequest request, + RetryConfig? retryConfig = null + ); /// - /// Update customer - /// + /// Update customer. + /// /// - /// The *Update customer* endpoint updates an existing customer for a given company's connection.
+ /// The *Update customer* endpoint updates an existing customer for a given company's connection.
///
/// Customers are people or organizations that buy goods or services from the SMB.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// Required data may vary by integration. To see what data to post, first call Get create/update customer model. /// - /// - Task UpdateAsync(UpdateCustomerRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UpdateAsync( + UpdateCustomerRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -92,38 +123,59 @@ public interface ICustomers /// public class Customers: ICustomers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Customers(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Customers(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task ListAsync(ListCustomersRequest request, RetryConfig? retryConfig = null) + /// + /// List customers. + /// + /// + /// The *List customers* endpoint returns a list of customers for a given company's connection.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCustomersRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/customers", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/customers", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("list-customers", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-customers", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -157,8 +209,8 @@ public async Task ListAsync(ListCustomersRequest request, Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -168,7 +220,7 @@ public async Task ListAsync(ListCustomersRequest request, httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -177,9 +229,9 @@ public async Task ListAsync(ListCustomersRequest 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; @@ -198,7 +250,17 @@ public async Task ListAsync(ListCustomersRequest request, { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.Customers obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.Customers.", httpResponse, httpResponseBody, ex); + } + var response = new ListCustomersResponse() { StatusCode = responseStatusCode, @@ -209,40 +271,100 @@ public async Task ListAsync(ListCustomersRequest request, return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 409, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 409, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCustomerRequest request, RetryConfig? retryConfig = null) + + /// + /// Get customer. + /// + /// + /// The *Get customer* endpoint returns a single customer for a given customerId.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetCustomerRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/customers/{customerId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/customers/{customerId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-customer", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-customer", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -276,8 +398,8 @@ public async Task GetAsync(GetCustomerRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -287,7 +409,7 @@ public async Task GetAsync(GetCustomerRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -296,9 +418,9 @@ public async Task GetAsync(GetCustomerRequest request, Retr } } } - 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; @@ -317,7 +439,17 @@ public async Task GetAsync(GetCustomerRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Customer obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Customer.", httpResponse, httpResponseBody, ex); + } + var response = new GetCustomerResponse() { StatusCode = responseStatusCode, @@ -328,33 +460,98 @@ public async Task GetAsync(GetCustomerRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 409, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 409, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateCustomerRequest request, RetryConfig? retryConfig = null) + + /// + /// Create customer. + /// + /// + /// The *Create customer* endpoint creates a new customer for a given company's connection.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update customer model. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateCustomerRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/customers", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/customers", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "Customer", "json", true, true); if (serializedBody != null) @@ -362,12 +559,12 @@ public async Task GetAsync(GetCustomerRequest request, Retr httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-customer", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-customer", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -401,8 +598,8 @@ public async Task GetAsync(GetCustomerRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -412,7 +609,7 @@ public async Task GetAsync(GetCustomerRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -421,9 +618,9 @@ public async Task GetAsync(GetCustomerRequest request, Retr } } } - 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; @@ -442,7 +639,17 @@ public async Task GetAsync(GetCustomerRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.CreateCustomerResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.CreateCustomerResponse.", httpResponse, httpResponseBody, ex); + } + var response = new Models.Requests.CreateCustomerResponse() { StatusCode = responseStatusCode, @@ -453,33 +660,98 @@ public async Task GetAsync(GetCustomerRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UpdateAsync(UpdateCustomerRequest request, RetryConfig? retryConfig = null) + + /// + /// Update customer. + /// + /// + /// The *Update customer* endpoint updates an existing customer for a given company's connection.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update customer model. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UpdateAsync( + UpdateCustomerRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "Customer", "json", true, true); if (serializedBody != null) @@ -487,12 +759,12 @@ public async Task GetAsync(GetCustomerRequest request, Retr httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("update-customer", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "update-customer", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -526,8 +798,8 @@ public async Task GetAsync(GetCustomerRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -537,7 +809,7 @@ public async Task GetAsync(GetCustomerRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -546,9 +818,9 @@ public async Task GetAsync(GetCustomerRequest request, Retr } } } - 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; @@ -567,7 +839,17 @@ public async Task GetAsync(GetCustomerRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.UpdateCustomerResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.UpdateCustomerResponse.", httpResponse, httpResponseBody, ex); + } + var response = new Models.Requests.UpdateCustomerResponse() { StatusCode = responseStatusCode, @@ -578,24 +860,59 @@ public async Task GetAsync(GetCustomerRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Expenses.cs b/sync-for-expenses/Codat/Sync/Expenses/Expenses.cs index 6b52964bf..56400cef1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Expenses.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Expenses.cs @@ -13,26 +13,25 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// - /// Create and update transactions that represent your customers' spend. + /// Create and update transactions that represent your customers' spend. /// public interface IExpenses { - /// - /// Create expense transaction - /// + /// Create expense transaction. + /// /// - /// The *Create expense* endpoint creates an expense transaction in the accounting software for a given company's connection.
+ /// The *Create expense* endpoint creates an expense transaction in the accounting software for a given company's connection.
///
/// Expense transactions represent transactions made with a company debit or credit card.
///
@@ -45,62 +44,125 @@ public interface IExpenses /// | QuickBooks Desktop | Yes |
/// | QuickBooks Online | Yes |
/// | Oracle NetSuite | Yes |
- /// | Xero | Yes | + /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | /// - /// - Task CreateAsync(CreateExpenseTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Update expense transactions - /// + /// Update expense transactions. + /// /// - /// The *Update expense* endpoint updates an existing expense transaction in the accounting software for a given company's connection.
+ /// The *Update expense* endpoint updates an existing expense transaction in the accounting software for a given company's connection.
///
/// Expense transactions represent transactions made with a company debit or credit card.
///
- /// ### Supported Integrations
+ /// ### Supported integrations
/// The following integrations are supported for the Payment transaction `type` only:
/// | Integration | Supported |
/// |-----------------------|-----------|
/// | FreeAgent | Yes |
+ /// | QuickBooks Desktop | Yes |
/// | QuickBooks Online | Yes |
/// | Oracle NetSuite | Yes |
- /// | Xero | Yes | + /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes |
+ ///
+ /// #### Integration-specific behavior
+ ///
+ /// | Integration | Specifics |
+ /// |-----------------------|-----------|
+ /// | Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.| /// - /// - Task UpdateAsync(UpdateExpenseTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 422, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UpdateAsync( + UpdateExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ); } /// - /// Create and update transactions that represent your customers' spend. + /// Create and update transactions that represent your customers' spend. /// public class Expenses: IExpenses { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Expenses(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Expenses(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task CreateAsync(CreateExpenseTransactionRequest request, RetryConfig? retryConfig = null) + /// + /// Create expense transaction. + /// + /// + /// The *Create expense* endpoint creates an expense transaction in the accounting software for a given company's connection.
+ ///
+ /// Expense transactions represent transactions made with a company debit or credit card.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/expense-transactions", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/expense-transactions", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -108,12 +170,12 @@ public async Task CreateAsync(CreateExpenseTra httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-expense-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-expense-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -147,8 +209,8 @@ public async Task CreateAsync(CreateExpenseTra Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -158,7 +220,7 @@ public async Task CreateAsync(CreateExpenseTra httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -167,9 +229,9 @@ public async Task CreateAsync(CreateExpenseTra } } } - 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; @@ -188,7 +250,17 @@ public async Task CreateAsync(CreateExpenseTra { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CreateExpenseResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CreateExpenseResponse.", httpResponse, httpResponseBody, ex); + } + var response = new CreateExpenseTransactionResponse() { StatusCode = responseStatusCode, @@ -199,33 +271,112 @@ public async Task CreateAsync(CreateExpenseTra return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UpdateAsync(UpdateExpenseTransactionRequest request, RetryConfig? retryConfig = null) + + /// + /// Update expense transactions. + /// + /// + /// The *Update expense* endpoint updates an existing expense transaction in the accounting software for a given company's connection.
+ ///
+ /// Expense transactions represent transactions made with a company debit or credit card.
+ ///
+ /// ### Supported integrations
+ /// The following integrations are supported for the Payment transaction `type` only:
+ /// | Integration | Supported |
+ /// |-----------------------|-----------|
+ /// | FreeAgent | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes |
+ ///
+ /// #### Integration-specific behavior
+ ///
+ /// | Integration | Specifics |
+ /// |-----------------------|-----------|
+ /// | Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.| + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 422, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UpdateAsync( + UpdateExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/expense-transactions/{transactionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/expense-transactions/{transactionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "UpdateExpenseRequest", "json", false, true); if (serializedBody != null) @@ -233,12 +384,12 @@ public async Task UpdateAsync(UpdateExpenseTra httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("update-expense-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "update-expense-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -272,8 +423,8 @@ public async Task UpdateAsync(UpdateExpenseTra Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -283,7 +434,7 @@ public async Task UpdateAsync(UpdateExpenseTra httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 422 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -292,9 +443,9 @@ public async Task UpdateAsync(UpdateExpenseTra } } } - 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; @@ -313,7 +464,17 @@ public async Task UpdateAsync(UpdateExpenseTra { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + UpdateExpenseResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into UpdateExpenseResponse.", httpResponse, httpResponseBody, ex); + } + var response = new UpdateExpenseTransactionResponse() { StatusCode = responseStatusCode, @@ -324,24 +485,59 @@ public async Task UpdateAsync(UpdateExpenseTra return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 422, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 422, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Hooks/HookTypes.cs b/sync-for-expenses/Codat/Sync/Expenses/Hooks/HookTypes.cs index 5a2909880..0705adbb0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Hooks/HookTypes.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Hooks/HookTypes.cs @@ -15,36 +15,61 @@ namespace Codat.Sync.Expenses.Hooks using System.Threading.Tasks; using Codat.Sync.Expenses.Utils; + /// + /// Base context class containing information passed to hooks during request execution. + /// public class HookContext { + public SDKConfig SDKConfiguration { get; set; } + public string BaseURL { get; set; } = ""; public string OperationID { get; set; } public List? Oauth2Scopes { get; set; } public Func? SecuritySource { get; set; } - public HookContext(string operationID, List? oauth2Scopes, Func? securitySource) + public HookContext(SDKConfig config, string baseURL, string operationID, List? oauth2Scopes, Func? securitySource) { + SDKConfiguration = config; + BaseURL = baseURL; OperationID = operationID; Oauth2Scopes = oauth2Scopes; SecuritySource = securitySource; } + + public HookContext(HookContext hookCtx) + { + SDKConfiguration = hookCtx.SDKConfiguration; + BaseURL = hookCtx.BaseURL; + OperationID = hookCtx.OperationID; + Oauth2Scopes = hookCtx.Oauth2Scopes; + SecuritySource = hookCtx.SecuritySource; + } } + /// + /// Context passed to before request hooks. + /// public class BeforeRequestContext : HookContext { public BeforeRequestContext(HookContext hookCtx) - : base(hookCtx.OperationID, hookCtx.Oauth2Scopes, hookCtx.SecuritySource) { } + : base(hookCtx) { } } + /// + /// Context passed to after success hooks. + /// public class AfterSuccessContext : HookContext { public AfterSuccessContext(HookContext hookCtx) - : base(hookCtx.OperationID, hookCtx.Oauth2Scopes, hookCtx.SecuritySource) { } + : base(hookCtx) { } } + /// + /// Context passed to after error hooks. + /// public class AfterErrorContext : HookContext { public AfterErrorContext(HookContext hookCtx) - : base(hookCtx.OperationID, hookCtx.Oauth2Scopes, hookCtx.SecuritySource) { } + : base(hookCtx) { } } /// @@ -66,7 +91,7 @@ public interface IBeforeRequestHook } /// - /// AfterSuccessAsync is called after the SDK receives a response. + /// AfterSuccessAsync hook is called after the SDK receives a successful response. /// The hook can modify the response before it is handled or throw an exception to stop the response from being handled. /// public interface IAfterSuccessHook @@ -75,16 +100,19 @@ public interface IAfterSuccessHook } /// - /// AfterErrorAsync is called after the SDK encounters an error, or a non-successful response. + /// AfterErrorAsync hook is called after the SDK encounters an error or a non-successful response. /// The hook can modify the response, if available, otherwise modify the error. - /// All hooks are called sequentially. If an error is returned, it will be passed to the subsequent hook implementing IAfterErrorHook. - /// If you want to prevent other AfterError hooks from being run, you can throw an FailEarlyException instead. + /// All hooks are called sequentially. If an error is returned, it will be passed to the subsequent after error hook. + /// If you want to prevent other after error hooks from being run, you can throw a instead. /// public interface IAfterErrorHook { Task<(HttpResponseMessage?, Exception?)> AfterErrorAsync(AfterErrorContext hookCtx, HttpResponseMessage? response, Exception? error); } + /// + /// Interface for managing SDK hook registrations. + /// public interface IHooks { void RegisterSDKInitHook(ISDKInitHook hook); diff --git a/sync-for-expenses/Codat/Sync/Expenses/Hooks/SDKHooks.cs b/sync-for-expenses/Codat/Sync/Expenses/Hooks/SDKHooks.cs index dd34098b2..54705c9f9 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Hooks/SDKHooks.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Hooks/SDKHooks.cs @@ -15,8 +15,14 @@ namespace Codat.Sync.Expenses.Hooks using System.Net.Http; using System.Threading.Tasks; + /// + /// Exception that can be thrown in implementations to prevent subsequent hooks from executing. + /// public sealed class FailEarlyException : Exception {} + /// + /// Manages and executes SDK hooks at various stages of the request lifecycle. + /// public class SDKHooks: IHooks { public List sdkInitHooks; @@ -33,26 +39,48 @@ public SDKHooks() HookRegistration.InitHooks(this); } + /// + /// Registers an SDK initialization hook to be executed when the SDK is initialized. + /// + /// The hook to register. public void RegisterSDKInitHook(ISDKInitHook hook) { this.sdkInitHooks.Add(hook); } + /// + /// Registers a before request hook to be executed before each HTTP request. + /// + /// The hook to register. public void RegisterBeforeRequestHook(IBeforeRequestHook hook) { this.beforeRequestHooks.Add(hook); } + /// + /// Registers an after success hook to be executed after successful HTTP responses. + /// + /// The hook to register. public void RegisterAfterSuccessHook(IAfterSuccessHook hook) { this.afterSuccessHooks.Add(hook); } + /// + /// Registers an after error hook to be executed after errors or non-successful responses. + /// + /// The hook to register. public void RegisterAfterErrorHook(IAfterErrorHook hook) { this.afterErrorHooks.Add(hook); } - + + /// + /// Executes all registered SDK initialization hooks. + /// + /// The base URL for the SDK. + /// The HTTP client. + /// The potentially modified base URL and HTTP client. public (string, ISpeakeasyHttpClient) SDKInit(string baseUrl, ISpeakeasyHttpClient client) { var urlAndClient = (baseUrl, client); @@ -68,7 +96,13 @@ public void RegisterAfterErrorHook(IAfterErrorHook hook) } return urlAndClient; } - + + /// + /// Executes all registered before request hooks. + /// + /// The hook context containing request metadata. + /// The HTTP request message. + /// The potentially modified HTTP request message. public async Task BeforeRequestAsync(BeforeRequestContext hookCtx, HttpRequestMessage request) { foreach (var hook in this.beforeRequestHooks) @@ -76,7 +110,8 @@ public async Task BeforeRequestAsync(BeforeRequestContext ho try { request = await hook.BeforeRequestAsync(hookCtx, request); - } catch (Exception ex) + } + catch (Exception ex) { throw new Exception("An error occurred while calling BeforeRequestAsync hook", ex); } @@ -84,6 +119,12 @@ public async Task BeforeRequestAsync(BeforeRequestContext ho return request; } + /// + /// Executes all registered after success hooks. + /// + /// The hook context containing request metadata. + /// The HTTP response message. + /// The potentially modified HTTP response message. public async Task AfterSuccessAsync(AfterSuccessContext hookCtx, HttpResponseMessage response) { foreach (var hook in this.afterSuccessHooks) @@ -100,19 +141,28 @@ public async Task AfterSuccessAsync(AfterSuccessContext hoo return response; } + /// + /// Executes all registered after error hooks. + /// + /// The hook context containing request metadata. + /// The HTTP response message, if available. + /// The exception that occurred, if any. + /// The potentially modified HTTP response message. + /// Thrown by a hook to prevent subsequent error hooks from executing. public async Task AfterErrorAsync(AfterErrorContext hookCtx, HttpResponseMessage? response, Exception? error) { - (HttpResponseMessage?, Exception?) responseAndError = (response, error); foreach (var hook in this.afterErrorHooks) { try { responseAndError = await hook.AfterErrorAsync(hookCtx, responseAndError.Item1, responseAndError.Item2); - } catch (FailEarlyException) + } + catch (FailEarlyException) { throw; - } catch (Exception ex) + } + catch (Exception ex) { throw new Exception("An error occurred while calling AfterErrorAsync hook", ex); } diff --git a/sync-for-expenses/Codat/Sync/Expenses/ManageData.cs b/sync-for-expenses/Codat/Sync/Expenses/ManageData.cs index 81bd93d35..4c5196356 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/ManageData.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/ManageData.cs @@ -13,24 +13,23 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Control and monitor the retrieval of data from an integration. /// public interface IManageData { - /// - /// Refresh all data - /// + /// Refresh all data. + /// /// /// Refreshes all data types with `fetch on first link` set to `true` for a given company.
///
@@ -38,46 +37,93 @@ public interface IManageData ///
/// Read more about data type settings and `fetch on first link`. /// - /// - Task RefreshAllDataTypesAsync(RefreshAllDataTypesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task RefreshAllDataTypesAsync( + RefreshAllDataTypesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get data status - /// + /// Get data status. + /// /// - /// Get the state of each data type for a company + /// Get the state of each data type for a company. /// - /// - Task GetAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null); /// - /// Refresh data type - /// + /// Refresh data type. + /// /// /// 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. /// - /// - Task RefreshDataTypeAsync(RefreshDataTypeRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task RefreshDataTypeAsync( + RefreshDataTypeRequest request, + RetryConfig? retryConfig = null + ); /// - /// List pull operations - /// + /// List pull operations. + /// /// /// Gets the pull operation history (datasets) for a given company. /// - /// - Task ListPullOperationsAsync(ListPullOperationsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListPullOperationsAsync( + ListPullOperationsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get pull operation - /// + /// Get pull operation. + /// /// /// Retrieve information about a single dataset or pull operation. /// - /// - Task GetPullOperationAsync(GetPullOperationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetPullOperationAsync( + GetPullOperationRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -85,38 +131,59 @@ public interface IManageData /// public class ManageData: IManageData { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public ManageData(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public ManageData(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task RefreshAllDataTypesAsync(RefreshAllDataTypesRequest request, RetryConfig? retryConfig = null) + /// + /// Refresh all data. + /// + /// + /// 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 about data type settings and `fetch on first link`. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task RefreshAllDataTypesAsync( + RefreshAllDataTypesRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/all", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/all", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("refresh-all-data-types", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "refresh-all-data-types", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -150,8 +217,8 @@ public async Task RefreshAllDataTypesAsync(RefreshA Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -161,7 +228,7 @@ public async Task RefreshAllDataTypesAsync(RefreshA httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -170,9 +237,9 @@ public async Task RefreshAllDataTypesAsync(RefreshA } } } - 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; @@ -188,7 +255,7 @@ public async Task RefreshAllDataTypesAsync(RefreshA var contentType = httpResponse.Content.Headers.ContentType?.MediaType; int responseStatusCode = (int)httpResponse.StatusCode; if(responseStatusCode == 204) - { + { return new RefreshAllDataTypesResponse() { StatusCode = responseStatusCode, @@ -196,38 +263,94 @@ public async Task RefreshAllDataTypesAsync(RefreshA RawResponse = httpResponse }; } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null) + + /// + /// Get data status. + /// + /// + /// Get the state of each data type for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/dataStatus", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/dataStatus", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-data-status", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-data-status", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -261,8 +384,8 @@ public async Task GetAsync(GetDataStatusRequest request, Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -272,7 +395,7 @@ public async Task GetAsync(GetDataStatusRequest request, httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -281,9 +404,9 @@ public async Task GetAsync(GetDataStatusRequest 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; @@ -302,7 +425,17 @@ public async Task GetAsync(GetDataStatusRequest request, { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + GetDataStatusDataStatuses obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into GetDataStatusDataStatuses.", httpResponse, httpResponseBody, ex); + } + var response = new GetDataStatusResponse() { StatusCode = responseStatusCode, @@ -313,40 +446,101 @@ public async Task GetAsync(GetDataStatusRequest request, return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task RefreshDataTypeAsync(RefreshDataTypeRequest request, RetryConfig? retryConfig = null) + + /// + /// Refresh data type. + /// + /// + /// 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. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task RefreshDataTypeAsync( + RefreshDataTypeRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/queue/{dataType}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/queue/{dataType}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("refresh-data-type", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "refresh-data-type", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -380,8 +574,8 @@ public async Task RefreshDataTypeAsync(RefreshDataTypeR Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -391,7 +585,7 @@ public async Task RefreshDataTypeAsync(RefreshDataTypeR httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -400,9 +594,9 @@ public async Task RefreshDataTypeAsync(RefreshDataTypeR } } } - 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; @@ -421,7 +615,17 @@ public async Task RefreshDataTypeAsync(RefreshDataTypeR { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + PullOperation obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into PullOperation.", httpResponse, httpResponseBody, ex); + } + var response = new RefreshDataTypeResponse() { StatusCode = responseStatusCode, @@ -432,40 +636,99 @@ public async Task RefreshDataTypeAsync(RefreshDataTypeR return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListPullOperationsAsync(ListPullOperationsRequest request, RetryConfig? retryConfig = null) + + /// + /// List pull operations. + /// + /// + /// Gets the pull operation history (datasets) for a given company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListPullOperationsAsync( + ListPullOperationsRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/history", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/history", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("list-pull-operations", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-pull-operations", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -499,8 +762,8 @@ public async Task ListPullOperationsAsync(ListPullOp Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -510,7 +773,7 @@ public async Task ListPullOperationsAsync(ListPullOp httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -519,9 +782,9 @@ public async Task ListPullOperationsAsync(ListPullOp } } } - 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; @@ -540,7 +803,17 @@ public async Task ListPullOperationsAsync(ListPullOp { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + PullOperations obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into PullOperations.", httpResponse, httpResponseBody, ex); + } + var response = new ListPullOperationsResponse() { StatusCode = responseStatusCode, @@ -551,40 +824,99 @@ public async Task ListPullOperationsAsync(ListPullOp return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetPullOperationAsync(GetPullOperationRequest request, RetryConfig? retryConfig = null) + + /// + /// Get pull operation. + /// + /// + /// Retrieve information about a single dataset or pull operation. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetPullOperationAsync( + GetPullOperationRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/history/{datasetId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/history/{datasetId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-pull-operation", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-pull-operation", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -618,8 +950,8 @@ public async Task GetPullOperationAsync(GetPullOperati Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -629,7 +961,7 @@ public async Task GetPullOperationAsync(GetPullOperati httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -638,9 +970,9 @@ public async Task GetPullOperationAsync(GetPullOperati } } } - 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; @@ -659,7 +991,17 @@ public async Task GetPullOperationAsync(GetPullOperati { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + PullOperation obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into PullOperation.", httpResponse, httpResponseBody, ex); + } + var response = new GetPullOperationResponse() { StatusCode = responseStatusCode, @@ -670,24 +1012,59 @@ public async Task GetPullOperationAsync(GetPullOperati return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/MappingOptions.cs b/sync-for-expenses/Codat/Sync/Expenses/MappingOptions.cs index acc6ee143..aa7941812 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/MappingOptions.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/MappingOptions.cs @@ -13,29 +13,38 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Get accounts, trackingCategories and taxRates that can be used in your create and update requests. /// public interface IMappingOptions { - /// - /// Mapping options - /// + /// Mapping options. + /// /// - /// Gets the mapping options (accounts, trackingCategories and taxRates) for a company's accounting software + /// Gets the mapping options (accounts, trackingCategories and taxRates) for a company's accounting software. /// - /// - Task GetMappingOptionsAsync(GetMappingOptionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetMappingOptionsAsync( + GetMappingOptionsRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -43,38 +52,55 @@ public interface IMappingOptions /// public class MappingOptions: IMappingOptions { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public MappingOptions(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public MappingOptions(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task GetMappingOptionsAsync(GetMappingOptionsRequest request, RetryConfig? retryConfig = null) + /// + /// Mapping options. + /// + /// + /// Gets the mapping options (accounts, trackingCategories and taxRates) for a company's accounting software. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetMappingOptionsAsync( + GetMappingOptionsRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/mappingOptions", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/mappingOptions", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-mapping-options", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-mapping-options", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -108,8 +134,8 @@ public async Task GetMappingOptionsAsync(GetMappingOp Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -119,7 +145,7 @@ public async Task GetMappingOptionsAsync(GetMappingOp httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -128,9 +154,9 @@ public async Task GetMappingOptionsAsync(GetMappingOp } } } - 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; @@ -149,7 +175,17 @@ public async Task GetMappingOptionsAsync(GetMappingOp { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.MappingOptions obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.MappingOptions.", httpResponse, httpResponseBody, ex); + } + var response = new GetMappingOptionsResponse() { StatusCode = responseStatusCode, @@ -160,24 +196,59 @@ public async Task GetMappingOptionsAsync(GetMappingOp return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs index cde2db877..c07d2f5a5 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfo.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountMappingInfo { - /// /// Unique identifier of account. /// @@ -30,7 +29,7 @@ public class AccountMappingInfo public string? NominalCode { get; set; } = null; /// - /// Name of the account as it appears in the company's accounting software. + /// Name of the account as it appears in the company's accounting software. /// [JsonProperty("name")] public string? Name { get; set; } @@ -48,7 +47,7 @@ public class AccountMappingInfo public AccountMappingInfoAccountType? AccountType { get; set; } /// - /// Full account type and category of the account + /// Full account type and category of the account. /// [JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs index 3ca0ea298..eb4b66f80 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountMappingInfoAccountType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Type of the account. /// @@ -62,5 +62,4 @@ public static AccountMappingInfoAccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountMappingInfoAccountType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountPrototype.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountPrototype.cs index 7f4d53c0c..a14e3d8cb 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountPrototype.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountPrototype.cs @@ -13,12 +13,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountPrototype { - /// - /// 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. + /// 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. /// [JsonProperty("nominalCode")] public string? NominalCode { get; set; } = null; @@ -37,38 +36,29 @@ public class AccountPrototype /// /// 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 guide, or refer to the integration's own documentation. - /// + /// 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 guide, or refer to the integration's own documentation. /// [JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } = null; /// /// Full name of the account, for example:
- /// - /// /// - `Cash On Hand`
/// - `Rents Held In Trust`
/// - `Fixed Asset` - /// /// [JsonProperty("fullyQualifiedName")] public string? FullyQualifiedName { get; set; } = null; /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("currency")] public string? Currency { get; set; } @@ -80,13 +70,13 @@ public class AccountPrototype public decimal? CurrentBalance { get; set; } = null; /// - /// Type of account + /// Type of account. /// [JsonProperty("type")] public AccountType? Type { get; set; } /// - /// Status of the account + /// Status of the account. /// [JsonProperty("status")] public AccountStatus? Status { get; set; } @@ -105,11 +95,8 @@ public class AccountPrototype /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountReference.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountReference.cs index e922037fc..91d9d6cc1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountReference.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountReference.cs @@ -11,15 +11,14 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// Reference of the account you are transferring money from. /// public class AccountReference { - /// - /// 'id' from the Accounts data type. + /// 'id' from the Accounts data type. /// [JsonProperty("id")] public string Id { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountStatus.cs index 8e5888caa..53e93c055 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountStatus.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// Status of the account + /// Status of the account. /// public enum AccountStatus { @@ -60,5 +60,4 @@ public static AccountStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountType.cs index fae535340..733f41750 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountType.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// Type of account + /// Type of account. /// public enum AccountType { @@ -64,5 +64,4 @@ public static AccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAccount.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAccount.cs index 103db87ff..828301dd9 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAccount.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAccount.cs @@ -12,13 +12,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + /// /// > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
- /// - /// ///
/// ## Overview
///
@@ -37,18 +35,17 @@ namespace Codat.Sync.Expenses.Models.Components ///
/// To determine the list of allowed categories for a specific integration, you can:
/// - Follow our Create, update, delete data guide and use the Get create account model.
- /// - Refer to the integration's own documentation.
+ /// - Refer to the integration's own documentation.
///
/// > **Accounts with no category**
/// >
- /// > 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`.
+ /// > 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`.
/// >
- /// > 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. - /// - /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible.")] + /// > 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. + /// + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -62,7 +59,7 @@ public class AccountingAccount public string? Id { get; set; } /// - /// 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. + /// 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. /// [JsonProperty("nominalCode")] public string? NominalCode { get; set; } = null; @@ -81,38 +78,29 @@ public class AccountingAccount /// /// 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 guide, or refer to the integration's own documentation. - /// + /// 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 guide, or refer to the integration's own documentation. /// [JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } = null; /// /// Full name of the account, for example:
- /// - /// /// - `Cash On Hand`
/// - `Rents Held In Trust`
/// - `Fixed Asset` - /// /// [JsonProperty("fullyQualifiedName")] public string? FullyQualifiedName { get; set; } = null; /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("currency")] public string? Currency { get; set; } @@ -124,13 +112,13 @@ public class AccountingAccount public decimal? CurrentBalance { get; set; } = null; /// - /// Type of account + /// Type of account. /// [JsonProperty("type")] public AccountType? Type { get; set; } /// - /// Status of the account + /// Status of the account. /// [JsonProperty("status")] public AccountStatus? Status { get; set; } @@ -149,11 +137,8 @@ public class AccountingAccount /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddress.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddress.cs index f31e6c871..b43cc548c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddress.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddress.cs @@ -12,12 +12,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class AccountingAddress { - /// - /// The type of the address + /// The type of the address. /// [JsonProperty("type")] public AccountingAddressType Type { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs index c0675d38b..a9414b5e5 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingAddressType.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of the address + /// The type of the address. /// public enum AccountingAddressType { @@ -58,5 +58,4 @@ public static AccountingAddressType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingAddressType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs index 9e73bec18..5a4a9e677 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingBankAccount.cs @@ -13,11 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// > **Accessing Bank Accounts through Banking API**
- /// - /// /// >
/// > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
/// >
@@ -31,11 +29,10 @@ namespace Codat.Sync.Expenses.Models.Components /// * The name and ID of the account in the accounting software.
/// * The currency and balance of the account.
/// * The sort code and account number. - /// - /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible.")] + /// + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingBankAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -56,11 +53,8 @@ public class AccountingBankAccount /// /// 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. - /// /// [JsonProperty("accountType")] public CreateBankAccountResponseBankAccountType? AccountType { get; set; } @@ -73,27 +67,21 @@ public class AccountingBankAccount /// /// 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. - /// /// [JsonProperty("sortCode")] public string? SortCode { get; set; } = null; /// /// 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. - /// /// [JsonProperty("accountNumber")] public string? AccountNumber { get; set; } = null; @@ -106,15 +94,12 @@ public class AccountingBankAccount /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("currency")] public string? Currency { get; set; } @@ -139,11 +124,8 @@ public class AccountingBankAccount /// /// 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`. - /// /// [JsonProperty("overdraftLimit")] public decimal? OverdraftLimit { get; set; } = null; @@ -159,11 +141,8 @@ public class AccountingBankAccount /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs index b24c7120e..7cbe5b866 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingCustomer.cs @@ -12,23 +12,19 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + /// /// ## 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.
///
- /// Customers' data links to accounts receivable invoices.
- /// - /// - /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible.")] + /// Customers' data links to accounts receivable invoices. + /// + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCustomer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -61,15 +57,12 @@ public class AccountingCustomer /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } @@ -115,11 +108,8 @@ public class AccountingCustomer /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs index 70c737db5..49f325b54 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AccountingSupplier.cs @@ -12,20 +12,17 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + /// /// ## Overview
- /// - /// ///
- /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. - /// - /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible.")] + /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. + /// + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingSupplier { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -75,7 +72,7 @@ public class AccountingSupplier public string? RegistrationNumber { get; set; } = null; /// - /// Supplier's company tax number. + /// Supplier's company tax number. /// [JsonProperty("taxNumber")] public string? TaxNumber { get; set; } = null; @@ -87,7 +84,7 @@ public class AccountingSupplier public SupplierStatus Status { get; set; } = default!; /// - /// Default currency the supplier's transactional data is recorded in. + /// Default currency the supplier's transactional data is recorded in. /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } = null; @@ -97,11 +94,8 @@ public class AccountingSupplier /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs index 02ef219de..340db13d1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionLine.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AdjustmentTransactionLine { - /// /// Amount of the line. A positive line represents a debit; a negative line represents a credit. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs index 0b17584db..f852a3a4b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionRequest.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AdjustmentTransactionRequest { - /// /// Your unique identifier for the transaction. /// @@ -24,9 +23,7 @@ public class AdjustmentTransactionRequest public string Id { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -45,7 +42,6 @@ public class AdjustmentTransactionRequest /// >
/// > 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. - /// /// [JsonProperty("date")] public string Date { get; set; } = default!; @@ -58,12 +54,10 @@ public class AdjustmentTransactionRequest /// /// 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.
+ /// 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).
///
@@ -91,7 +85,6 @@ public class AdjustmentTransactionRequest /// | 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. | - /// /// [JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs index 53b8fce12..c6d4e7f33 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AdjustmentTransactionResponse.cs @@ -11,12 +11,11 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class AdjustmentTransactionResponse { - /// - /// Unique id of sync created + /// Unique id of sync created. /// [JsonProperty("syncId")] public string? SyncId { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ApAccountRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ApAccountRef.cs index f540d9a96..e82b7285c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ApAccountRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ApAccountRef.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ApAccountRef { - /// /// Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Attachment.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Attachment.cs index 71011ebed..069a9ccf0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Attachment.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Attachment.cs @@ -11,24 +11,23 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class Attachment { - /// - /// Unique ID of company in Codat + /// Unique ID of company in Codat. /// [JsonProperty("companyId")] public string? CompanyId { get; set; } /// - /// Unique identifier of attachment + /// Unique identifier of attachment. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// Unique identifier of transaction + /// Unique identifier of transaction. /// [JsonProperty("transactionId")] public string? TransactionId { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs index 506a802cb..3d314d726 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/AttachmentUpload.cs @@ -11,14 +11,13 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class AttachmentUpload { - /// /// The file to be uploaded as an attachment. /// - [SpeakeasyMetadata("multipartForm:file")] + [SpeakeasyMetadata("multipartForm:file,name=file")] public CodatFile File { get; set; } = default!; } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccount.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccount.cs index a4b8eb547..8cd55a83d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccount.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccount.cs @@ -12,11 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// > **Accessing Bank Accounts through Banking API**
- /// - /// /// >
/// > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
/// >
@@ -30,11 +28,9 @@ namespace Codat.Sync.Expenses.Models.Components /// * The name and ID of the account in the accounting software.
/// * The currency and balance of the account.
/// * The sort code and account number. - /// /// public class BankAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -55,11 +51,8 @@ public class BankAccount /// /// 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. - /// /// [JsonProperty("accountType")] public BankAccountType? AccountType { get; set; } @@ -72,27 +65,21 @@ public class BankAccount /// /// 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. - /// /// [JsonProperty("sortCode")] public string? SortCode { get; set; } = null; /// /// 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. - /// /// [JsonProperty("accountNumber")] public string? AccountNumber { get; set; } = null; @@ -105,15 +92,12 @@ public class BankAccount /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("currency")] public string? Currency { get; set; } @@ -138,11 +122,8 @@ public class BankAccount /// /// 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`. - /// /// [JsonProperty("overdraftLimit")] public decimal? OverdraftLimit { get; set; } = null; @@ -158,11 +139,8 @@ public class BankAccount /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs index 1d359a652..de3ef029e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountDetails.cs @@ -11,12 +11,11 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class BankAccountDetails { - /// - /// The id of the account from which purchases are made + /// The id of the account from which purchases are made. /// [JsonProperty("id")] public string? Id { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountReference.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountReference.cs index 21d34a2fe..51c5e0082 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountReference.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountReference.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class BankAccountReference { - /// /// Identifier of the bank account. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs index 1aee6f8ca..14fc64457 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the bank account. /// @@ -60,5 +60,4 @@ public static BankAccountStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BankAccountStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountType.cs index cb39ef89f..08990b26c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/BankAccountType.cs @@ -12,14 +12,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// 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. - /// /// public enum BankAccountType { @@ -63,5 +60,4 @@ public static BankAccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BankAccountType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhook.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhook.cs deleted file mode 100644 index 4b520e4bc..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhook.cs +++ /dev/null @@ -1,63 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Components -{ - using Codat.Sync.Expenses.Models.Components; - using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - using System; - - /// - /// Webhook request body for a client that has reached their rate limit. - /// - public class ClientRateLimitReachedWebhook - { - - /// - /// Unique identifier for your client in Codat. - /// - [JsonProperty("ClientId")] - public string? ClientId { get; set; } - - /// - /// Name of your client in Codat. - /// - [JsonProperty("ClientName")] - public string? ClientName { get; set; } - - /// - /// Unique identifier for the rule. - /// - [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] - [JsonProperty("RuleId")] - public string? RuleId { get; set; } - - /// - /// The type of rule. - /// - [JsonProperty("RuleType")] - public string? RuleType { get; set; } - - /// - /// Unique identifier of the webhook event. - /// - [JsonProperty("AlertId")] - public string? AlertId { get; set; } - - /// - /// A human-readable message about the webhook. - /// - [JsonProperty("Message")] - public string? Message { get; set; } - - [JsonProperty("Data")] - public ClientRateLimitReachedWebhookData? Data { get; set; } - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhookData.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhookData.cs deleted file mode 100644 index 160b2cad5..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitReachedWebhookData.cs +++ /dev/null @@ -1,51 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Components -{ - using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - - public class ClientRateLimitReachedWebhookData - { - - /// - /// The number of available requests per day. - /// - [JsonProperty("DailyQuota")] - public long? DailyQuota { get; set; } - - /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. - /// - /// - [JsonProperty("ExpiresUtc")] - public string? ExpiresUtc { get; set; } - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhook.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhook.cs deleted file mode 100644 index e34c7612e..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhook.cs +++ /dev/null @@ -1,63 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Components -{ - using Codat.Sync.Expenses.Models.Components; - using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - using System; - - /// - /// Webhook request body for a client that has had their rate limit reset. - /// - public class ClientRateLimitResetWebhook - { - - /// - /// Unique identifier for your client in Codat. - /// - [JsonProperty("ClientId")] - public string? ClientId { get; set; } - - /// - /// Name of your client in Codat. - /// - [JsonProperty("ClientName")] - public string? ClientName { get; set; } - - /// - /// Unique identifier for the rule. - /// - [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] - [JsonProperty("RuleId")] - public string? RuleId { get; set; } - - /// - /// The type of rule. - /// - [JsonProperty("RuleType")] - public string? RuleType { get; set; } - - /// - /// Unique identifier of the webhook event. - /// - [JsonProperty("AlertId")] - public string? AlertId { get; set; } - - /// - /// A human-readable message about the webhook. - /// - [JsonProperty("Message")] - public string? Message { get; set; } - - [JsonProperty("Data")] - public ClientRateLimitResetWebhookData? Data { get; set; } - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhookData.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhookData.cs deleted file mode 100644 index 8a2658c37..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitResetWebhookData.cs +++ /dev/null @@ -1,63 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Components -{ - using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - - public class ClientRateLimitResetWebhookData - { - - /// - /// Total number of requests remaining for your client. - /// - [JsonProperty("QuotaRemaining")] - public long? QuotaRemaining { get; set; } = null; - - /// - /// The reason for your rate limit quota being reset. - /// - [JsonProperty("ResetReason")] - public string? ResetReason { get; set; } - - /// - /// The number of available requests per day. - /// - [JsonProperty("DailyQuota")] - public long? DailyQuota { get; set; } - - /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. - /// - /// - [JsonProperty("ExpiresUtc")] - public string? ExpiresUtc { get; set; } - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs index 41fe3f3a1..f73dbee2a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhook.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ClientRateLimitWebhook { - /// /// Unique identifier of the event. /// @@ -29,9 +28,7 @@ public class ClientRateLimitWebhook public string? EventType { get; set; } /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -50,7 +47,6 @@ public class ClientRateLimitWebhook /// >
/// > 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. - /// /// [JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs index 99c6f15e0..28b8e1e8b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ClientRateLimitWebhookPayload.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ClientRateLimitWebhookPayload { - /// /// The number of available requests per day. /// @@ -28,9 +27,7 @@ public class ClientRateLimitWebhookPayload public long? QuotaRemaining { get; set; } /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -49,7 +46,6 @@ public class ClientRateLimitWebhookPayload /// >
/// > 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. - /// /// [JsonProperty("expiryDate")] public string? ExpiryDate { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CodatFile.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CodatFile.cs index 2ab9038d8..63780d6f0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CodatFile.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CodatFile.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; - + public class CodatFile { - [SpeakeasyMetadata("multipartForm:name=fileName")] public string FileName { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Companies.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Companies.cs index fe229ae97..912aded47 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Companies.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Companies.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Companies { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Company.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Company.cs index 6a9ea370b..fc71618e0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Company.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Company.cs @@ -13,20 +13,16 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// In Codat, a company represents a business sharing access to their data. Each company can have multiple connections 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.
- /// - /// ///
/// Typically each company is one of your customers.
///
/// When 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. - /// /// public class Company { - /// /// Unique identifier for your SMB in Codat. /// @@ -34,7 +30,7 @@ public class Company public string Id { get; set; } = default!; /// - /// The name of the company + /// The name of the company. /// [JsonProperty("name")] public string Name { get; set; } = default!; @@ -52,9 +48,7 @@ public class Company public string Redirect { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +67,12 @@ public class Company /// >
/// > 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. - /// /// [JsonProperty("lastSync")] public string? LastSync { get; set; } /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +91,6 @@ public class Company /// >
/// > 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. - /// /// [JsonProperty("created")] public string? Created { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs index f8bf3c511..7530c70e7 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyConfiguration.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CompanyConfiguration { - [JsonProperty("bankAccount")] public BankAccountDetails BankAccount { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformation.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformation.cs index 464ae698d..b822015ac 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformation.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformation.cs @@ -13,20 +13,16 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// 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. - /// /// public class CompanyInformation { - /// /// Name of the linked company. /// @@ -64,9 +60,7 @@ public class CompanyInformation public List? WebLinks { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -85,7 +79,6 @@ public class CompanyInformation /// >
/// > 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. - /// /// [JsonProperty("ledgerLockDate")] public string? LedgerLockDate { get; set; } @@ -103,9 +96,7 @@ public class CompanyInformation public string? TaxNumber { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -124,7 +115,6 @@ public class CompanyInformation /// >
/// > 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. - /// /// [JsonProperty("financialYearStartDate")] public string? FinancialYearStartDate { get; set; } @@ -137,19 +127,14 @@ public class CompanyInformation /// /// 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. - /// /// [JsonProperty("sourceUrls")] - public Dictionary? SourceUrls { get; set; } = null; + public Dictionary? SourceUrls { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -168,18 +153,14 @@ public class CompanyInformation /// >
/// > 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. - /// /// [JsonProperty("createdDate")] public string? CreatedDate { get; set; } /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationPhoneNumbersType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationPhoneNumbersType.cs new file mode 100644 index 000000000..8ff1987fd --- /dev/null +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationPhoneNumbersType.cs @@ -0,0 +1,65 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace Codat.Sync.Expenses.Models.Components +{ + using Codat.Sync.Expenses.Utils; + using Newtonsoft.Json; + using System; + + /// + /// The type of phone number. + /// + public enum CompanyInformationPhoneNumbersType + { + [JsonProperty("Primary")] + Primary, + [JsonProperty("Landline")] + Landline, + [JsonProperty("Mobile")] + Mobile, + [JsonProperty("Fax")] + Fax, + [JsonProperty("Unknown")] + Unknown, + } + + public static class CompanyInformationPhoneNumbersTypeExtension + { + public static string Value(this CompanyInformationPhoneNumbersType value) + { + return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); + } + + public static CompanyInformationPhoneNumbersType ToEnum(this string value) + { + foreach(var field in typeof(CompanyInformationPhoneNumbersType).GetFields()) + { + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; + if (attribute != null && attribute.PropertyName == value) + { + var enumVal = field.GetValue(null); + + if (enumVal is CompanyInformationPhoneNumbersType) + { + return (CompanyInformationPhoneNumbersType)enumVal; + } + } + } + + throw new Exception($"Unknown value {value} for enum CompanyInformationPhoneNumbersType"); + } + } +} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs index 9d2ed50ed..abef4a8f4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyInformationType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The type of the weblink. /// @@ -58,5 +58,4 @@ public static CompanyInformationType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CompanyInformationType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReference.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReference.cs index 9648f5170..a66841f30 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReference.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReference.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CompanyReference { - /// /// Unique identifier for your SMB in Codat. /// @@ -24,7 +23,7 @@ public class CompanyReference public string? Id { get; set; } /// - /// The name of the company + /// The name of the company. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs index 0cc87412c..4c9fff3ce 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyReferenceLinks.cs @@ -11,13 +11,12 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// A collection of links for the company. /// public class CompanyReferenceLinks { - /// /// Link to the company page in the portal. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs index 515c13199..ddbac2973 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyRequestBody.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CompanyRequestBody { - /// /// Name of company being connected. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs index c25f31683..8bfa4dfd1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanySyncStatus.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CompanySyncStatus { - /// /// Unique identifier for your SMB in Codat. /// @@ -52,9 +51,7 @@ public class CompanySyncStatus public string? SyncExceptionMessage { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,7 +70,6 @@ public class CompanySyncStatus /// >
/// > 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. - /// /// [JsonProperty("syncUtc")] public string? SyncUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncFailedWebhookData.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyUpdateRequest.cs similarity index 53% rename from sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncFailedWebhookData.cs rename to sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyUpdateRequest.cs index 59d123465..653137c59 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncFailedWebhookData.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CompanyUpdateRequest.cs @@ -11,26 +11,26 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - - public class SyncFailedWebhookData - { + using System.Collections.Generic; + public class CompanyUpdateRequest + { /// - /// Unique identifier for the failed sync. + /// Name of company being connected. /// - [JsonProperty("syncId")] - public string? SyncId { get; set; } + [JsonProperty("name")] + public string? Name { get; set; } /// - /// The type of sync being performed. + /// Additional information about the company. This can be used to store foreign IDs, references, etc. /// - [JsonProperty("syncType")] - public string? SyncType { get; set; } + [JsonProperty("description")] + public string? Description { get; set; } /// - /// The stage of the job the sync failed. + /// A collection of user-defined key-value pairs that store custom metadata against the company. /// - [JsonProperty("FailureStage")] - public string? FailureStage { get; set; } + [JsonProperty("tags")] + public Dictionary? Tags { get; set; } } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connection.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connection.cs index 665a45545..7dbb2a7f7 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connection.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connection.cs @@ -13,11 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// A connection represents a company's connection to a data source and allows you to synchronize data (pull and/or push) with that source.
- /// - /// + /// A connection represents a company's connection to a data source and allows you to synchronize data (pull and/or push) with that source.
///
/// A 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:
///
@@ -27,13 +25,11 @@ namespace Codat.Sync.Expenses.Models.Components /// Any combination of accounting, banking, and commerce data connections is allowed.
///
/// Before 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. - /// /// public class Connection { - /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("id")] public string Id { get; set; } = default!; @@ -45,7 +41,7 @@ public class Connection public string IntegrationId { get; set; } = default!; /// - /// 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. + /// 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!; @@ -81,9 +77,7 @@ public class Connection public DataConnectionStatus Status { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -102,15 +96,12 @@ public class Connection /// >
/// > 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. - /// /// [JsonProperty("lastSync")] public string? LastSync { get; set; } /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -129,7 +120,6 @@ public class Connection /// >
/// > 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. - /// /// [JsonProperty("created")] public string Created { get; set; } = default!; @@ -138,6 +128,6 @@ public class Connection public List? DataConnectionErrors { get; set; } = null; [JsonProperty("connectionInfo")] - public Dictionary? ConnectionInfo { get; set; } = null; + public Dictionary? ConnectionInfo { get; set; } = null; } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connections.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connections.cs index 0599156e5..ef88f1b74 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connections.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Connections.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Connections { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Contact.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Contact.cs index 342c475c2..a72c81d16 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Contact.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Contact.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Contact { - /// /// Name of a contact for a customer. /// @@ -45,9 +44,7 @@ public class Contact public CustomerStatus Status { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -66,7 +63,6 @@ public class Contact /// >
/// > 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. - /// /// [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs index f47e151b8..4bd51f23f 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponse.cs @@ -12,23 +12,22 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class CreateAccountResponse { - [JsonProperty("data")] public AccountingAccount? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class CreateAccountResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +70,12 @@ public class CreateAccountResponse /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +94,6 @@ public class CreateAccountResponse /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs index e9fa18a27..bf09f8b44 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseMetadata.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CreateAccountResponseMetadata { - /// /// Indicates whether the record has been deleted in the third-party system this record originated from. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs index 8ce69840f..e1bd7d676 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateAccountResponseValidDataTypeLinks.cs @@ -12,11 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// 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.
- /// - /// + /// 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:
///
@@ -31,18 +29,18 @@ namespace Codat.Sync.Expenses.Models.Components ///
/// ```json validDatatypeLinks for an account
/// {
- /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
- /// "nominalCode": "090",
- /// "name": "Business Bank Account",
+ /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ /// "nominalCode": "090",
+ /// "name": "Business Bank Account",
/// #...
- /// "validDatatypeLinks": [
+ /// "validDatatypeLinks": [
/// {
- /// "property": "Id",
- /// "links": [
- /// "Payment.AccountRef.Id",
- /// "BillPayment.AccountRef.Id",
- /// "DirectIncome.LineItems.AccountRef.Id",
- /// "DirectCost.LineItems.AccountRef.Id"
+ /// "property": "Id",
+ /// "links": [
+ /// "Payment.AccountRef.Id",
+ /// "BillPayment.AccountRef.Id",
+ /// "DirectIncome.LineItems.AccountRef.Id",
+ /// "DirectCost.LineItems.AccountRef.Id"
/// ]
/// }
/// ]
@@ -55,12 +53,10 @@ namespace Codat.Sync.Expenses.Models.Components ///
/// 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 <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>. - /// + /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. /// public class CreateAccountResponseValidDataTypeLinks { - /// /// The property from the account that can be linked. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs index 7ec74095d..fcb77566d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponse.cs @@ -12,23 +12,22 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class CreateBankAccountResponse { - [JsonProperty("data")] public AccountingBankAccount? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class CreateBankAccountResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +70,12 @@ public class CreateBankAccountResponse /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +94,6 @@ public class CreateBankAccountResponse /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs index 381b89ae8..e71074ff4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateBankAccountResponseBankAccountType.cs @@ -12,14 +12,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// 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. - /// /// public enum CreateBankAccountResponseBankAccountType { @@ -63,5 +60,4 @@ public static CreateBankAccountResponseBankAccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CreateBankAccountResponseBankAccountType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs index 77b15b252..2e32ed3c4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateCustomerResponse.cs @@ -12,23 +12,22 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class CreateCustomerResponse { - [JsonProperty("data")] public AccountingCustomer? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class CreateCustomerResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +70,12 @@ public class CreateCustomerResponse /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +94,6 @@ public class CreateCustomerResponse /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs index 7a11db38a..1f390403b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateExpenseResponse.cs @@ -11,12 +11,11 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CreateExpenseResponse { - /// - /// Unique id of sync created + /// Unique id of sync created. /// [JsonProperty("syncId")] public string? SyncId { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs index 77f236e47..6c0ca59ae 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateReimbursableExpenseResponse.cs @@ -11,12 +11,11 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CreateReimbursableExpenseResponse { - /// - /// Unique id of sync created + /// Unique id of sync created. /// [JsonProperty("syncId")] public string? SyncId { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs index 1a9e6ccd4..0431dc73c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CreateSupplierResponse.cs @@ -12,23 +12,22 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class CreateSupplierResponse { - [JsonProperty("data")] public AccountingSupplier? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class CreateSupplierResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +70,12 @@ public class CreateSupplierResponse /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +94,6 @@ public class CreateSupplierResponse /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customer.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customer.cs index 5ba155f03..880795fa8 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customer.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customer.cs @@ -13,21 +13,16 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## 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.
///
- /// Customers' data links to accounts receivable invoices.
- /// - /// + /// Customers' data links to accounts receivable invoices. /// public class Customer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -60,15 +55,12 @@ public class Customer /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } @@ -114,11 +106,8 @@ public class Customer /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerDetails.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerDetails.cs index 7c7c64542..8a8485034 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerDetails.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerDetails.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CustomerDetails { - /// /// Identifier for the customer, unique to the company in the accounting software. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerStatus.cs index 61ecb1fa6..f8ed0d8ec 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/CustomerStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Status of customer. /// @@ -58,5 +58,4 @@ public static CustomerStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CustomerStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customers.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customers.cs index 2abb32ccd..f28455543 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customers.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Customers.cs @@ -13,12 +13,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Customers { - [JsonProperty("results")] - public List? Results { get; set; } + public List? Results { get; set; } /// /// Current page number. diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionError.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionError.cs index 0f953b554..eaba6c2e6 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionError.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionError.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class DataConnectionError { - /// /// The HTTP status code returned by the source platform when the error occurred. /// @@ -35,9 +34,7 @@ public class DataConnectionError public string? ErrorMessage { get; set; } /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -56,7 +53,6 @@ public class DataConnectionError /// >
/// > 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. - /// /// [JsonProperty("erroredOnUtc")] public string? ErroredOnUtc { get; set; } @@ -68,9 +64,7 @@ public class DataConnectionError public ErrorStatus? Status { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -89,7 +83,6 @@ public class DataConnectionError /// >
/// > 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. - /// /// [JsonProperty("resolvedOnUtc")] public string? ResolvedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs index 7c5ea15fa..dfea12d78 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataConnectionStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The current authorization status of the data connection. /// @@ -60,5 +60,4 @@ public static DataConnectionStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataConnectionStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataStatus.cs index da16b2d0c..f2f463bcb 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataStatus.cs @@ -12,23 +12,20 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// public class DataStatus { - /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public DataTypes DataType { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -47,10 +44,9 @@ public class DataStatus /// >
/// > 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. - /// /// [JsonProperty("lastSuccessfulSync")] - public string LastSuccessfulSync { get; set; } = default!; + public string? LastSuccessfulSync { get; set; } /// /// The current status of the dataset. diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataType.cs index 41f0f199e..7b487da9a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataType.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// Available data types + /// Available data types. /// public enum DataType { @@ -138,5 +138,4 @@ public static DataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataTypes.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataTypes.cs index 98919ffae..cccfa5873 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataTypes.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DataTypes.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// Available data types + /// Available data types. /// public enum DataTypes { @@ -138,5 +138,4 @@ public static DataTypes ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataTypes"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DatasetStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DatasetStatus.cs index f0ee4f991..d4758ec5a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DatasetStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DatasetStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the dataset. /// @@ -94,5 +94,4 @@ public static DatasetStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DatasetStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs index 1ea5c3868..89cdfa775 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/DefinitionTransaction.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class DefinitionTransaction { - /// /// Unique identifier of the transaction. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorStatus.cs index 41cc48836..7bb3cbcd9 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of a transient error. Null statuses indicate that the error is not transient. /// @@ -56,5 +56,4 @@ public static ErrorStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ErrorStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidation.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidation.cs index af5d39895..6d394dd58 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidation.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidation.cs @@ -13,13 +13,12 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. /// public class ErrorValidation { - [JsonProperty("errors")] public List? Errors { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs index 7378966b6..110cb1a1a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ErrorValidationItem.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ErrorValidationItem { - /// /// Unique identifier for a validation item. /// @@ -22,7 +21,7 @@ public class ErrorValidationItem public string? ItemId { get; set; } = null; /// - /// A message outlining validation item's issue. + /// A message outlining validation item's issue. /// [JsonProperty("message")] public string? Message { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs index 4492914a8..0017e8e9a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRef.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ExpenseContactRef { - /// /// Identifier of supplier or customer. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs index 1e84dffbe..bbb64df9a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseContactRefType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The type of contact. /// @@ -54,5 +54,4 @@ public static ExpenseContactRefType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ExpenseContactRefType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs index 626898b5a..7f2b6a532 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransaction.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ExpenseTransaction { - /// /// Your unique identifier for the transaction. /// @@ -30,9 +29,7 @@ public class ExpenseTransaction public Models.Components.Type Type { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -51,7 +48,6 @@ public class ExpenseTransaction /// >
/// > 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. - /// /// [JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; @@ -64,12 +60,10 @@ public class ExpenseTransaction /// /// 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.
+ /// 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).
///
@@ -97,7 +91,6 @@ public class ExpenseTransaction /// | 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. | - /// /// [JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -115,7 +108,7 @@ public class ExpenseTransaction public string? Reference { get; set; } = null; /// - /// Name of the merchant where the purchase took place + /// Name of the merchant where the purchase took place. /// [JsonProperty("merchantName")] public string? MerchantName { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs index 9e52715b3..567503052 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpenseTransactionLine.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ExpenseTransactionLine { - /// /// Amount of the line, exclusive of tax. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs index f719372aa..ce3683f7d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhook.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ExpensesSyncWebhook { - /// /// Unique identifier of the event. /// @@ -29,9 +28,7 @@ public class ExpensesSyncWebhook public string? EventType { get; set; } /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -50,7 +47,6 @@ public class ExpensesSyncWebhook /// >
/// > 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. - /// /// [JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs index d457109c3..016b7ae53 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ExpensesSyncWebhookPayload.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ExpensesSyncWebhookPayload { - [JsonProperty("referenceCompany")] public CompanyReference? ReferenceCompany { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/From.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/From.cs index 53a486d63..362907e6e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/From.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/From.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class From { - /// /// Reference of the account you are transferring money from. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/HalRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/HalRef.cs index 43406bace..afea9de1c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/HalRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/HalRef.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class HalRef { - /// /// Uri hypertext reference. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/IntegrationType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/IntegrationType.cs index 3eeb8c9f5..47f852b83 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/IntegrationType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/IntegrationType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Type of transaction that has been processed e.g. Expense or Bank Feed. /// @@ -56,5 +56,4 @@ public static IntegrationType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum IntegrationType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceTo.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceTo.cs index 5d6c641ed..c44652bda 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceTo.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceTo.cs @@ -12,13 +12,12 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. /// public class InvoiceTo { - /// /// identifier of customer. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceToType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceToType.cs index e94fdc39e..cdf3eedb2 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceToType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/InvoiceToType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The type of contact. /// @@ -54,5 +54,4 @@ public static InvoiceToType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum InvoiceToType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemRef.cs index 0b525ec4b..c48eb0116 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemRef.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ItemRef { - /// /// Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Items.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Items.cs index 6a93e808f..c54063c64 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Items.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Items.cs @@ -12,12 +12,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class Items { - /// - /// The type of the address + /// The type of the address. /// [JsonProperty("type")] public AccountingAddressType Type { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemsType.cs similarity index 78% rename from sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberType.cs rename to sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemsType.cs index 6cf9ce40c..407ea889c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ItemsType.cs @@ -12,11 +12,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of phone number + /// The type of phone number. /// - public enum PhoneNumberType + public enum ItemsType { [JsonProperty("Primary")] Primary, @@ -30,16 +30,16 @@ public enum PhoneNumberType Unknown, } - public static class PhoneNumberTypeExtension + public static class ItemsTypeExtension { - public static string Value(this PhoneNumberType value) + public static string Value(this ItemsType value) { return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); } - public static PhoneNumberType ToEnum(this string value) + public static ItemsType ToEnum(this string value) { - foreach(var field in typeof(PhoneNumberType).GetFields()) + foreach(var field in typeof(ItemsType).GetFields()) { var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); if (attributes.Length == 0) @@ -52,15 +52,14 @@ public static PhoneNumberType ToEnum(this string value) { var enumVal = field.GetValue(null); - if (enumVal is PhoneNumberType) + if (enumVal is ItemsType) { - return (PhoneNumberType)enumVal; + return (ItemsType)enumVal; } } } - throw new Exception($"Unknown value {value} for enum PhoneNumberType"); + throw new Exception($"Unknown value {value} for enum ItemsType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Links.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Links.cs index 248ba36d3..5657c36c4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Links.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Links.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class Links { - [JsonProperty("self")] public HalRef Self { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/MappingOptions.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/MappingOptions.cs index 156965dcb..285edff9e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/MappingOptions.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/MappingOptions.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class MappingOptions { - /// /// Name of the expense integration. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Metadata.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Metadata.cs index 28ab9be9b..600a18220 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Metadata.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Metadata.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class Metadata { - /// /// Indicates whether the record has been deleted in the third-party system this record originated from. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Phone.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Phone.cs index 3a28be5d8..3c4e88cbb 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Phone.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Phone.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class Phone { - /// /// A phone number. /// @@ -23,9 +22,9 @@ public class Phone public string? Number { get; set; } = null; /// - /// The type of phone number + /// The type of phone number. /// [JsonProperty("type")] - public PhoneNumberType Type { get; set; } = default!; + public CompanyInformationPhoneNumbersType Type { get; set; } = default!; } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs index ba337303f..d666d11d5 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PhoneNumberItems.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class PhoneNumberItems { - /// /// A phone number. /// @@ -23,9 +22,9 @@ public class PhoneNumberItems public string? Number { get; set; } = null; /// - /// The type of phone number + /// The type of phone number. /// [JsonProperty("type")] - public PhoneNumberType Type { get; set; } = default!; + public ItemsType Type { get; set; } = default!; } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PropertieDataType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PropertieDataType.cs index 9c84eacec..fbbc9aaec 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PropertieDataType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PropertieDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// Available data types + /// Available data types. /// public enum PropertieDataType { @@ -138,5 +138,4 @@ public static PropertieDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PropertieDataType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperation.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperation.cs index 937373cdf..0403bbb00 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperation.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperation.cs @@ -12,17 +12,13 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// Information about a queued, in progress or completed pull operation.
- /// - /// /// *Formally called `dataset`* - /// /// public class PullOperation { - /// /// Unique identifier of the pull operation. /// @@ -66,9 +62,7 @@ public class PullOperation public string? ErrorMessage { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -87,15 +81,12 @@ public class PullOperation /// >
/// > 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. - /// /// [JsonProperty("requested")] public string Requested { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -114,7 +105,6 @@ public class PullOperation /// >
/// > 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. - /// /// [JsonProperty("completed")] public string? Completed { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperations.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperations.cs index 81ec3698f..1de7f9999 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperations.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PullOperations.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PullOperations { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushChangeType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushChangeType.cs index 62b4c2038..14756af8a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushChangeType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushChangeType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Type of change being applied to record in third party platform. /// @@ -62,5 +62,4 @@ public static PushChangeType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushChangeType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs index 473a6ebfd..c26c5d60b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushFieldValidation.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class PushFieldValidation { - /// /// Field name that resulted in the validation issue. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperation.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperation.cs index 322c196fe..849daf9f7 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperation.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperation.cs @@ -12,20 +12,19 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class PushOperation { - /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -43,15 +42,13 @@ public class PushOperation public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -70,15 +67,12 @@ public class PushOperation /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -97,7 +91,6 @@ public class PushOperation /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationChange.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationChange.cs index 9d5500c92..b87ec1134 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationChange.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationChange.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class PushOperationChange { - /// /// Type of change being applied to record in third party platform. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationRef.cs index 4780d99f0..3631aebf1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationRef.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class PushOperationRef { - /// /// Unique identifier for a push operation. /// @@ -23,7 +22,7 @@ public class PushOperationRef public string? Id { get; set; } /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs index 25db4c02c..494fca506 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperationStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the push operation. /// @@ -60,5 +60,4 @@ public static PushOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOperationStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperations.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperations.cs index 80c4a0fba..4f783dafc 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperations.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOperations.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushOperations { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOption.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOption.cs index c6668078d..b4f79acb6 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOption.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOption.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushOption { - /// /// The option type. /// @@ -24,7 +23,7 @@ public class PushOption public PushOptionType Type { get; set; } = default!; /// - /// The property's display name. + /// The property's display name. /// [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs index 4e9a28591..076f2d073 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionChoice.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class PushOptionChoice { - /// /// Allowed value for field. /// @@ -29,7 +28,7 @@ public class PushOptionChoice public PushOptionType? Type { get; set; } /// - /// The property's display name. + /// The property's display name. /// [JsonProperty("displayName")] public string? DisplayName { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs index 1293c54c7..ea0f2bf81 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionProperty.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushOptionProperty { - /// /// The option type. /// @@ -24,7 +23,7 @@ public class PushOptionProperty public PushOptionType Type { get; set; } = default!; /// - /// The property's display name. + /// The property's display name. /// [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionType.cs index f3a242529..c514b735d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushOptionType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The option type. /// @@ -68,5 +68,4 @@ public static PushOptionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOptionType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs index 961c7c71d..df84e0c16 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/PushValidationInfo.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushValidationInfo { - [JsonProperty("warnings")] public List? Warnings { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/RecordRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/RecordRef.cs index 5012f7129..e1b8627b6 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/RecordRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/RecordRef.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class RecordRef { - /// /// Identifier of linked reference from mapping options. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs index 865fefdc4..605c14b8c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransaction.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ReimbursableExpenseTransaction { - /// /// Your unique identifier for the transaction. /// @@ -36,9 +35,7 @@ public class ReimbursableExpenseTransaction public ApAccountRef? ApAccountRef { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -57,15 +54,12 @@ public class ReimbursableExpenseTransaction /// >
/// > 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. - /// /// [JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -84,7 +78,6 @@ public class ReimbursableExpenseTransaction /// >
/// > 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. - /// /// [JsonProperty("dueDate")] public string DueDate { get; set; } = default!; @@ -97,12 +90,10 @@ public class ReimbursableExpenseTransaction /// /// 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.
+ /// 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).
///
@@ -130,7 +121,6 @@ public class ReimbursableExpenseTransaction /// | 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. | - /// /// [JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs index 560f7da45..83a95bbbc 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursableExpenseTransactionLine.cs @@ -13,12 +13,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ReimbursableExpenseTransactionLine { - /// - /// line description + /// line description. /// [JsonProperty("description")] public string? Description { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs index 138fa61ef..4b279b8ae 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ReimbursementContactRef.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ReimbursementContactRef { - /// /// Identifier of contact. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Security.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Security.cs index 5c1c6dd22..5c1ed730f 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Security.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Security.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; - + public class Security { - [SpeakeasyMetadata("security:scheme=true,type=apiKey,subType=header,name=Authorization")] public string AuthHeader { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SourceType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SourceType.cs index 39999d5a1..ab251fa0c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SourceType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The type of platform of the connection. /// @@ -66,5 +66,4 @@ public static SourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Status.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Status.cs index dec0b3819..2efc9413e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Status.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Status.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the dataset. /// @@ -94,5 +94,4 @@ public static Status ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Status"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplementalData.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplementalData.cs index 7d95c0015..71ef2e938 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplementalData.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplementalData.cs @@ -12,18 +12,14 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// 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 about supplemental data. - /// /// public class SupplementalData { - [JsonProperty("content")] public Dictionary>? Content { get; set; } = null; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Supplier.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Supplier.cs index c0280b1a1..fe261c24f 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Supplier.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Supplier.cs @@ -13,18 +13,14 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## Overview
- /// - /// ///
- /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. - /// + /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. /// public class Supplier { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -74,7 +70,7 @@ public class Supplier public string? RegistrationNumber { get; set; } = null; /// - /// Supplier's company tax number. + /// Supplier's company tax number. /// [JsonProperty("taxNumber")] public string? TaxNumber { get; set; } = null; @@ -86,7 +82,7 @@ public class Supplier public SupplierStatus Status { get; set; } = default!; /// - /// Default currency the supplier's transactional data is recorded in. + /// Default currency the supplier's transactional data is recorded in. /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } = null; @@ -96,11 +92,8 @@ public class Supplier /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierDetails.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierDetails.cs index 7dc3d29dc..c2298d736 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierDetails.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierDetails.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class SupplierDetails { - /// /// Identifier for the supplier, unique to the company in the accounting software. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierStatus.cs index be8dc84d5..e67af650a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SupplierStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the supplier. /// @@ -58,5 +58,4 @@ public static SupplierStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SupplierStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Suppliers.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Suppliers.cs index 0a1107869..37b494be6 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Suppliers.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Suppliers.cs @@ -13,12 +13,11 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Suppliers { - [JsonProperty("results")] - public List? Results { get; set; } + public List? Results { get; set; } /// /// Current page number. diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncCompleteWebhook.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncCompleteWebhook.cs deleted file mode 100644 index b5ea6ec61..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncCompleteWebhook.cs +++ /dev/null @@ -1,69 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Components -{ - using Codat.Sync.Expenses.Models.Components; - using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - using System; - - /// - /// Webhook request body used to notify that a sync has completed. - /// - public class SyncCompleteWebhook - { - - /// - /// Unique identifier for your client in Codat. - /// - [JsonProperty("ClientId")] - public string? ClientId { get; set; } - - /// - /// Name of your client in Codat. - /// - [JsonProperty("ClientName")] - public string? ClientName { get; set; } - - /// - /// Unique identifier for your SMB in Codat. - /// - [JsonProperty("CompanyId")] - public string? CompanyId { get; set; } - - /// - /// Unique identifier for the rule. - /// - [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] - [JsonProperty("RuleId")] - public string? RuleId { get; set; } - - /// - /// The type of rule. - /// - [JsonProperty("RuleType")] - public string? RuleType { get; set; } - - /// - /// Unique identifier of the webhook event. - /// - [JsonProperty("AlertId")] - public string? AlertId { get; set; } - - /// - /// A human-readable message about the webhook. - /// - [JsonProperty("Message")] - public string? Message { get; set; } - - [JsonProperty("Data")] - public SyncCompleteWebhookData? Data { get; set; } - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncFailedWebhook.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncFailedWebhook.cs deleted file mode 100644 index fefcd5c10..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncFailedWebhook.cs +++ /dev/null @@ -1,69 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Components -{ - using Codat.Sync.Expenses.Models.Components; - using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - using System; - - /// - /// Webhook request body used to notify that a sync has failed. - /// - public class SyncFailedWebhook - { - - /// - /// Unique identifier for your client in Codat. - /// - [JsonProperty("ClientId")] - public string? ClientId { get; set; } - - /// - /// Name of your client in Codat. - /// - [JsonProperty("ClientName")] - public string? ClientName { get; set; } - - /// - /// Unique identifier for your SMB in Codat. - /// - [JsonProperty("CompanyId")] - public string? CompanyId { get; set; } - - /// - /// Unique identifier for the rule. - /// - [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] - [JsonProperty("RuleId")] - public string? RuleId { get; set; } - - /// - /// The type of rule. - /// - [JsonProperty("RuleType")] - public string? RuleType { get; set; } - - /// - /// Unique identifier of the webhook event. - /// - [JsonProperty("AlertId")] - public string? AlertId { get; set; } - - /// - /// A human-readable message about the webhook. - /// - [JsonProperty("Message")] - public string? Message { get; set; } - - [JsonProperty("Data")] - public SyncFailedWebhookData? Data { get; set; } - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs index 3ab6456ce..caf7ece7f 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TaxRateMappingInfo.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class TaxRateMappingInfo { - /// /// Unique identifier of tax rate. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/To.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/To.cs index c8b0f849b..71bfb56b9 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/To.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/To.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class To { - /// /// Reference of the account you are transferring money to. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs index de406a892..1874b70d3 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingCategoryMappingInfo.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class TrackingCategoryMappingInfo { - /// /// Unique identifier of the tracking category. /// @@ -34,7 +33,7 @@ public class TrackingCategoryMappingInfo public bool? HasChildren { get; set; } /// - /// ID of the parent tracking category + /// ID of the parent tracking category. /// [JsonProperty("parentId")] public string? ParentId { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRef.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRef.cs index 1a00f2d50..ae54e55f4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRef.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRef.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class TrackingRef { - /// /// Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. /// @@ -23,7 +22,7 @@ public class TrackingRef public string? Id { get; set; } /// - /// The type of the linked reference + /// The type of the linked reference. /// [JsonProperty("dataType")] public TrackingRefDataType? DataType { get; set; } = Codat.Sync.Expenses.Models.Components.TrackingRefDataType.TrackingCategories; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs index 2cad9294a..f756e4d2b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransaction.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class TrackingRefAdjustmentTransaction { - /// /// Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. /// @@ -23,7 +22,7 @@ public class TrackingRefAdjustmentTransaction public string? Id { get; set; } /// - /// The type of the linked reference + /// The type of the linked reference. /// [JsonProperty("dataType")] public TrackingRefAdjustmentTransactionDataType? DataType { get; set; } = Codat.Sync.Expenses.Models.Components.TrackingRefAdjustmentTransactionDataType.TrackingCategories; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs index 7db09941f..1a5974767 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefAdjustmentTransactionDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of the linked reference + /// The type of the linked reference. /// public enum TrackingRefAdjustmentTransactionDataType { @@ -58,5 +58,4 @@ public static TrackingRefAdjustmentTransactionDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TrackingRefAdjustmentTransactionDataType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs index 81200c422..392faaaad 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TrackingRefDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of the linked reference + /// The type of the linked reference. /// public enum TrackingRefDataType { @@ -56,5 +56,4 @@ public static TrackingRefDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TrackingRefDataType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transaction.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transaction.cs index 1e60a6291..ee698abc4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transaction.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transaction.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class Transaction { - /// /// Your unique idenfier of the transaction. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus.cs index e4d7e7309..a116bcf82 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the transaction. /// @@ -62,5 +62,4 @@ public static TransactionStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TransactionStatus"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs index 25cda3462..c06643035 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransactionStatus1.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// Status of transaction. /// @@ -62,5 +62,4 @@ public static TransactionStatus1 ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TransactionStatus1"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transactions.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transactions.cs index 16debd43e..436eeeb1d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transactions.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Transactions.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Transactions { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs index d9ba9b785..d7ae43649 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class TransferTransactionRequest { - /// /// Any private, company notes about the transaction. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs index 05580551e..6210a5ca0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionRequestAccountReference.cs @@ -11,15 +11,14 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// Reference of the account you are transferring money to. /// public class TransferTransactionRequestAccountReference { - /// - /// 'id' from the Accounts data type. + /// 'id' from the Accounts data type. /// [JsonProperty("id")] public string Id { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs index 9489e10a8..83a8e3ec2 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/TransferTransactionResponse.cs @@ -11,12 +11,11 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class TransferTransactionResponse { - /// - /// Unique id of sync created + /// Unique id of sync created. /// [JsonProperty("syncId")] public string? SyncId { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Type.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Type.cs index aa4a5fae6..f24394c06 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Type.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Type.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The type of transaction. /// @@ -60,5 +60,4 @@ public static Type ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Type"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs index 78f88422b..73c4ac261 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponse.cs @@ -12,23 +12,22 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class UpdateCustomerResponse { - [JsonProperty("data")] public UpdateCustomerResponseAccountingCustomer? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class UpdateCustomerResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +70,12 @@ public class UpdateCustomerResponse /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +94,6 @@ public class UpdateCustomerResponse /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs index 683c673d3..ff13d5caa 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateCustomerResponseAccountingCustomer.cs @@ -12,23 +12,19 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + /// /// ## 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.
///
- /// Customers' data links to accounts receivable invoices.
- /// - /// - /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible.")] + /// Customers' data links to accounts receivable invoices. + /// + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class UpdateCustomerResponseAccountingCustomer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -61,15 +57,12 @@ public class UpdateCustomerResponseAccountingCustomer /// /// The currency data type in Codat is the 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. - /// /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } @@ -115,11 +108,8 @@ public class UpdateCustomerResponseAccountingCustomer /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs index c4e9f03c3..27e35f022 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequest.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class UpdateExpenseRequest { - /// /// The type of transaction. /// @@ -37,12 +36,10 @@ public class UpdateExpenseRequest /// /// 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.
+ /// 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).
///
@@ -70,7 +67,6 @@ public class UpdateExpenseRequest /// | 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. | - /// /// [JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -82,7 +78,7 @@ public class UpdateExpenseRequest public UpdateExpenseRequestBankAccountReference? BankAccountRef { get; set; } /// - /// Name of the merchant where the purchase took place + /// Name of the merchant where the purchase took place. /// [JsonProperty("merchantName")] public string? MerchantName { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs index d5c5bcd0d..9a3ca93e4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestBankAccountReference.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class UpdateExpenseRequestBankAccountReference { - /// /// Identifier of the bank account. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs index 031d85a62..5bc41ad49 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseRequestType.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + /// /// The type of transaction. /// @@ -60,5 +60,4 @@ public static UpdateExpenseRequestType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum UpdateExpenseRequestType"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs index 65d1f73c4..57c77cf0b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateExpenseResponse.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class UpdateExpenseResponse { - /// /// Unique identifier for the update expense sync. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs index 329617de9..4a5da770a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateReimbursableExpenseTransactionRequest.cs @@ -13,10 +13,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class UpdateReimbursableExpenseTransactionRequest { - /// /// User-friendly reference for the reimbursable expense. /// @@ -30,9 +29,7 @@ public class UpdateReimbursableExpenseTransactionRequest public ApAccountRef? ApAccountRef { get; set; } = null; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -51,15 +48,12 @@ public class UpdateReimbursableExpenseTransactionRequest /// >
/// > 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. - /// /// [JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -78,7 +72,6 @@ public class UpdateReimbursableExpenseTransactionRequest /// >
/// > 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. - /// /// [JsonProperty("dueDate")] public string DueDate { get; set; } = default!; @@ -91,12 +84,10 @@ public class UpdateReimbursableExpenseTransactionRequest /// /// 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.
+ /// 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).
///
@@ -124,7 +115,6 @@ public class UpdateReimbursableExpenseTransactionRequest /// | 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. | - /// /// [JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs index 5e7f64e73..f037c430b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponse.cs @@ -12,23 +12,22 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + public class UpdateSupplierResponse { - [JsonProperty("data")] public UpdateSupplierResponseAccountingSupplier? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class UpdateSupplierResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -73,15 +70,12 @@ public class UpdateSupplierResponse /// >
/// > 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. - /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
- /// - /// + /// In 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
@@ -100,7 +94,6 @@ public class UpdateSupplierResponse /// >
/// > 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. - /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs index d3203fb62..17913385a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/UpdateSupplierResponseAccountingSupplier.cs @@ -12,20 +12,17 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - using System.Collections.Generic; using System; - + using System.Collections.Generic; + /// /// ## Overview
- /// - /// ///
- /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. - /// - /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible.")] + /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. + /// + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class UpdateSupplierResponseAccountingSupplier { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -75,7 +72,7 @@ public class UpdateSupplierResponseAccountingSupplier public string? RegistrationNumber { get; set; } = null; /// - /// Supplier's company tax number. + /// Supplier's company tax number. /// [JsonProperty("taxNumber")] public string? TaxNumber { get; set; } = null; @@ -87,7 +84,7 @@ public class UpdateSupplierResponseAccountingSupplier public SupplierStatus Status { get; set; } = default!; /// - /// Default currency the supplier's transactional data is recorded in. + /// Default currency the supplier's transactional data is recorded in. /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } = null; @@ -97,11 +94,8 @@ public class UpdateSupplierResponseAccountingSupplier /// /// 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 about supplemental data. - /// /// [JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs index cd748a688..9b284de75 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidDataTypeLinks.cs @@ -12,11 +12,9 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// 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.
- /// - /// + /// 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:
///
@@ -31,18 +29,18 @@ namespace Codat.Sync.Expenses.Models.Components ///
/// ```json validDatatypeLinks for an account
/// {
- /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
- /// "nominalCode": "090",
- /// "name": "Business Bank Account",
+ /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ /// "nominalCode": "090",
+ /// "name": "Business Bank Account",
/// #...
- /// "validDatatypeLinks": [
+ /// "validDatatypeLinks": [
/// {
- /// "property": "Id",
- /// "links": [
- /// "Payment.AccountRef.Id",
- /// "BillPayment.AccountRef.Id",
- /// "DirectIncome.LineItems.AccountRef.Id",
- /// "DirectCost.LineItems.AccountRef.Id"
+ /// "property": "Id",
+ /// "links": [
+ /// "Payment.AccountRef.Id",
+ /// "BillPayment.AccountRef.Id",
+ /// "DirectIncome.LineItems.AccountRef.Id",
+ /// "DirectCost.LineItems.AccountRef.Id"
/// ]
/// }
/// ]
@@ -55,12 +53,10 @@ namespace Codat.Sync.Expenses.Models.Components ///
/// 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 <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>. - /// + /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. /// public class ValidDataTypeLinks { - /// /// The property from the account that can be linked. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidFor.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidFor.cs index 5969c58f0..47fdeb531 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidFor.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidFor.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + public enum ValidFor { [JsonProperty("expense-transactions.Payment")] @@ -63,5 +63,4 @@ public static ValidFor ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ValidFor"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs index d5380c696..32935a881 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidTransactionTypes.cs @@ -12,7 +12,7 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - + public enum ValidTransactionTypes { [JsonProperty("Payment")] @@ -57,5 +57,4 @@ public static ValidTransactionTypes ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ValidTransactionTypes"); } } - } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Validation.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Validation.cs index 7461d2435..478abb4fe 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Validation.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Validation.cs @@ -13,13 +13,12 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// public class Validation { - [JsonProperty("errors")] public List? Errors { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidationItem.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidationItem.cs index 8ec687af5..9e38fde87 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidationItem.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/ValidationItem.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Components { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class ValidationItem { - /// /// Unique identifier for a validation item. /// @@ -22,7 +21,7 @@ public class ValidationItem public string? ItemId { get; set; } = null; /// - /// A message outlining validation item's issue. + /// A message outlining validation item's issue. /// [JsonProperty("message")] public string? Message { get; set; } = null; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Weblink.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Weblink.cs index fa5c9c733..4ee28335c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Weblink.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Components/Weblink.cs @@ -12,13 +12,12 @@ namespace Codat.Sync.Expenses.Models.Components using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// /// Weblink associated with the company. /// public class Weblink { - /// /// The type of the weblink. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs new file mode 100644 index 000000000..39f6b2d9c --- /dev/null +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs @@ -0,0 +1,83 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#nullable enable +namespace Codat.Sync.Expenses.Models.Errors +{ + using System; + using System.Net.Http; + using System.Net.Http.Headers; + + /// + /// Base Exception for API Errors. + /// + public class CodatSyncExpensesException : Exception + { + /// + /// Error Message + /// + public override string Message { get; } + + /// + /// HTTP status code + /// + public int StatusCode { get; } + + /// + /// HTTP headers + /// + public HttpResponseHeaders Headers { get; } + + /// + /// HTTP content type + /// + public string? ContentType { get; } + + /// + /// Raw response + /// + public HttpResponseMessage RawResponse { get; } + + /// + /// HTTP response body + /// + public string Body { get; } + + public CodatSyncExpensesException( + string message, + HttpResponseMessage rawResponse, + string body + ) : this(message, rawResponse, body, null) {} + + public CodatSyncExpensesException( + string message, + HttpResponseMessage rawResponse, + string body, + Exception? innerException + ) : base(message, innerException) + { + Message = message; + RawResponse = rawResponse; + StatusCode = (int)rawResponse.StatusCode; + Headers = rawResponse.Headers; + ContentType = rawResponse.Content.Headers.ContentType?.MediaType; + Body = body; + } + + /// + /// Detailed Error Message + /// + public override string ToString() + { + var innerMessage = string.IsNullOrEmpty(InnerException?.Message) ? "" : $"\n{InnerException.Message}"; + return $"Status: {StatusCode}. {Message}{innerMessage}"; + } + + } +} diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs index 38e8fd376..6b76eb4b3 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs @@ -13,13 +13,10 @@ namespace Codat.Sync.Expenses.Models.Errors using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; using System; - - /// - /// Your `query` parameter was not correctly formed - /// - public class ErrorMessage : Exception - { + using System.Net.Http; + public class ErrorMessagePayload + { /// /// The HTTP status code returned by the error. /// @@ -27,7 +24,7 @@ public class ErrorMessage : Exception public long? StatusCode { get; set; } /// - /// Codat's service the returned the error. + /// Codat's service the returned the error. /// [JsonProperty("service")] public string? Service { get; set; } @@ -62,4 +59,51 @@ public class ErrorMessage : Exception [JsonProperty("detailedErrorCode")] public long? DetailedErrorCode { get; set; } } + + /// + /// Your `query` parameter was not correctly formed. + /// + public class ErrorMessage : CodatSyncExpensesException + { + /// + /// The original data that was passed to this exception. + /// + public ErrorMessagePayload Payload { get; } + + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible. Use ErrorMessage.Payload.Service instead.")] + public string? Service { get; set; } + + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible. Use ErrorMessage.Payload.Error instead.")] + public string? Error { get; set; } + + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible. Use ErrorMessage.Payload.CorrelationId instead.")] + public string? CorrelationId { get; set; } + + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible. Use ErrorMessage.Payload.Validation instead.")] + public ErrorValidation? Validation { get; set; } + + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible. Use ErrorMessage.Payload.CanBeRetried instead.")] + public string? CanBeRetried { get; set; } + + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible. Use ErrorMessage.Payload.DetailedErrorCode instead.")] + public long? DetailedErrorCode { get; set; } + + public ErrorMessage( + ErrorMessagePayload payload, + HttpResponseMessage rawResponse, + string body + ): base("API error occurred", rawResponse, body) + { + Payload = payload; + + #pragma warning disable CS0618 + Service = payload.Service; + Error = payload.Error; + CorrelationId = payload.CorrelationId; + Validation = payload.Validation; + CanBeRetried = payload.CanBeRetried; + DetailedErrorCode = payload.DetailedErrorCode; + #pragma warning restore CS0618 + } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ResponseValidationException.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ResponseValidationException.cs new file mode 100644 index 000000000..7dcddadb2 --- /dev/null +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/ResponseValidationException.cs @@ -0,0 +1,29 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#nullable enable +namespace Codat.Sync.Expenses.Models.Errors +{ + using System; + using System.Net.Http; + + /// + /// Raised if the response data could not be deserialized into the expected model. + /// + public class ResponseValidationException : CodatSyncExpensesException + { + + public ResponseValidationException( + string message, + HttpResponseMessage rawResponse, + string body, + Exception innerException + ): base(message, rawResponse, body, innerException) {} + } +} diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/SDKException.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/SDKException.cs index 3b4c79170..f0c3b0625 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/SDKException.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Errors/SDKException.cs @@ -6,36 +6,25 @@ // the code is regenerated. // //------------------------------------------------------------------------------ + #nullable enable namespace Codat.Sync.Expenses.Models.Errors { using System; using System.Net.Http; - public class SDKException : Exception + /// + /// Default API Exception. + /// + public class SDKException : CodatSyncExpensesException { - - public override string Message { get; } - public int StatusCode { get; set; } - public string Body { get; set; } - public HttpResponseMessage RawResponse { get; set; } = default!; - public SDKException(string message, int statusCode, string body, HttpResponseMessage rawResponse) - { - Message = message; - this.StatusCode = statusCode; - StatusCode = statusCode; - Body = body; - RawResponse = rawResponse; - } - - public override string ToString(){ - var body = ""; - if (Body.Length > 0) - { - body += $"\n{Body}"; - } - return Message + ": Status " + StatusCode + body; - } - + /// + /// Default API exception. + /// + public SDKException( + string message, + HttpResponseMessage rawResponse, + string body + ): base(message, rawResponse, body) {} } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs index 0468b102f..e6048b1ca 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class CreateAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs index dca01b335..1b118a85a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAccountResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.CreateAccountResponse? CreateAccountResponseValue { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs index 6995be316..cd13d7627 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Requests using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using System.Collections.Generic; - + public class CreateAdjustmentTransactionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs index 2d732426b..d7bff87bc 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateAdjustmentTransactionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateAdjustmentTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public AdjustmentTransactionResponse? AdjustmentTransactionResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs index 614351a51..43c349090 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class CreateBankAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs index f043d7bb5..fe8317d53 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateBankAccountResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateBankAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.CreateBankAccountResponse? CreateBankAccountResponseValue { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs index d14ba9d03..f7805dbc0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCompanyResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs index 3e93c1b5a..56a4843ba 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Utils; - + public class CreateConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs index b207ceda4..d952ccde9 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionRequestBody.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class CreateConnectionRequestBody { - /// /// A unique 4-letter key to represent a platform in each integration. View accounting, banking, and commerce platform keys. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs index a7e9e08f7..1c18be38b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateConnectionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Connection? Connection { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs index f92d13707..f21ac7390 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class CreateCustomerRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs index a2ae064cc..f2c653745 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateCustomerResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateCustomerResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.CreateCustomerResponse? CreateCustomerResponseValue { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs index ec02e15a6..06bd61338 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Requests using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using System.Collections.Generic; - + public class CreateExpenseTransactionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs index a2d017f51..d554d1529 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateExpenseTransactionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateExpenseTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CreateExpenseResponse? CreateExpenseResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs index 6fb60566a..d3a4b370c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class CreatePartnerExpenseConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs index 8817c48c4..0b63b658e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreatePartnerExpenseConnectionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreatePartnerExpenseConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Connection? Connection { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs index 6e1129d33..ee3cb900d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Requests using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using System.Collections.Generic; - + public class CreateReimbursableExpenseTransactionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs index 017c8cb78..69adc6087 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateReimbursableExpenseTransactionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateReimbursableExpenseTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CreateReimbursableExpenseResponse? CreateReimbursableExpenseResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs index 363aa6d33..b464320be 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class CreateSupplierRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs index 7c5f6fc6b..a86eba036 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateSupplierResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateSupplierResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.CreateSupplierResponse? CreateSupplierResponseValue { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs index 0fb1f2836..d6e8dad7c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class CreateTransferTransactionRequest { - /// /// Unique identifier for a company. /// @@ -22,7 +21,7 @@ public class CreateTransferTransactionRequest public string CompanyId { get; set; } = default!; /// - /// The unique identifier for your SMB's transaction. + /// The unique identifier for your SMB's transaction. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionId")] public string TransactionId { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs index d71d6fa2d..0faace09e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/CreateTransferTransactionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class CreateTransferTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public TransferTransactionResponse? TransferTransactionResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs index a7ad03916..d470737ad 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class DeleteCompanyRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs index 1dceb9d6d..f24f92b4e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteCompanyResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class DeleteCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs index 6068ce000..cdb415390 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class DeleteConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs index ecfd509a9..8eb69433f 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/DeleteConnectionResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class DeleteConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs index 2768a708b..ed966e159 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetCompanyConfigurationRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs index 09e5ba5d6..f870d2b8d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyConfigurationResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetCompanyConfigurationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CompanyConfiguration? CompanyConfiguration { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs index 683d53835..9cb6881fb 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetCompanyInfoRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs index f4f4acee9..ea32319f0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyInfoResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetCompanyInfoResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CompanyInformation? CompanyInformation { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs index 71954d8fc..80e98b3b1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetCompanyRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs index c15e87252..aa4581bac 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCompanyResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs index b82d6c788..740429a06 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs index d7c504b43..d9c86c01b 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetConnectionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Connection? Connection { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs index cc3618c0a..1eb585186 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetCreateBankAccountsModelRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs index 0997bd0a4..bc1929ab3 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateBankAccountsModelResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetCreateBankAccountsModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs index 3744be8bc..eb67dfbbe 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetCreateChartOfAccountsModelRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs index d4d6d9adc..a2fc7e586 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCreateChartOfAccountsModelResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetCreateChartOfAccountsModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs index 45aa94d14..9c57f8f72 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetCustomerRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs index d2c6477df..4a111de1e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetCustomerResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetCustomerResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Customer? Customer { get; set; } = null; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs index 71a1428cf..e2af04044 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusDataStatuses.cs @@ -12,267 +12,266 @@ namespace Codat.Sync.Expenses.Models.Requests using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + /// - /// OK + /// OK. /// public class GetDataStatusDataStatuses { - /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("accountTransactions")] public DataStatus? AccountTransactions { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("balanceSheet")] public DataStatus? BalanceSheet { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("bankAccounts")] public DataStatus? BankAccounts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("bankTransactions")] public DataStatus? BankTransactions { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("billCreditNotes")] public DataStatus? BillCreditNotes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("billPayments")] public DataStatus? BillPayments { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("bills")] public DataStatus? Bills { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("cashFlowStatement")] public DataStatus? CashFlowStatement { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("chartOfAccounts")] public DataStatus? ChartOfAccounts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("company")] public DataStatus? Company { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("creditNotes")] public DataStatus? CreditNotes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("customers")] public DataStatus? Customers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("directCosts")] public DataStatus? DirectCosts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("directIncomes")] public DataStatus? DirectIncomes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("invoices")] public DataStatus? Invoices { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("itemReceipts")] public DataStatus? ItemReceipts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("items")] public DataStatus? Items { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("journalEntries")] public DataStatus? JournalEntries { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("journals")] public DataStatus? Journals { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("paymentMethods")] public DataStatus? PaymentMethods { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("payments")] public DataStatus? Payments { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("profitAndLoss")] public DataStatus? ProfitAndLoss { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("purchaseOrders")] public DataStatus? PurchaseOrders { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("salesOrders")] public DataStatus? SalesOrders { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("suppliers")] public DataStatus? Suppliers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("taxRates")] public DataStatus? TaxRates { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("trackingCategories")] public DataStatus? TrackingCategories { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("transfers")] public DataStatus? Transfers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-accountBalances")] public DataStatus? BankingAccountBalances { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-accounts")] public DataStatus? BankingAccounts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-transactionCategories")] public DataStatus? BankingTransactionCategories { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-transactions")] public DataStatus? BankingTransactions { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-companyInfo")] public DataStatus? CommerceCompanyInfo { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-customers")] public DataStatus? CommerceCustomers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-disputes")] public DataStatus? CommerceDisputes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-locations")] public DataStatus? CommerceLocations { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-orders")] public DataStatus? CommerceOrders { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-paymentMethods")] public DataStatus? CommercePaymentMethods { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-payments")] public DataStatus? CommercePayments { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-productCategories")] public DataStatus? CommerceProductCategories { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-products")] public DataStatus? CommerceProducts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-taxComponents")] public DataStatus? CommerceTaxComponents { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-transactions")] public DataStatus? CommerceTransactions { get; set; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs index cdbabf2ff..6cdfb43d5 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetDataStatusRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs index 0c0a5a8df..675b8c0aa 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetDataStatusResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetDataStatusResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public GetDataStatusDataStatuses? DataStatuses { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs index a5e75d4fa..ab6842ef7 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetLastSuccessfulSyncRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs index 15e07c6d4..ce3d08716 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLastSuccessfulSyncResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetLastSuccessfulSyncResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CompanySyncStatus? CompanySyncStatus { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs index 60fea2b66..51b74642f 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetLatestSyncRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs index 8e0909bb7..c6b876233 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetLatestSyncResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetLatestSyncResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CompanySyncStatus? CompanySyncStatus { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs index fbc136dc8..fe22488aa 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetMappingOptionsRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs index 5c8a28e69..0889cdf64 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetMappingOptionsResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetMappingOptionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.MappingOptions? MappingOptions { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs index d3beb7e70..8407922e1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetPullOperationRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs index a7652402c..19c76a06c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPullOperationResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetPullOperationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PullOperation? PullOperation { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs index 1531d3971..de0226cb2 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetPushOperationRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs index 38f0776e5..feda73742 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetPushOperationResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetPushOperationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOperation? PushOperation { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs index d3eb5e5ec..eb6b04bfc 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetSupplierRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs index 55d299da2..caff39aeb 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSupplierResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetSupplierResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Supplier? Supplier { get; set; } = null; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs index cb3fabfd1..fd4cf2340 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetSyncByIdRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs index 2c1045395..0d7f71407 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncByIdResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class GetSyncByIdResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CompanySyncStatus? CompanySyncStatus { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs index 78f3bd9e0..424e6e90c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class GetSyncTransactionRequest { - /// /// Unique identifier for a company. /// @@ -27,7 +26,7 @@ public class GetSyncTransactionRequest public string SyncId { get; set; } = default!; /// - /// The unique identifier for your SMB's transaction. + /// The unique identifier for your SMB's transaction. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionId")] public string TransactionId { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs index 7e26172c1..51e9152c6 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/GetSyncTransactionResponse.cs @@ -11,30 +11,29 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; + using System; using System.Collections.Generic; using System.Net.Http; - using System; - + public class GetSyncTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public List? TransactionResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs index 7b3e667f0..1672f1622 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListCompaniesRequest { - /// /// Page number. Read more. /// @@ -37,5 +36,11 @@ public class ListCompaniesRequest /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } + + /// + /// Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with Codat’s query language. + /// + [SpeakeasyMetadata("queryParam:style=form,explode=true,name=tags")] + public string? Tags { get; set; } } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs index a1fe96fce..f3be8b508 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCompaniesResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListCompaniesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Models.Components.Companies? Companies { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs index 277c81056..af8f836f4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListConnectionsRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs index 7e5e2e139..d3bef1d37 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListConnectionsResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListConnectionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Models.Components.Connections? Connections { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs index b83cc639b..207ee7ccd 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListCustomersRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs index 4621605f6..903f7296c 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListCustomersResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListCustomersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.Customers? Customers { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs index 56c6e07cd..570ba3d50 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListPullOperationsRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs index 4cb3505fc..a332ec728 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPullOperationsResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListPullOperationsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PullOperations? PullOperations { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs index 8ac364c14..60533d123 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListPushOperationsRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs index f9e72e65d..cb4a42f99 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListPushOperationsResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListPushOperationsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Models.Components.PushOperations? PushOperations { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs index 5e8c83a57..2a6555beb 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListSuppliersRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs index f72f1269b..0d037cb46 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSuppliersResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListSuppliersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.Suppliers? Suppliers { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs index 44566a1ee..7acdb8fb4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListSyncTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs index 3ad2b21b7..19e60dc0d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncTransactionsResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ListSyncTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Transactions? Transactions { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs index 3cb96f227..251d7dd4e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class ListSyncsRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs index 5d138ab93..8ae5513b0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ListSyncsResponse.cs @@ -11,30 +11,29 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; + using System; using System.Collections.Generic; using System.Net.Http; - using System; - + public class ListSyncsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public List? CompanySyncStatuses { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs index 2f21c9f6f..9ee13ea12 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - + public class RefreshAllDataTypesRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs index e4d60560e..ee44c77d4 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshAllDataTypesResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class RefreshAllDataTypesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs index ba29c9bfa..88ccea074 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class RefreshDataTypeRequest { - /// /// Unique identifier for a company. /// @@ -22,7 +21,7 @@ public class RefreshDataTypeRequest public string CompanyId { get; set; } = default!; /// - /// The key of a Codat data type + /// The key of a Codat data type. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public DataType DataType { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs index 720353d71..791d338c1 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/RefreshDataTypeResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class RefreshDataTypeResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PullOperation? PullOperation { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncCompleteWebhookData.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ReplaceCompanyRequest.cs similarity index 52% rename from sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncCompleteWebhookData.cs rename to sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ReplaceCompanyRequest.cs index f2a790645..4edf39400 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Components/SyncCompleteWebhookData.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ReplaceCompanyRequest.cs @@ -7,24 +7,20 @@ // //------------------------------------------------------------------------------ #nullable enable -namespace Codat.Sync.Expenses.Models.Components +namespace Codat.Sync.Expenses.Models.Requests { + using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using Newtonsoft.Json; - - public class SyncCompleteWebhookData - { + public class ReplaceCompanyRequest + { /// - /// Unique identifier for the failed sync. + /// Unique identifier for a company. /// - [JsonProperty("syncId")] - public string? SyncId { get; set; } + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] + public string CompanyId { get; set; } = default!; - /// - /// The type of sync being performed. - /// - [JsonProperty("syncType")] - public string? SyncType { get; set; } + [SpeakeasyMetadata("request:mediaType=application/json")] + public CompanyRequestBody? CompanyRequestBody { get; set; } } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse1.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ReplaceCompanyResponse.cs similarity index 70% rename from sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse1.cs rename to sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ReplaceCompanyResponse.cs index 2269f8eaa..3b78df3f0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse1.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/ReplaceCompanyResponse.cs @@ -7,28 +7,33 @@ // //------------------------------------------------------------------------------ #nullable enable -namespace Codat.Sync.Expenses.Models.Webhooks +namespace Codat.Sync.Expenses.Models.Requests { + using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - - public class ClientRateLimitReachedResponse1 - { + using System.Net.Http; + public class ReplaceCompanyResponse + { /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; + + /// + /// OK. + /// + public Company? Company { get; set; } } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs index ea0fe3b72..3f78a7426 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class SetCompanyConfigurationRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs index 9c1a5f74a..ac9dcd389 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/SetCompanyConfigurationResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class SetCompanyConfigurationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CompanyConfiguration? CompanyConfiguration { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs index c651744bb..900ff5b66 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Utils; - + public class UnlinkConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs index 642006dc3..651a10f47 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UnlinkConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Connection? Connection { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs index 645a4d7fd..b7288b35a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UnlinkConnectionUpdateConnection.cs @@ -12,10 +12,9 @@ namespace Codat.Sync.Expenses.Models.Requests using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; using Newtonsoft.Json; - + public class UnlinkConnectionUpdateConnection { - /// /// The current authorization status of the data connection. /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs index 8a7e36061..30846f0f0 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class UpdateCompanyRequest { - /// /// Unique identifier for a company. /// @@ -22,6 +21,6 @@ public class UpdateCompanyRequest public string CompanyId { get; set; } = default!; [SpeakeasyMetadata("request:mediaType=application/json")] - public CompanyRequestBody? CompanyRequestBody { get; set; } + public CompanyUpdateRequest? CompanyUpdateRequest { get; set; } } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs index a5e6b9422..dffb32efe 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCompanyResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UpdateCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs index 9f19067c0..89e9003b2 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class UpdateCustomerRequest { - /// /// Unique identifier for a company. /// @@ -46,7 +45,7 @@ public class UpdateCustomerRequest public bool? AllowSyncOnPushComplete { get; set; } = true; /// - /// 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. + /// 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. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=forceUpdate")] public bool? ForceUpdate { get; set; } = false; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs index 15b52e4ba..c058e334e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateCustomerResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UpdateCustomerResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.UpdateCustomerResponse? UpdateCustomerResponseValue { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs index e88a2f784..bf5fb197a 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class UpdateExpenseTransactionRequest { - /// /// Unique identifier for a company. /// @@ -22,7 +21,7 @@ public class UpdateExpenseTransactionRequest public string CompanyId { get; set; } = default!; /// - /// The unique identifier for your SMB's transaction. + /// The unique identifier for your SMB's transaction. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionId")] public string TransactionId { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs index 375476b9e..ae2fa704e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateExpenseTransactionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UpdateExpenseTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Accepted + /// Accepted. /// public UpdateExpenseResponse? UpdateExpenseResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs index 473d956b5..6304fa5d7 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class UpdateReimbursableExpenseTransactionRequest { - /// /// Unique identifier for a company. /// @@ -22,7 +21,7 @@ public class UpdateReimbursableExpenseTransactionRequest public string CompanyId { get; set; } = default!; /// - /// The unique identifier for your SMB's transaction. + /// The unique identifier for your SMB's transaction. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionId")] public string TransactionId { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs index e2c726f06..b5033dada 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateReimbursableExpenseTransactionResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UpdateReimbursableExpenseTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CreateReimbursableExpenseResponse? CreateReimbursableExpenseResponse { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs index 636ba7250..89391a742 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class UpdateSupplierRequest { - /// /// Unique identifier for a company. /// @@ -46,7 +45,7 @@ public class UpdateSupplierRequest public bool? AllowSyncOnPushComplete { get; set; } = true; /// - /// 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. + /// 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. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=forceUpdate")] public bool? ForceUpdate { get; set; } = false; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs index 58663956b..8869a5948 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UpdateSupplierResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UpdateSupplierResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.UpdateSupplierResponse? UpdateSupplierResponseValue { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs index a26db9feb..15948d959 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - + public class UploadExpenseAttachmentRequest { - /// /// Unique identifier for a company. /// @@ -28,7 +27,7 @@ public class UploadExpenseAttachmentRequest public string SyncId { get; set; } = default!; /// - /// The unique identifier for your SMB's transaction. + /// The unique identifier for your SMB's transaction. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionId")] public string TransactionId { get; set; } = default!; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs index ac798a2e7..d042f8c65 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Requests/UploadExpenseAttachmentResponse.cs @@ -11,29 +11,28 @@ namespace Codat.Sync.Expenses.Models.Requests { using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class UploadExpenseAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Attachment? Attachment { get; set; } } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs index 86ba8aaa5..929bf7442 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitReachedResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Webhooks { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ClientRateLimitReachedResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs index cc6b25e60..20f77c454 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Webhooks { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ClientRateLimitResetResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse1.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse1.cs deleted file mode 100644 index adc35e78c..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ClientRateLimitResetResponse1.cs +++ /dev/null @@ -1,34 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Webhooks -{ - using Codat.Sync.Expenses.Utils; - using System.Net.Http; - using System; - - public class ClientRateLimitResetResponse1 - { - - /// - /// HTTP response content type for this operation - /// - public string? ContentType { get; set; } = default!; - - /// - /// HTTP response status code for this operation - /// - public int StatusCode { get; set; } = default!; - - /// - /// Raw HTTP response; suitable for custom response parsing - /// - public HttpResponseMessage RawResponse { get; set; } = default!; - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs index 21c207ea0..61391e6db 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncSuccessfulResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Webhooks { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ExpensesSyncSuccessfulResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs index 01247cd56..613238ec5 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/ExpensesSyncUnsuccessfulResponse.cs @@ -10,24 +10,23 @@ namespace Codat.Sync.Expenses.Models.Webhooks { using Codat.Sync.Expenses.Utils; - using System.Net.Http; using System; - + using System.Net.Http; + public class ExpensesSyncUnsuccessfulResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/SyncCompletedResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/SyncCompletedResponse.cs deleted file mode 100644 index e63c37513..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/SyncCompletedResponse.cs +++ /dev/null @@ -1,34 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Webhooks -{ - using Codat.Sync.Expenses.Utils; - using System.Net.Http; - using System; - - public class SyncCompletedResponse - { - - /// - /// HTTP response content type for this operation - /// - public string? ContentType { get; set; } = default!; - - /// - /// HTTP response status code for this operation - /// - public int StatusCode { get; set; } = default!; - - /// - /// Raw HTTP response; suitable for custom response parsing - /// - public HttpResponseMessage RawResponse { get; set; } = default!; - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/SyncFailedResponse.cs b/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/SyncFailedResponse.cs deleted file mode 100644 index 74262a284..000000000 --- a/sync-for-expenses/Codat/Sync/Expenses/Models/Webhooks/SyncFailedResponse.cs +++ /dev/null @@ -1,34 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Codat.Sync.Expenses.Models.Webhooks -{ - using Codat.Sync.Expenses.Utils; - using System.Net.Http; - using System; - - public class SyncFailedResponse - { - - /// - /// HTTP response content type for this operation - /// - public string? ContentType { get; set; } = default!; - - /// - /// HTTP response status code for this operation - /// - public int StatusCode { get; set; } = default!; - - /// - /// Raw HTTP response; suitable for custom response parsing - /// - public HttpResponseMessage RawResponse { get; set; } = default!; - } -} \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/PushOperations.cs b/sync-for-expenses/Codat/Sync/Expenses/PushOperations.cs index 1d2ba3300..7609667d3 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/PushOperations.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/PushOperations.cs @@ -13,38 +13,54 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// View historic push operations. /// public interface IPushOperations { - /// - /// List push operations - /// + /// List push operations. + /// /// /// List push operation records. /// - /// - Task ListAsync(ListPushOperationsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListPushOperationsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get push operation - /// + /// Get push operation. + /// /// /// Retrieve push operation. /// - /// - Task GetAsync(GetPushOperationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetPushOperationRequest request, RetryConfig? retryConfig = null); } /// @@ -52,38 +68,55 @@ public interface IPushOperations /// public class PushOperations: IPushOperations { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public PushOperations(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public PushOperations(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task ListAsync(ListPushOperationsRequest request, RetryConfig? retryConfig = null) + /// + /// List push operations. + /// + /// + /// List push operation records. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListPushOperationsRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/push", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/push", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("list-push-operations", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-push-operations", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -117,8 +150,8 @@ public async Task ListAsync(ListPushOperationsReques Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -128,7 +161,7 @@ public async Task ListAsync(ListPushOperationsReques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -137,9 +170,9 @@ public async Task ListAsync(ListPushOperationsReques } } } - 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; @@ -158,7 +191,17 @@ public async Task ListAsync(ListPushOperationsReques { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.PushOperations obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.PushOperations.", httpResponse, httpResponseBody, ex); + } + var response = new ListPushOperationsResponse() { StatusCode = responseStatusCode, @@ -169,40 +212,99 @@ public async Task ListAsync(ListPushOperationsReques return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetPushOperationRequest request, RetryConfig? retryConfig = null) + + /// + /// Get push operation. + /// + /// + /// Retrieve push operation. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetPushOperationRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/push/{pushOperationKey}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/push/{pushOperationKey}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("get-push-operation", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-push-operation", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -236,8 +338,8 @@ public async Task GetAsync(GetPushOperationRequest req Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -247,7 +349,7 @@ public async Task GetAsync(GetPushOperationRequest req httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -256,9 +358,9 @@ public async Task GetAsync(GetPushOperationRequest req } } } - 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; @@ -277,7 +379,17 @@ public async Task GetAsync(GetPushOperationRequest req { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + PushOperation obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into PushOperation.", httpResponse, httpResponseBody, ex); + } + var response = new GetPushOperationResponse() { StatusCode = responseStatusCode, @@ -288,24 +400,59 @@ public async Task GetAsync(GetPushOperationRequest req return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Reimbursements.cs b/sync-for-expenses/Codat/Sync/Expenses/Reimbursements.cs index 899d80b62..255d2a245 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Reimbursements.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Reimbursements.cs @@ -13,26 +13,25 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// - /// Create and update transactions that represent your customers' repayable spend. + /// Create and update transactions that represent your customers' repayable spend. /// public interface IReimbursements { - /// - /// Create reimbursable expense transaction - /// + /// Create reimbursable expense transaction. + /// /// - /// Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.
+ /// Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.
///
/// Reimbursable expense requests are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).
///
@@ -42,16 +41,28 @@ public interface IReimbursements /// | FreeAgent | Yes |
/// | QuickBooks Desktop | Yes |
/// | QuickBooks Online | Yes |
- /// | Oracle NetSuite | Yes | + /// | Oracle NetSuite | Yes |
+ /// | Zoho Books | Yes |
+ /// | Sage Intacct | Yes | /// - /// - Task CreateAsync(CreateReimbursableExpenseTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateReimbursableExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Update reimbursable expense transaction - /// + /// Update reimbursable expense transaction. + /// /// - /// The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection.
+ /// The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection.
///
/// Updating an existing reimbursable expense transaction will update the existing **bill** against an employee (who exists as a supplier in the accounting software).
///
@@ -60,42 +71,83 @@ public interface IReimbursements /// |-----------------------|-----------|
/// | FreeAgent | Yes |
/// | QuickBooks Online | Yes |
- /// | Oracle NetSuite | Yes | + /// | Oracle NetSuite | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Zoho Books | Yes | /// - /// - Task UpdateAsync(Models.Requests.UpdateReimbursableExpenseTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UpdateAsync( + Models.Requests.UpdateReimbursableExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ); } /// - /// Create and update transactions that represent your customers' repayable spend. + /// Create and update transactions that represent your customers' repayable spend. /// public class Reimbursements: IReimbursements { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Reimbursements(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Reimbursements(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task CreateAsync(CreateReimbursableExpenseTransactionRequest request, RetryConfig? retryConfig = null) + /// + /// Create reimbursable expense transaction. + /// + /// + /// Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.
+ ///
+ /// Reimbursable expense requests are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).
+ ///
+ /// ### Supported Integrations
+ /// | Integration | Supported |
+ /// |-----------------------|-----------|
+ /// | FreeAgent | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | Zoho Books | Yes |
+ /// | Sage Intacct | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateReimbursableExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/reimbursable-expense-transactions", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/reimbursable-expense-transactions", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + 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) @@ -103,12 +155,12 @@ public async Task CreateAsync(Crea httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-reimbursable-expense-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-reimbursable-expense-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -142,8 +194,8 @@ public async Task CreateAsync(Crea Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -153,7 +205,7 @@ public async Task CreateAsync(Crea httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -162,9 +214,9 @@ public async Task CreateAsync(Crea } } } - 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; @@ -183,7 +235,17 @@ public async Task CreateAsync(Crea { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CreateReimbursableExpenseResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CreateReimbursableExpenseResponse.", httpResponse, httpResponseBody, ex); + } + var response = new CreateReimbursableExpenseTransactionResponse() { StatusCode = responseStatusCode, @@ -194,33 +256,103 @@ public async Task CreateAsync(Crea return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UpdateAsync(Models.Requests.UpdateReimbursableExpenseTransactionRequest request, RetryConfig? retryConfig = null) + + /// + /// Update reimbursable expense transaction. + /// + /// + /// The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection.
+ ///
+ /// Updating an existing reimbursable expense transaction will update the existing **bill** against an employee (who exists as a supplier in the accounting software).
+ ///
+ /// ### Supported Integrations
+ /// | Integration | Supported |
+ /// |-----------------------|-----------|
+ /// | FreeAgent | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Zoho Books | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UpdateAsync( + Models.Requests.UpdateReimbursableExpenseTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/reimbursable-expense-transactions/{transactionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/reimbursable-expense-transactions/{transactionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "UpdateReimbursableExpenseTransactionRequestValue", "json", false, true); if (serializedBody != null) @@ -228,12 +360,12 @@ public async Task UpdateAsync(Mode httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("update-reimbursable-expense-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "update-reimbursable-expense-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -267,8 +399,8 @@ public async Task UpdateAsync(Mode Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -278,7 +410,7 @@ public async Task UpdateAsync(Mode httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -287,9 +419,9 @@ public async Task UpdateAsync(Mode } } } - 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,7 +440,17 @@ public async Task UpdateAsync(Mode { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CreateReimbursableExpenseResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CreateReimbursableExpenseResponse.", httpResponse, httpResponseBody, ex); + } + var response = new UpdateReimbursableExpenseTransactionResponse() { StatusCode = responseStatusCode, @@ -319,24 +461,59 @@ public async Task UpdateAsync(Mode return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/SDKConfig.cs b/sync-for-expenses/Codat/Sync/Expenses/SDKConfig.cs new file mode 100644 index 000000000..cade67a13 --- /dev/null +++ b/sync-for-expenses/Codat/Sync/Expenses/SDKConfig.cs @@ -0,0 +1,63 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace Codat.Sync.Expenses +{ + using Codat.Sync.Expenses.Hooks; + using Codat.Sync.Expenses.Models.Components; + using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; + using System; + using System.Collections.Generic; + using System.Linq; + + /// + /// Main configuration for the SDK. + /// + public struct SDKConfig + { + /// + /// List of server URLs available to the SDK. + /// + public static readonly string[] ServerList = { + "https://api.codat.io", + }; + + public ISpeakeasyHttpClient Client; + public string ServerUrl; + public int ServerIndex; + public string UserAgent; + public Func? SecuritySource; + public SDKHooks Hooks; + public RetryConfig? RetryConfig; + + /// + /// Initializes a new instance of the SDKConfig struct with default values. + /// + public SDKConfig(ISpeakeasyHttpClient? client = null) + { + Client = client ?? new SpeakeasyHttpClient(); + ServerUrl = ""; + ServerIndex = 0; + UserAgent = "speakeasy-sdk/csharp 7.1.0 2.849.2 prealpha Codat.Sync.Expenses"; + SecuritySource = null; + Hooks = new SDKHooks(); + RetryConfig = null; + } + + public string GetTemplatedServerUrl() + { + if (!String.IsNullOrEmpty(this.ServerUrl)) + { + return Utilities.TemplateUrl(Utilities.RemoveSuffix(this.ServerUrl, "/"), new Dictionary()); + } + return Utilities.TemplateUrl(SDKConfig.ServerList[this.ServerIndex], new Dictionary()); + } + } +} diff --git a/sync-for-expenses/Codat/Sync/Expenses/Suppliers.cs b/sync-for-expenses/Codat/Sync/Expenses/Suppliers.cs index 6f3385814..d666a0b51 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Suppliers.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Suppliers.cs @@ -13,79 +13,156 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Get, create, and update suppliers. /// public interface ISuppliers { - /// - /// List suppliers - /// + /// List suppliers. + /// /// - /// The *List suppliers* endpoint returns a list of suppliers for a given company's connection.
+ /// The *List suppliers* endpoint returns a list of suppliers for a given company's connection.
///
/// Suppliers 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.
- /// + /// Before using this endpoint, you must have retrieved data for the company.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | /// - /// - Task ListAsync(ListSuppliersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync(ListSuppliersRequest request, RetryConfig? retryConfig = null); /// - /// Get supplier - /// + /// Get supplier. + /// /// /// The *Get supplier* endpoint returns a single supplier for a given supplierId.
///
/// Suppliers 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.
- /// + /// Before using this endpoint, you must have retrieved data for the company.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | /// - /// - Task GetAsync(GetSupplierRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetSupplierRequest request, RetryConfig? retryConfig = null); /// - /// Create supplier - /// + /// Create supplier. + /// /// - /// The *Create supplier* endpoint creates a new supplier for a given company's connection.
+ /// The *Create supplier* endpoint creates a new supplier for a given company's connection.
///
/// Suppliers are people or organizations that provide something, such as a product or service.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
///
/// Required data may vary by integration. To see what data to post, first call Get create/update supplier model.
- /// + ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | /// - /// - Task CreateAsync(CreateSupplierRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateSupplierRequest request, + RetryConfig? retryConfig = null + ); /// - /// Update supplier - /// + /// Update supplier. + /// /// - /// The *Update supplier* endpoint updates an existing supplier for a given company's connection.
+ /// The *Update supplier* endpoint updates an existing supplier for a given company's connection.
///
/// Suppliers are people or organizations that provide something, such as a product or service.
///
- /// **Integration-specific behaviour**
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model.
+ ///
+ /// ### Supported Integrations
///
- /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model. + /// | Integration | Supported |
+ /// |-------------------|-----------|
+ /// | FreeAgent | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Xero | Yes | /// - /// - Task UpdateAsync(UpdateSupplierRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UpdateAsync( + UpdateSupplierRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -93,38 +170,72 @@ public interface ISuppliers /// public class Suppliers: ISuppliers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Suppliers(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Suppliers(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task ListAsync(ListSuppliersRequest request, RetryConfig? retryConfig = null) + /// + /// List suppliers. + /// + /// + /// The *List suppliers* endpoint returns a list of suppliers for a given company's connection.
+ ///
+ /// Suppliers 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.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListSuppliersRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/suppliers", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/suppliers", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("list-suppliers", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-suppliers", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -158,8 +269,8 @@ public async Task ListAsync(ListSuppliersRequest request, Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -169,7 +280,7 @@ public async Task ListAsync(ListSuppliersRequest request, httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -178,9 +289,9 @@ public async Task ListAsync(ListSuppliersRequest 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; @@ -199,7 +310,17 @@ public async Task ListAsync(ListSuppliersRequest request, { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.Suppliers obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.Suppliers.", httpResponse, httpResponseBody, ex); + } + var response = new ListSuppliersResponse() { StatusCode = responseStatusCode, @@ -210,40 +331,113 @@ public async Task ListAsync(ListSuppliersRequest request, return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 409, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 409, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetSupplierRequest request, RetryConfig? retryConfig = null) + + /// + /// Get supplier. + /// + /// + /// The *Get supplier* endpoint returns a single supplier for a given supplierId.
+ ///
+ /// Suppliers 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.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetSupplierRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/suppliers/{supplierId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/data/suppliers/{supplierId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-supplier", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-supplier", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -277,8 +471,8 @@ public async Task GetAsync(GetSupplierRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -288,7 +482,7 @@ public async Task GetAsync(GetSupplierRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -297,9 +491,9 @@ public async Task GetAsync(GetSupplierRequest request, Retr } } } - 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; @@ -318,7 +512,17 @@ public async Task GetAsync(GetSupplierRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Supplier obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Supplier.", httpResponse, httpResponseBody, ex); + } + var response = new GetSupplierResponse() { StatusCode = responseStatusCode, @@ -329,33 +533,111 @@ public async Task GetAsync(GetSupplierRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 409, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 409, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateSupplierRequest request, RetryConfig? retryConfig = null) + + /// + /// Create supplier. + /// + /// + /// The *Create supplier* endpoint creates a new supplier for a given company's connection.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------------------|-----------|
+ /// | Dynamics 365 Business Central | Yes |
+ /// | FreeAgent | Yes |
+ /// | Oracle NetSuite | Yes |
+ /// | QuickBooks Desktop | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Sage Intacct | Yes |
+ /// | Xero | Yes |
+ /// | Zoho Books | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateSupplierRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/suppliers", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/suppliers", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "Supplier", "json", true, true); if (serializedBody != null) @@ -363,12 +645,12 @@ public async Task GetAsync(GetSupplierRequest request, Retr httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-supplier", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-supplier", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -402,8 +684,8 @@ public async Task GetAsync(GetSupplierRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -413,7 +695,7 @@ public async Task GetAsync(GetSupplierRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -422,9 +704,9 @@ public async Task GetAsync(GetSupplierRequest request, Retr } } } - 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; @@ -443,7 +725,17 @@ public async Task GetAsync(GetSupplierRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.CreateSupplierResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.CreateSupplierResponse.", httpResponse, httpResponseBody, ex); + } + var response = new Models.Requests.CreateSupplierResponse() { StatusCode = responseStatusCode, @@ -454,33 +746,106 @@ public async Task GetAsync(GetSupplierRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UpdateAsync(UpdateSupplierRequest request, RetryConfig? retryConfig = null) + + /// + /// Update supplier. + /// + /// + /// The *Update supplier* endpoint updates an existing supplier for a given company's connection.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model.
+ ///
+ /// ### Supported Integrations
+ ///
+ /// | Integration | Supported |
+ /// |-------------------|-----------|
+ /// | FreeAgent | Yes |
+ /// | QuickBooks Online | Yes |
+ /// | Xero | Yes | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UpdateAsync( + UpdateSupplierRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "Supplier", "json", true, true); if (serializedBody != null) @@ -488,12 +853,12 @@ public async Task GetAsync(GetSupplierRequest request, Retr httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("update-supplier", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "update-supplier", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -527,8 +892,8 @@ public async Task GetAsync(GetSupplierRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -538,7 +903,7 @@ public async Task GetAsync(GetSupplierRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -547,9 +912,9 @@ public async Task GetAsync(GetSupplierRequest request, Retr } } } - 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; @@ -568,7 +933,17 @@ public async Task GetAsync(GetSupplierRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Models.Components.UpdateSupplierResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Models.Components.UpdateSupplierResponse.", httpResponse, httpResponseBody, ex); + } + var response = new Models.Requests.UpdateSupplierResponse() { StatusCode = responseStatusCode, @@ -579,24 +954,59 @@ public async Task GetAsync(GetSupplierRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 400 && responseStatusCode < 500) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Sync.cs b/sync-for-expenses/Codat/Sync/Expenses/Sync.cs index a20a06411..2e043ec10 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Sync.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Sync.cs @@ -13,56 +13,89 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Monitor the status of data syncs. /// public interface ISync { - /// - /// Last successful sync - /// + /// Last successful sync. + /// /// - /// Gets the status of the last successful sync + /// Gets the status of the last successful sync. /// - /// - Task GetLastSuccessfulSyncAsync(GetLastSuccessfulSyncRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetLastSuccessfulSyncAsync( + GetLastSuccessfulSyncRequest request, + RetryConfig? retryConfig = null + ); /// - /// Latest sync status - /// + /// Latest sync status. + /// /// - /// Gets the latest sync status + /// Gets the latest sync status. /// - /// - Task GetLatestSyncAsync(GetLatestSyncRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetLatestSyncAsync( + GetLatestSyncRequest request, + RetryConfig? retryConfig = null + ); /// - /// List sync statuses - /// + /// List sync statuses. + /// /// - /// Gets a list of sync statuses + /// Gets a list of sync statuses. /// - /// - Task ListAsync(ListSyncsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync(ListSyncsRequest request, RetryConfig? retryConfig = null); /// - /// Get sync status - /// + /// Get sync status. + /// /// - /// Get the sync status for a specified sync + /// Get the sync status for a specified sync. /// - /// - Task GetAsync(GetSyncByIdRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetSyncByIdRequest request, RetryConfig? retryConfig = null); } /// @@ -70,38 +103,55 @@ public interface ISync /// public class Sync: ISync { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Sync(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Sync(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task GetLastSuccessfulSyncAsync(GetLastSuccessfulSyncRequest request, RetryConfig? retryConfig = null) + /// + /// Last successful sync. + /// + /// + /// Gets the status of the last successful sync. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetLastSuccessfulSyncAsync( + GetLastSuccessfulSyncRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/lastSuccessful/status", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/lastSuccessful/status", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-last-successful-sync", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-last-successful-sync", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -135,8 +185,8 @@ public async Task GetLastSuccessfulSyncAsync(GetL Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -146,7 +196,7 @@ public async Task GetLastSuccessfulSyncAsync(GetL httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -155,9 +205,9 @@ public async Task GetLastSuccessfulSyncAsync(GetL } } } - 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; @@ -176,7 +226,17 @@ public async Task GetLastSuccessfulSyncAsync(GetL { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CompanySyncStatus obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CompanySyncStatus.", httpResponse, httpResponseBody, ex); + } + var response = new GetLastSuccessfulSyncResponse() { StatusCode = responseStatusCode, @@ -187,40 +247,99 @@ public async Task GetLastSuccessfulSyncAsync(GetL return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetLatestSyncAsync(GetLatestSyncRequest request, RetryConfig? retryConfig = null) + + /// + /// Latest sync status. + /// + /// + /// Gets the latest sync status. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetLatestSyncAsync( + GetLatestSyncRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/latest/status", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/latest/status", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-latest-sync", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-latest-sync", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -254,8 +373,8 @@ public async Task GetLatestSyncAsync(GetLatestSyncRequest Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -265,7 +384,7 @@ public async Task GetLatestSyncAsync(GetLatestSyncRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -274,9 +393,9 @@ public async Task GetLatestSyncAsync(GetLatestSyncRequest } } } - 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; @@ -295,7 +414,17 @@ public async Task GetLatestSyncAsync(GetLatestSyncRequest { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CompanySyncStatus obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CompanySyncStatus.", httpResponse, httpResponseBody, ex); + } + var response = new GetLatestSyncResponse() { StatusCode = responseStatusCode, @@ -306,40 +435,96 @@ public async Task GetLatestSyncAsync(GetLatestSyncRequest return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAsync(ListSyncsRequest request, RetryConfig? retryConfig = null) + + /// + /// List sync statuses. + /// + /// + /// Gets a list of sync statuses. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync(ListSyncsRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/list/status", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/list/status", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("list-syncs", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-syncs", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -373,8 +558,8 @@ public async Task ListAsync(ListSyncsRequest request, RetryCo Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -384,7 +569,7 @@ public async Task ListAsync(ListSyncsRequest request, RetryCo httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -393,9 +578,9 @@ public async Task ListAsync(ListSyncsRequest request, RetryCo } } } - 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; @@ -414,7 +599,17 @@ public async Task ListAsync(ListSyncsRequest request, RetryCo { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize>(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + List obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull>(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into List.", httpResponse, httpResponseBody, ex); + } + var response = new ListSyncsResponse() { StatusCode = responseStatusCode, @@ -425,40 +620,96 @@ public async Task ListAsync(ListSyncsRequest request, RetryCo return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetSyncByIdRequest request, RetryConfig? retryConfig = null) + + /// + /// Get sync status. + /// + /// + /// Get the sync status for a specified sync. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetSyncByIdRequest request, RetryConfig? retryConfig = null) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/status", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/status", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("get-sync-by-id", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-sync-by-id", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -492,8 +743,8 @@ public async Task GetAsync(GetSyncByIdRequest request, Retr Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -503,7 +754,7 @@ public async Task GetAsync(GetSyncByIdRequest request, Retr httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -512,9 +763,9 @@ public async Task GetAsync(GetSyncByIdRequest request, Retr } } } - 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; @@ -533,7 +784,17 @@ public async Task GetAsync(GetSyncByIdRequest request, Retr { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + CompanySyncStatus obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into CompanySyncStatus.", httpResponse, httpResponseBody, ex); + } + var response = new GetSyncByIdResponse() { StatusCode = responseStatusCode, @@ -544,24 +805,59 @@ public async Task GetAsync(GetSyncByIdRequest request, Retr return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{500, 503}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/TransactionStatus.cs b/sync-for-expenses/Codat/Sync/Expenses/TransactionStatus.cs index 63ec4fef7..3a820e206 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/TransactionStatus.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/TransactionStatus.cs @@ -13,38 +13,57 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// /// Monitor the status of individual transactions in data syncs. /// public interface ITransactionStatus { - /// - /// List sync transactions - /// + /// List sync transactions. + /// /// - /// Gets the transactions and status for a sync + /// Gets the transactions and status for a sync. /// - /// - Task ListAsync(ListSyncTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListSyncTransactionsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get sync transaction - /// + /// Get sync transaction. + /// /// - /// Gets the status of a transaction for a sync + /// Gets the status of a transaction for a sync. /// - /// - Task GetAsync(GetSyncTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetSyncTransactionRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -52,38 +71,55 @@ public interface ITransactionStatus /// public class TransactionStatus: ITransactionStatus { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public TransactionStatus(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public TransactionStatus(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task ListAsync(ListSyncTransactionsRequest request, RetryConfig? retryConfig = null) + /// + /// List sync transactions. + /// + /// + /// Gets the transactions and status for a sync. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListSyncTransactionsRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); - if (_securitySource != null) + if (!httpRequest.Headers.Contains("Accept")) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest.Headers.Add("Accept", "application/json"); } - var hookCtx = new HookContext("list-sync-transactions", null, _securitySource); + if (SDKConfiguration.SecuritySource != null) + { + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); + } + + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "list-sync-transactions", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -117,8 +153,8 @@ public async Task ListAsync(ListSyncTransactionsRe Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -128,7 +164,7 @@ public async Task ListAsync(ListSyncTransactionsRe httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -137,9 +173,9 @@ public async Task ListAsync(ListSyncTransactionsRe } } } - 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; @@ -158,7 +194,17 @@ public async Task ListAsync(ListSyncTransactionsRe { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + Transactions obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into Transactions.", httpResponse, httpResponseBody, ex); + } + var response = new ListSyncTransactionsResponse() { StatusCode = responseStatusCode, @@ -169,40 +215,99 @@ public async Task ListAsync(ListSyncTransactionsRe return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(new List{500, 503}.Contains(responseStatusCode)) + { + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(responseStatusCode >= 500 && responseStatusCode < 600) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetSyncTransactionRequest request, RetryConfig? retryConfig = null) + + /// + /// Get sync transaction. + /// + /// + /// Gets the status of a transaction for a sync. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetSyncTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("get-sync-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "get-sync-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -236,8 +341,8 @@ public async Task GetAsync(GetSyncTransactionRequest Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -247,7 +352,7 @@ public async Task GetAsync(GetSyncTransactionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -256,9 +361,9 @@ public async Task GetAsync(GetSyncTransactionRequest } } } - 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; @@ -277,7 +382,17 @@ public async Task GetAsync(GetSyncTransactionRequest { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize>(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + List obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull>(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into List.", httpResponse, httpResponseBody, ex); + } + var response = new GetSyncTransactionResponse() { StatusCode = responseStatusCode, @@ -288,24 +403,59 @@ public async Task GetAsync(GetSyncTransactionRequest return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Transfers.cs b/sync-for-expenses/Codat/Sync/Expenses/Transfers.cs index 82edbce58..53b6b368e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Transfers.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Transfers.cs @@ -13,73 +13,119 @@ namespace Codat.Sync.Expenses using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Errors; using Codat.Sync.Expenses.Models.Requests; - using Codat.Sync.Expenses.Utils.Retries; using Codat.Sync.Expenses.Utils; + using Codat.Sync.Expenses.Utils.Retries; using Newtonsoft.Json; + using System; using System.Collections.Generic; - using System.Net.Http.Headers; using System.Net.Http; + using System.Net.Http.Headers; using System.Threading.Tasks; - using System; /// - /// Create and update transactions that represent the movement of your customers' money. + /// Create and update transactions that represent the movement of your customers' money. /// public interface ITransfers { - /// - /// Create transfer transaction - /// + /// Create transfer transaction. + /// /// - /// Use the *Create transfer* endpoint to create or update a transfer transaction in the accounting software for a given company's connection.
+ /// Use the *Create transfer* endpoint to create or update a transfer transaction in the accounting software for a given company's connection.
///
/// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card.
///
/// The `from.amount` and `to.amount` fields are in the native currency of the account.
///
/// ### Supported Integrations
- /// | Integration | Supported |
- /// |-----------------------|-----------|
- /// | FreeAgent | Yes |
- /// | QuickBooks Desktop | Yes |
- /// | QuickBooks Online | Yes |
- /// | Xero | Yes | + /// | Integration | Create transfer | Update transfer |
+ /// |-----------------------|------------------|------------------|
+ /// | Dynamics | No | No |
+ /// | FreeAgent | Yes | Yes |
+ /// | NetSuite | No | No |
+ /// | QuickBooks Desktop | Yes | No |
+ /// | QuickBooks Online | Yes | Yes |
+ /// | Sage Intacct | No | No |
+ /// | Xero | Yes | No |
+ /// | Zoho Books | No | No | /// - /// - Task CreateAsync(CreateTransferTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateTransferTransactionRequest request, + RetryConfig? retryConfig = null + ); } /// - /// Create and update transactions that represent the movement of your customers' money. + /// Create and update transactions that represent the movement of your customers' money. /// public class Transfers: ITransfers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = "csharp"; - private const string _sdkVersion = "7.0.0"; - private const string _sdkGenVersion = "2.463.0"; - private const string _openapiDocVersion = "prealpha"; - private const string _userAgent = "speakeasy-sdk/csharp 7.0.0 2.463.0 prealpha Codat.Sync.Expenses"; - private string _serverUrl = ""; - private ISpeakeasyHttpClient _client; - private Func? _securitySource; - - public Transfers(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) + + public Transfers(SDKConfig config) { - _client = client; - _securitySource = securitySource; - _serverUrl = serverUrl; SDKConfiguration = config; } - public async Task CreateAsync(CreateTransferTransactionRequest request, RetryConfig? retryConfig = null) + /// + /// Create transfer transaction. + /// + /// + /// Use the *Create transfer* endpoint to create or update a transfer transaction in the accounting software for a given company's connection.
+ ///
+ /// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card.
+ ///
+ /// The `from.amount` and `to.amount` fields are in the native currency of the account.
+ ///
+ /// ### Supported Integrations
+ /// | Integration | Create transfer | Update transfer |
+ /// |-----------------------|------------------|------------------|
+ /// | Dynamics | No | No |
+ /// | FreeAgent | Yes | Yes |
+ /// | NetSuite | No | No |
+ /// | QuickBooks Desktop | Yes | No |
+ /// | QuickBooks Online | Yes | Yes |
+ /// | Sage Intacct | No | No |
+ /// | Xero | Yes | No |
+ /// | Zoho Books | No | No | + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateTransferTransactionRequest request, + RetryConfig? retryConfig = null + ) { + if (request == null) throw new ArgumentNullException(nameof(request)); + string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/transfer-transactions/{transactionId}", request); + var urlString = URLBuilder.Build(baseUrl, "/companies/{companyId}/sync/expenses/transfer-transactions/{transactionId}", request, null); var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); + httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } var serializedBody = RequestBodySerializer.Serialize(request, "TransferTransactionRequest", "json", false, true); if (serializedBody != null) @@ -87,12 +133,12 @@ public async Task CreateAsync(CreateTransferT httpRequest.Content = serializedBody; } - if (_securitySource != null) + if (SDKConfiguration.SecuritySource != null) { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); + httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); } - var hookCtx = new HookContext("create-transfer-transaction", null, _securitySource); + var hookCtx = new HookContext(SDKConfiguration, baseUrl, "create-transfer-transaction", null, SDKConfiguration.SecuritySource); httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); if (retryConfig == null) @@ -126,8 +172,8 @@ public async Task CreateAsync(CreateTransferT Func> retrySend = async () => { - var _httpRequest = await _client.CloneAsync(httpRequest); - return await _client.SendAsync(_httpRequest); + var _httpRequest = await SDKConfiguration.Client.CloneAsync(httpRequest); + return await SDKConfiguration.Client.SendAsync(_httpRequest); }; var retries = new Codat.Sync.Expenses.Utils.Retries.Retries(retrySend, retryConfig, statusCodes); @@ -137,7 +183,7 @@ public async Task CreateAsync(CreateTransferT httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -146,9 +192,9 @@ public async Task CreateAsync(CreateTransferT } } } - 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; @@ -167,7 +213,17 @@ public async Task CreateAsync(CreateTransferT { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + TransferTransactionResponse obj; + try + { + obj = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into TransferTransactionResponse.", httpResponse, httpResponseBody, ex); + } + var response = new CreateTransferTransactionResponse() { StatusCode = responseStatusCode, @@ -178,24 +234,59 @@ public async Task CreateAsync(CreateTransferT return response; } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(new List{400, 401, 402, 403, 404, 429, 500, 503}.Contains(responseStatusCode)) + else if(new List{400, 401, 402, 403, 404, 429}.Contains(responseStatusCode)) { if(Utilities.IsContentTypeMatch("application/json", contentType)) { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - throw obj!; + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); } - throw new Models.Errors.SDKException("Unknown content type received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - else if(responseStatusCode >= 400 && responseStatusCode < 500 || responseStatusCode >= 500 && responseStatusCode < 600) + else if(new List{500, 503}.Contains(responseStatusCode)) { - throw new Models.Errors.SDKException("API error occurred", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + if(Utilities.IsContentTypeMatch("application/json", contentType)) + { + var httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); + ErrorMessagePayload payload; + try + { + payload = ResponseBodyDeserializer.DeserializeNotNull(httpResponseBody, NullValueHandling.Ignore); + } + catch (Exception ex) + { + throw new ResponseValidationException("Failed to deserialize response body into ErrorMessagePayload.", httpResponse, httpResponseBody, ex); + } + + throw new ErrorMessage(payload, httpResponse, httpResponseBody); + } + + throw new Models.Errors.SDKException("Unknown content type received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 400 && responseStatusCode < 500) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); + } + else if(responseStatusCode >= 500 && responseStatusCode < 600) + { + throw new Models.Errors.SDKException("API error occurred", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse); + throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/Constants.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/Constants.cs new file mode 100644 index 000000000..f1e475b58 --- /dev/null +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/Constants.cs @@ -0,0 +1,38 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace Codat.Sync.Expenses.Utils +{ + /// + /// SDK constants for version information and language identification. + /// + public static class Constants + { + /// + /// The language identifier for this SDK. + /// + public const string Language = "csharp"; + + /// + /// The version of the SDK. + /// + public const string SdkVersion = "7.1.0"; + + /// + /// The version of the SDK generator used to create this SDK. + /// + public const string SdkGenVersion = "2.849.2"; + + /// + /// The version of the OpenAPI document used to generate this SDK. + /// + public const string OpenApiDocVersion = "prealpha"; + } +} + diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/OpenEnumConverter.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/OpenEnumConverter.cs new file mode 100644 index 000000000..509c637ff --- /dev/null +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/OpenEnumConverter.cs @@ -0,0 +1,62 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +using System; +using Newtonsoft.Json; +namespace Codat.Sync.Expenses.Utils +{ + internal class OpenEnumConverter : JsonConverter + { + public override bool CanConvert(System.Type objectType) + { + return objectType.GetMethod("Of") != null && objectType.GetMethod("ToString") != null; + } + + public override object? ReadJson( + JsonReader reader, + System.Type objectType, + object? existingValue, + JsonSerializer serializer + ) + { + if (reader.Value == null) + { + return null; + } + + var method = objectType.GetMethod("Of"); + if (method == null) + { + throw new Exception($"Unable to find Of method on {objectType}"); + } + try { + return method.Invoke(null, new[] { reader.Value }); + } catch(System.Reflection.TargetInvocationException e) { + throw new Newtonsoft.Json.JsonSerializationException("Unable to convert value to open enum", e); + } + } + + public override void WriteJson(JsonWriter writer, object? obj, JsonSerializer serializer) + { + if (obj == null) + { + writer.WriteValue("null"); + return; + } + + var valueProp = obj.GetType().GetProperty("Value"); + if (valueProp == null) + { + throw new Exception($"{obj.GetType()} does not have a Value property"); + } + + writer.WriteValue(valueProp.GetValue(obj)); + } + } +} diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/RequestBodySerializer.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/RequestBodySerializer.cs index 838add307..964d39ffd 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/RequestBodySerializer.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/RequestBodySerializer.cs @@ -265,49 +265,44 @@ private static HttpContent SerializeMultipart(object request, string mediaType) if (metadata.File) { - if (!Utilities.IsClass(value)) + if (Utilities.IsList(value)) { - throw new Exception( - "Cannot serialize multipart file from type " + value.GetType().Name - ); - } - - var fileProps = value.GetType().GetProperties(); - - byte[]? content = null; - string fileName = ""; - string fieldName = ""; - - foreach (var fileProp in fileProps) - { - var fileMetadata = fileProp - .GetCustomAttribute() - ?.GetMultipartFormMetadata(); - if ( - fileMetadata == null - || (!fileMetadata.Content && fileMetadata.Name == "") - ) + // Handle array/list of files - similar to how normal lists are handled + foreach (var fileItem in (IList)value) { - continue; - } + if (!Utilities.IsClass(fileItem)) + { + throw new Exception( + "Cannot serialize multipart file from type " + fileItem.GetType().Name + ); + } - if (fileMetadata.Content) - { - content = (byte[]?)fileProp.GetValue(value); - } - else - { - fieldName = fileMetadata.Name ?? fileProp.Name; - fileName = fileProp.GetValue(value)?.ToString() ?? ""; + var fileProps = fileItem.GetType().GetProperties(); + var (fileName, content) = ExtractFileProperties(fileProps, fileItem); + string fieldName = (metadata.Name ?? prop.Name) + "[]"; + + var fileContent = new ByteArrayContent(content); + fileContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(GetMimeType(fileName)); + formData.Add(fileContent, fieldName, fileName); } } - - if (fieldName == "" || fileName == "" || content == null) + else if (Utilities.IsClass(value)) { - throw new Exception("Invalid multipart/form-data file"); + // Handle single file + var fileProps = value.GetType().GetProperties(); + var (fileName, content) = ExtractFileProperties(fileProps, value); + string fieldName = metadata.Name; + + var fileContent = new ByteArrayContent(content); + fileContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(GetMimeType(fileName)); + formData.Add(fileContent, fieldName, fileName); + } + else + { + throw new Exception( + "Cannot serialize multipart file from type " + value.GetType().Name + ); } - - formData.Add(new ByteArrayContent(content), fieldName, fileName); } else if (metadata.Json) { @@ -521,6 +516,63 @@ ref Dictionary> form } } + private static (string fileName, byte[] content) ExtractFileProperties(PropertyInfo[] fileProps, object fileObject) + { + byte[]? content = null; + string fileName = ""; + + foreach (var fileProp in fileProps) + { + var fileMetadata = fileProp + .GetCustomAttribute() + ?.GetMultipartFormMetadata(); + if ( + fileMetadata == null + || (!fileMetadata.Content && fileMetadata.Name == "") + ) + { + continue; + } + + if (fileMetadata.Content) + { + content = (byte[]?)fileProp.GetValue(fileObject); + } + else + { + fileName = fileProp.GetValue(fileObject)?.ToString() ?? ""; + } + } + + if (fileName == "" || content == null) + { + throw new Exception("Invalid multipart/form-data file"); + } + + 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/sync-for-expenses/Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs index 9f49c1256..114ed4572 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/ResponseBodyDeserializer.cs @@ -28,6 +28,16 @@ internal class ResponseBodyDeserializer return JsonConvert.DeserializeObject(json, new JsonSerializerSettings(){ NullValueHandling = nullValueHandling, MissingMemberHandling = missingMemberHandling, Converters = Utilities.GetJsonDeserializers(typeof(T))}); } + public static T DeserializeNotNull(string json, NullValueHandling nullValueHandling=NullValueHandling.Ignore, MissingMemberHandling missingMemberHandling=MissingMemberHandling.Ignore) + { + var result = ResponseBodyDeserializer.Deserialize(json, nullValueHandling, missingMemberHandling); + if (result == null) + { + throw new Exception($"Deserialization error: {typeof(T).Name} cannot be null."); + } + return result!; + } + public sealed class MissingMemberException : Exception { public MissingMemberException() : base("Missing member.") { } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs index 31e863571..727bcc868 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/BackoffStrategy.cs @@ -9,6 +9,9 @@ #nullable enable namespace Codat.Sync.Expenses.Utils.Retries { + /// + /// Exponential backoff strategy configuration. + /// public class BackoffStrategy { public readonly long InitialIntervalMs; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/Retries.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/Retries.cs index cf0362fda..e2ed2a909 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/Retries.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/Retries.cs @@ -15,12 +15,22 @@ namespace Codat.Sync.Expenses.Utils.Retries using System.Threading.Tasks; using Models.Errors; + /// + /// Handles retry logic for HTTP requests with configurable backoff strategies. + /// public class Retries { private Func> action; private RetryConfig retryConfig; private List statusCodes; + /// + /// Initializes a new instance of the class. + /// + /// The HTTP action to execute and potentially retry. + /// The retry configuration specifying strategy and backoff parameters. + /// The list of HTTP status codes that should trigger retries. + /// Thrown when the statusCodes list is empty. public Retries(Func> action, RetryConfig retryConfig, List statusCodes) { this.action = action; @@ -33,11 +43,17 @@ public Retries(Func> action, RetryConfig retryConfig, } } + /// + /// Exception indicating a non-retryable error that should be immediately propagated. + /// public sealed class PermanentException : Exception { public PermanentException(Exception innerException) : base("NonRetryable error.", innerException) { } } + /// + /// Exception indicating a retryable error that may succeed on subsequent attempts. + /// public sealed class RetryableException : Exception { public HttpResponseMessage? Response = null; @@ -49,6 +65,11 @@ public RetryableException(HttpResponseMessage response) { public RetryableException(Exception innerException) : base("An error occurred.", innerException) { } } + /// + /// Executes the configured HTTP action with retry logic based on the retry strategy. + /// + /// The HTTP response message from the successful request. + /// Thrown when the retry strategy is invalid. public async Task Run() { switch(retryConfig.Strategy) { diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs index e46c23064..7c3ec59a5 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/Retries/RetryConfig.cs @@ -11,13 +11,24 @@ namespace Codat.Sync.Expenses.Utils.Retries { public class RetryConfig { + /// + /// Available retry strategies. + /// public enum RetryStrategy { + /// Exponential backoff strategy. BACKOFF, + /// Disabled (no retries). NONE } + + /// The retry strategy. public readonly RetryStrategy Strategy; + + /// The backoff strategy configuration (if applicable). public readonly BackoffStrategy? Backoff; + + /// Whether to retry on connection errors. public readonly bool RetryConnectionErrors; /// diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/SecurityMetadata.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/SecurityMetadata.cs index 23b7eb042..581b96e54 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/SecurityMetadata.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/SecurityMetadata.cs @@ -99,6 +99,26 @@ 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); + if (value == null) + { + continue; + } + + var secMetadata = prop.GetCustomAttribute()?.GetSecurityMetadata(); + if (secMetadata != null && secMetadata.Scheme && secMetadata.Type == "http" && secMetadata.SubType == "basic" && !Utilities.IsClass(value)) + { + ParseBasicAuthScheme(option); + return; + } + } + foreach (var prop in option.GetType().GetProperties()) { var value = prop.GetValue(option, null); @@ -196,6 +216,8 @@ object value case "bearer": headerParams.Add(key, Utilities.PrefixBearer(valStr)); break; + case "custom": + break; default: throw new Exception($"Unknown http subType: {schemeMetadata.SubType}"); } diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs index dcda538a4..64a595ee8 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/SpeakeasyHttpClient.cs @@ -19,6 +19,9 @@ public interface ISpeakeasyHttpClient /// /// Sends an HTTP request asynchronously. /// + /// + /// When overriding this method, use HttpCompletionOption.ResponseHeadersRead to support streaming response bodies. + /// /// The HTTP request message to send. /// The value of the TResult parameter contains the HTTP response message. Task SendAsync(HttpRequestMessage request); @@ -46,7 +49,7 @@ public SpeakeasyHttpClient() public virtual async Task SendAsync(HttpRequestMessage request) { - return await httpClient.SendAsync(request); + return await httpClient.SendAsync(request, HttpCompletionOption.ResponseHeadersRead); } public virtual async Task CloneAsync(HttpRequestMessage request) diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/URLBuilder.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/URLBuilder.cs index 8230650ed..27c5d063e 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/URLBuilder.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/URLBuilder.cs @@ -17,7 +17,7 @@ namespace Codat.Sync.Expenses.Utils internal static class URLBuilder { - public static string Build(string baseUrl, string relativeUrl, object? request) + public static string Build(string baseUrl, string relativeUrl, object? request, List? allowEmptyValue = null) { var url = baseUrl; @@ -37,7 +37,7 @@ public static string Build(string baseUrl, string relativeUrl, object? request) var parameters = GetPathParameters(request); url = ReplaceParameters(url, parameters); - var queryParams = SerializeQueryParams(TrySerializeQueryParams(request)); + var queryParams = SerializeQueryParams(TrySerializeQueryParams(request, allowEmptyValue)); if (queryParams != "") { url += $"?{queryParams}"; @@ -55,7 +55,7 @@ public static string ReplaceParameters(string url, Dictionary pa { foreach (var key in parameters.Keys) { - url = url.Replace($"{{{key}}}", parameters[key]); + url = url.Replace($"{{{key}}}", Uri.EscapeDataString(parameters[key])); } return url; @@ -68,7 +68,7 @@ public static string SerializeQueryParams(Dictionary> query { foreach (var value in queryParams[key]) { - queries.Add($"{key}={value}"); + queries.Add($"{key}={WebUtility.UrlEncode(Utilities.ToString(value))}"); } } @@ -90,10 +90,6 @@ private static Dictionary GetPathParameters(object? request) { var val = prop.GetValue(request); - if (val == null) - { - continue; - } if (prop.GetCustomAttribute()?.GetRequestMetadata() != null) { @@ -107,6 +103,13 @@ private static Dictionary GetPathParameters(object? request) continue; } + // Handle null values and empty arrays as empty query parameters + if (val == null || (Utilities.IsList(val) && ((IList)val).Count == 0)) + { + parameters.Add(metadata.Name ?? prop.Name, ""); + continue; + } + if (metadata.Serialization != null) { switch (metadata.Serialization) @@ -114,7 +117,7 @@ private static Dictionary GetPathParameters(object? request) case "json": parameters.Add( metadata.Name ?? prop.Name, - WebUtility.UrlEncode(Utilities.SerializeJSON(val)) + Utilities.SerializeJSON(val) ); break; default: @@ -147,7 +150,7 @@ private static Dictionary GetPathParameters(object? request) return parameters; } - private static Dictionary> TrySerializeQueryParams(object? request) + private static Dictionary> TrySerializeQueryParams(object? request, List? allowEmptyValue = null) { var parameters = new Dictionary>(); @@ -161,9 +164,20 @@ private static Dictionary> TrySerializeQueryParams(object? foreach (var prop in props) { var val = prop.GetValue(request); - + var metadata = prop.GetCustomAttribute()?.GetQueryParamMetadata(); + if (val == null) { + // If this parameter is in allowEmptyValue and val is null, include it as empty + if (metadata != null && allowEmptyValue?.Contains(metadata.Name ?? prop.Name) == true) + { + var paramName = metadata.Name ?? prop.Name; + if (!parameters.ContainsKey(paramName)) + { + parameters.Add(paramName, new List()); + } + parameters[paramName].Add(""); + } continue; } @@ -172,7 +186,6 @@ private static Dictionary> TrySerializeQueryParams(object? continue; } - var metadata = prop.GetCustomAttribute()?.GetQueryParamMetadata(); if (metadata == null) { continue; @@ -207,7 +220,8 @@ private static Dictionary> TrySerializeQueryParams(object? metadata.Name ?? prop.Name, val, metadata.Explode, - "," + ",", + allowEmptyValue ); foreach (var key in formParams.Keys) { @@ -245,7 +259,8 @@ private static Dictionary> TrySerializeQueryParams(object? metadata.Name ?? prop.Name, val, metadata.Explode, - "|" + "|", + allowEmptyValue ); foreach (var key in pipeParams.Keys) { @@ -358,7 +373,8 @@ private static Dictionary> SerializeFormQueryParams( string parentName, object value, bool explode, - string delimiter + string delimiter, + List? allowEmptyValue = null ) { var parameters = new Dictionary>(); @@ -458,32 +474,45 @@ string delimiter { var values = new List(); var items = new List(); + var list = (IList)value; - foreach (var item in (IList)value) + // Handle empty arrays - add empty parameter if allowEmptyValue includes this parameter + if (list.Count == 0 && allowEmptyValue?.Contains(parentName) == true) { - if (explode) - { - values.Add(Utilities.ValueToString(item)); - } - else + if (!parameters.ContainsKey(parentName)) { - items.Add(Utilities.ValueToString(item)); + parameters.Add(parentName, new List()); } + parameters[parentName].Add(""); } - - if (items.Count > 0) + else { - values.Add(string.Join(delimiter, items)); - } + foreach (var item in list) + { + if (explode) + { + values.Add(Utilities.ValueToString(item)); + } + else + { + items.Add(Utilities.ValueToString(item)); + } + } - foreach (var val in values) - { - if (!parameters.ContainsKey(parentName)) + if (items.Count > 0) { - parameters.Add(parentName, new List()); + values.Add(string.Join(delimiter, items)); } - parameters[parentName].Add(val); + foreach (var val in values) + { + if (!parameters.ContainsKey(parentName)) + { + parameters.Add(parentName, new List()); + } + + parameters[parentName].Add(val); + } } } else @@ -493,7 +522,16 @@ string delimiter parameters.Add(parentName, new List()); } - parameters[parentName].Add(Utilities.ValueToString(value)); + // Handle null values and empty strings for allowEmptyValue parameters + var stringValue = Utilities.ValueToString(value); + if ((value == null || stringValue == "") && allowEmptyValue?.Contains(parentName) == true) + { + parameters[parentName].Add(""); + } + else + { + parameters[parentName].Add(stringValue); + } } return parameters; diff --git a/sync-for-expenses/Codat/Sync/Expenses/Utils/Utilities.cs b/sync-for-expenses/Codat/Sync/Expenses/Utils/Utilities.cs index 3ac021671..334838c1d 100644 --- a/sync-for-expenses/Codat/Sync/Expenses/Utils/Utilities.cs +++ b/sync-for-expenses/Codat/Sync/Expenses/Utils/Utilities.cs @@ -303,6 +303,7 @@ public static string PrefixBearer(string authHeaderValue) return $"Bearer {authHeaderValue}"; } + public static string RemoveSuffix(string inputString, string suffix) { if (!String.IsNullOrEmpty(suffix) && inputString.EndsWith(suffix)) @@ -311,6 +312,7 @@ public static string RemoveSuffix(string inputString, string suffix) } return inputString; } + public static string TemplateUrl(string template, Dictionary paramDict) { foreach(KeyValuePair entry in paramDict) @@ -319,5 +321,19 @@ public static string TemplateUrl(string template, Dictionary par } return template; } + + public static Dictionary> CollectHeaders(HttpHeaders headers) + { + var dict = new Dictionary>(StringComparer.OrdinalIgnoreCase); + foreach (var header in headers) + { + if (!dict.ContainsKey(header.Key)) + { + dict[header.Key] = new List(); + } + dict[header.Key].AddRange(header.Value); + } + return dict; + } } } diff --git a/sync-for-expenses/NUGET.md b/sync-for-expenses/NUGET.md index c8b246aa9..78dad9134 100644 --- a/sync-for-expenses/NUGET.md +++ b/sync-for-expenses/NUGET.md @@ -8,16 +8,15 @@ ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -34,16 +33,15 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an To change the default retry strategy for a single API call, simply pass a `RetryConfig` to the call: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync( @@ -57,7 +55,7 @@ var res = await sdk.Companies.ListAsync( ), retryConnectionErrors: false ), - req + request: req ); // handle response @@ -66,8 +64,8 @@ var res = await sdk.Companies.ListAsync( If you'd like to override the default retry strategy for all operations that support retries, you can use the `RetryConfig` optional parameter when intitializing the SDK: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses( retryConfig: new RetryConfig( @@ -84,10 +82,9 @@ var sdk = new CodatSyncExpenses( ); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -99,62 +96,86 @@ var res = await sdk.Companies.ListAsync(req); ## Error Handling -Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception. - -By default, an API error will raise a `Codat.Sync.Expenses.Models.Errors.SDKException` exception, which has the following properties: +[`CodatSyncExpensesException`](./Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs) is the base exception class for all HTTP error responses. It has the following properties: | Property | Type | Description | |---------------|-----------------------|-----------------------| -| `Message` | *string* | The error message | -| `StatusCode` | *int* | The HTTP status code | -| `RawResponse` | *HttpResponseMessage* | The raw HTTP response | -| `Body` | *string* | The response content | - -When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `ListAsync` method throws the following exceptions: +| `Message` | *string* | Error message | +| `StatusCode` | *int* | HTTP status code | +| `Headers` | *HttpResponseHeaders* | HTTP headers | +| `ContentType` | *string?* | HTTP content type | +| `RawResponse` | *HttpResponseMessage* | HTTP response object | +| `Body` | *string* | HTTP response body | -| Error Type | Status Code | Content Type | -| ---------------------------------------------- | -------------------------------------- | ---------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | -| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | +Some exceptions in this SDK include an additional `Payload` field, which will contain deserialized custom error data when present. Possible exceptions are listed in the [Error Classes](#error-classes) section. ### Example ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; -using System; using Codat.Sync.Expenses.Models.Errors; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); try { ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); // handle response } -catch (Exception ex) +catch (CodatSyncExpensesException ex) // all SDK exceptions inherit from CodatSyncExpensesException { - if (ex is ErrorMessage) + // ex.ToString() provides a detailed error message + System.Console.WriteLine(ex); + + // Base exception fields + HttpResponseMessage rawResponse = ex.RawResponse; + HttpResponseHeaders headers = ex.Headers; + int statusCode = ex.StatusCode; + string? contentType = ex.ContentType; + var responseBody = ex.Body; + + if (ex is ErrorMessage) // different exceptions may be thrown depending on the method { - // Handle exception data - throw; + // Check error data fields + ErrorMessagePayload payload = ex.Payload; + long StatusCode = payload.StatusCode; + string Service = payload.Service; + // ... } - else if (ex is Codat.Sync.Expenses.Models.Errors.SDKException) + + // An underlying cause may be provided + if (ex.InnerException != null) { - // Handle default exception - throw; + Exception cause = ex.InnerException; } } +catch (System.Net.Http.HttpRequestException ex) +{ + // Check ex.InnerException for Network connectivity errors +} ``` + +### Error Classes + +**Primary exceptions:** +* [`CodatSyncExpensesException`](./Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs): The base class for HTTP error responses. + * [`ErrorMessage`](./Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs): Your `query` parameter was not correctly formed. + +**Less common exceptions (2)** + +* [`System.Net.Http.HttpRequestException`](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httprequestexception): Network connectivity error. For more details about the underlying cause, inspect the `ex.InnerException`. + +* Inheriting from [`CodatSyncExpensesException`](./Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs): + * [`ResponseValidationError`](./Codat/Sync/Expenses/Models/Errors/ResponseValidationError.cs): Thrown when the response data could not be deserialized into the expected type. @@ -162,11 +183,11 @@ catch (Exception ex) ### Override Server URL Per-Client -The default server can also be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example: +The default server can be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses( serverUrl: "https://api.codat.io", @@ -174,10 +195,9 @@ var sdk = new CodatSyncExpenses( ); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -200,16 +220,15 @@ This SDK supports the following security scheme globally: To authenticate with the API the `AuthHeader` parameter must be set when initializing the SDK client instance. For example: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -218,4 +237,146 @@ var res = await sdk.Companies.ListAsync(req); ``` + +## Custom HTTP Client + +The C# SDK makes API calls using an `ISpeakeasyHttpClient` that wraps the native +[HttpClient](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient). This +client provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle +errors and response. + +The `ISpeakeasyHttpClient` interface allows you to either use the default `SpeakeasyHttpClient` that comes with the SDK, +or provide your own custom implementation with customized configuration such as custom message handlers, timeouts, +connection pooling, and other HTTP client settings. + +The following example shows how to create a custom HTTP client with request modification and error handling: + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Utils; +using System.Net.Http; +using System.Threading; +using System.Threading.Tasks; + +// Create a custom HTTP client +public class CustomHttpClient : ISpeakeasyHttpClient +{ + private readonly ISpeakeasyHttpClient _defaultClient; + + public CustomHttpClient() + { + _defaultClient = new SpeakeasyHttpClient(); + } + + public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null) + { + // Add custom header and timeout + request.Headers.Add("x-custom-header", "custom value"); + request.Headers.Add("x-request-timeout", "30"); + + try + { + var response = await _defaultClient.SendAsync(request, cancellationToken); + // Log successful response + Console.WriteLine($"Request successful: {response.StatusCode}"); + return response; + } + catch (Exception error) + { + // Log error + Console.WriteLine($"Request failed: {error.Message}"); + throw; + } + } + + public void Dispose() + { + _httpClient?.Dispose(); + _defaultClient?.Dispose(); + } +} + +// Use the custom HTTP client with the SDK +var customHttpClient = new CustomHttpClient(); +var sdk = new CodatSyncExpenses(client: customHttpClient); +``` + +**You can also provide a completely custom HTTP client with your own configuration:** + +```csharp +using Codat.Sync.Expenses.Utils; +using System.Net.Http; +using System.Threading; +using System.Threading.Tasks; + +// Custom HTTP client with custom configuration +public class AdvancedHttpClient : ISpeakeasyHttpClient +{ + private readonly HttpClient _httpClient; + + public AdvancedHttpClient() + { + var handler = new HttpClientHandler() + { + MaxConnectionsPerServer = 10, + // ServerCertificateCustomValidationCallback = customCertValidation, // Custom SSL validation if needed + }; + + _httpClient = new HttpClient(handler) + { + Timeout = TimeSpan.FromSeconds(30) + }; + } + + public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null) + { + return await _httpClient.SendAsync(request, cancellationToken ?? CancellationToken.None); + } + + public void Dispose() + { + _httpClient?.Dispose(); + } +} + +var sdk = CodatSyncExpenses.Builder() + .WithClient(new AdvancedHttpClient()) + .Build(); +``` + +**For simple debugging, you can enable request/response logging by implementing a custom client:** + +```csharp +public class LoggingHttpClient : ISpeakeasyHttpClient +{ + private readonly ISpeakeasyHttpClient _innerClient; + + public LoggingHttpClient(ISpeakeasyHttpClient innerClient = null) + { + _innerClient = innerClient ?? new SpeakeasyHttpClient(); + } + + public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null) + { + // Log request + Console.WriteLine($"Sending {request.Method} request to {request.RequestUri}"); + + var response = await _innerClient.SendAsync(request, cancellationToken); + + // Log response + Console.WriteLine($"Received {response.StatusCode} response"); + + return response; + } + + public void Dispose() => _innerClient?.Dispose(); +} + +var sdk = new CodatSyncExpenses(client: new LoggingHttpClient()); +``` + +The SDK also provides built-in hook support through the `SDKConfiguration.Hooks` system, which automatically handles +`BeforeRequestAsync`, `AfterSuccessAsync`, and `AfterErrorAsync` hooks for advanced request lifecycle management. + + \ No newline at end of file diff --git a/sync-for-expenses/README.md b/sync-for-expenses/README.md index 71c221239..f3c10c9c4 100644 --- a/sync-for-expenses/README.md +++ b/sync-for-expenses/README.md @@ -7,15 +7,15 @@ ## Summary -Sync for Expenses: The API for Sync for Expenses. +Expenses: The API for Codat's Expenses solution. -Sync for Expenses is an API and a set of supporting tools. It has been built to +Expenses is an API and a set of supporting tools. It has been built to enable corporate card and expense management platforms to provide high-quality integrations with multiple accounting software through a standardized API. -[Explore product](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) +[Explore solution](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) -Not seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). +Not seeing the endpoints you're expecting? We've [reorganized our solutions](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). --- @@ -42,14 +42,19 @@ Not seeing the endpoints you're expecting? We've [reorganized our products](http ## Table of Contents + +* [Sync for Expenses](#sync-for-expenses) + * [Endpoints](#endpoints) + * [SDK Installation](#sdk-installation) + * [Example Usage](#example-usage) + * [SDK Example Usage](#sdk-example-usage) + * [Available Resources and Operations](#available-resources-and-operations) + * [Server Selection](#server-selection) + * [Authentication](#authentication) + * [Retries](#retries) + * [Error Handling](#error-handling) + * [Custom HTTP Client](#custom-http-client) -* [SDK Installation](#sdk-installation) -* [SDK Example Usage](#sdk-example-usage) -* [Available Resources and Operations](#available-resources-and-operations) -* [Retries](#retries) -* [Error Handling](#error-handling) -* [Server Selection](#server-selection) -* [Authentication](#authentication) @@ -78,16 +83,15 @@ dotnet add reference Codat/Sync/Expenses/Codat.Sync.Expenses.csproj ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -120,11 +124,11 @@ var res = await sdk.Companies.ListAsync(req); * [Create](docs/sdks/bankaccounts/README.md#create) - Create bank account * [GetCreateModel](docs/sdks/bankaccounts/README.md#getcreatemodel) - Get create bank account model - ### [Companies](docs/sdks/companies/README.md) * [List](docs/sdks/companies/README.md#list) - List companies * [Create](docs/sdks/companies/README.md#create) - Create company +* [Replace](docs/sdks/companies/README.md#replace) - Replace company * [Update](docs/sdks/companies/README.md#update) - Update company * [Delete](docs/sdks/companies/README.md#delete) - Delete a company * [Get](docs/sdks/companies/README.md#get) - Get company @@ -212,11 +216,11 @@ var res = await sdk.Companies.ListAsync(req); ### Override Server URL Per-Client -The default server can also be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example: +The default server can be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses( serverUrl: "https://api.codat.io", @@ -224,10 +228,9 @@ var sdk = new CodatSyncExpenses( ); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -250,16 +253,15 @@ This SDK supports the following security scheme globally: To authenticate with the API the `AuthHeader` parameter must be set when initializing the SDK client instance. For example: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -276,16 +278,15 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an To change the default retry strategy for a single API call, simply pass a `RetryConfig` to the call: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync( @@ -299,7 +300,7 @@ var res = await sdk.Companies.ListAsync( ), retryConnectionErrors: false ), - req + request: req ); // handle response @@ -308,8 +309,8 @@ var res = await sdk.Companies.ListAsync( If you'd like to override the default retry strategy for all operations that support retries, you can use the `RetryConfig` optional parameter when intitializing the SDK: ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses( retryConfig: new RetryConfig( @@ -326,10 +327,9 @@ var sdk = new CodatSyncExpenses( ); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -341,64 +341,235 @@ var res = await sdk.Companies.ListAsync(req); ## Error Handling -Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception. - -By default, an API error will raise a `Codat.Sync.Expenses.Models.Errors.SDKException` exception, which has the following properties: +[`CodatSyncExpensesException`](./Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs) is the base exception class for all HTTP error responses. It has the following properties: | Property | Type | Description | |---------------|-----------------------|-----------------------| -| `Message` | *string* | The error message | -| `StatusCode` | *int* | The HTTP status code | -| `RawResponse` | *HttpResponseMessage* | The raw HTTP response | -| `Body` | *string* | The response content | - -When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `ListAsync` method throws the following exceptions: +| `Message` | *string* | Error message | +| `StatusCode` | *int* | HTTP status code | +| `Headers` | *HttpResponseHeaders* | HTTP headers | +| `ContentType` | *string?* | HTTP content type | +| `RawResponse` | *HttpResponseMessage* | HTTP response object | +| `Body` | *string* | HTTP response body | -| Error Type | Status Code | Content Type | -| ---------------------------------------------- | -------------------------------------- | ---------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | -| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | +Some exceptions in this SDK include an additional `Payload` field, which will contain deserialized custom error data when present. Possible exceptions are listed in the [Error Classes](#error-classes) section. ### Example ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; -using System; using Codat.Sync.Expenses.Models.Errors; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); try { ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); // handle response } -catch (Exception ex) +catch (CodatSyncExpensesException ex) // all SDK exceptions inherit from CodatSyncExpensesException { - if (ex is ErrorMessage) + // ex.ToString() provides a detailed error message + System.Console.WriteLine(ex); + + // Base exception fields + HttpResponseMessage rawResponse = ex.RawResponse; + HttpResponseHeaders headers = ex.Headers; + int statusCode = ex.StatusCode; + string? contentType = ex.ContentType; + var responseBody = ex.Body; + + if (ex is ErrorMessage) // different exceptions may be thrown depending on the method { - // Handle exception data - throw; + // Check error data fields + ErrorMessagePayload payload = ex.Payload; + long StatusCode = payload.StatusCode; + string Service = payload.Service; + // ... } - else if (ex is Codat.Sync.Expenses.Models.Errors.SDKException) + + // An underlying cause may be provided + if (ex.InnerException != null) { - // Handle default exception - throw; + Exception cause = ex.InnerException; } } +catch (System.Net.Http.HttpRequestException ex) +{ + // Check ex.InnerException for Network connectivity errors +} ``` + +### Error Classes + +**Primary exceptions:** +* [`CodatSyncExpensesException`](./Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs): The base class for HTTP error responses. + * [`ErrorMessage`](./Codat/Sync/Expenses/Models/Errors/ErrorMessage.cs): Your `query` parameter was not correctly formed. + +
Less common exceptions (2) + +* [`System.Net.Http.HttpRequestException`](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httprequestexception): Network connectivity error. For more details about the underlying cause, inspect the `ex.InnerException`. + +* Inheriting from [`CodatSyncExpensesException`](./Codat/Sync/Expenses/Models/Errors/CodatSyncExpensesException.cs): + * [`ResponseValidationError`](./Codat/Sync/Expenses/Models/Errors/ResponseValidationError.cs): Thrown when the response data could not be deserialized into the expected type. +
+ +## Custom HTTP Client + +The C# SDK makes API calls using an `ISpeakeasyHttpClient` that wraps the native +[HttpClient](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient). This +client provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle +errors and response. + +The `ISpeakeasyHttpClient` interface allows you to either use the default `SpeakeasyHttpClient` that comes with the SDK, +or provide your own custom implementation with customized configuration such as custom message handlers, timeouts, +connection pooling, and other HTTP client settings. + +The following example shows how to create a custom HTTP client with request modification and error handling: + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Utils; +using System.Net.Http; +using System.Threading; +using System.Threading.Tasks; + +// Create a custom HTTP client +public class CustomHttpClient : ISpeakeasyHttpClient +{ + private readonly ISpeakeasyHttpClient _defaultClient; + + public CustomHttpClient() + { + _defaultClient = new SpeakeasyHttpClient(); + } + + public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null) + { + // Add custom header and timeout + request.Headers.Add("x-custom-header", "custom value"); + request.Headers.Add("x-request-timeout", "30"); + + try + { + var response = await _defaultClient.SendAsync(request, cancellationToken); + // Log successful response + Console.WriteLine($"Request successful: {response.StatusCode}"); + return response; + } + catch (Exception error) + { + // Log error + Console.WriteLine($"Request failed: {error.Message}"); + throw; + } + } + + public void Dispose() + { + _httpClient?.Dispose(); + _defaultClient?.Dispose(); + } +} + +// Use the custom HTTP client with the SDK +var customHttpClient = new CustomHttpClient(); +var sdk = new CodatSyncExpenses(client: customHttpClient); +``` + +
+You can also provide a completely custom HTTP client with your own configuration: + +```csharp +using Codat.Sync.Expenses.Utils; +using System.Net.Http; +using System.Threading; +using System.Threading.Tasks; + +// Custom HTTP client with custom configuration +public class AdvancedHttpClient : ISpeakeasyHttpClient +{ + private readonly HttpClient _httpClient; + + public AdvancedHttpClient() + { + var handler = new HttpClientHandler() + { + MaxConnectionsPerServer = 10, + // ServerCertificateCustomValidationCallback = customCertValidation, // Custom SSL validation if needed + }; + + _httpClient = new HttpClient(handler) + { + Timeout = TimeSpan.FromSeconds(30) + }; + } + + public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null) + { + return await _httpClient.SendAsync(request, cancellationToken ?? CancellationToken.None); + } + + public void Dispose() + { + _httpClient?.Dispose(); + } +} + +var sdk = CodatSyncExpenses.Builder() + .WithClient(new AdvancedHttpClient()) + .Build(); +``` +
+ +
+For simple debugging, you can enable request/response logging by implementing a custom client: + +```csharp +public class LoggingHttpClient : ISpeakeasyHttpClient +{ + private readonly ISpeakeasyHttpClient _innerClient; + + public LoggingHttpClient(ISpeakeasyHttpClient innerClient = null) + { + _innerClient = innerClient ?? new SpeakeasyHttpClient(); + } + + public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null) + { + // Log request + Console.WriteLine($"Sending {request.Method} request to {request.RequestUri}"); + + var response = await _innerClient.SendAsync(request, cancellationToken); + + // Log response + Console.WriteLine($"Received {response.StatusCode} response"); + + return response; + } + + public void Dispose() => _innerClient?.Dispose(); +} + +var sdk = new CodatSyncExpenses(client: new LoggingHttpClient()); +``` +
+ +The SDK also provides built-in hook support through the `SDKConfiguration.Hooks` system, which automatically handles +`BeforeRequestAsync`, `AfterSuccessAsync`, and `AfterErrorAsync` hooks for advanced request lifecycle management. + + diff --git a/sync-for-expenses/RELEASES.md b/sync-for-expenses/RELEASES.md index 9ce130b3e..a64d666dd 100644 --- a/sync-for-expenses/RELEASES.md +++ b/sync-for-expenses/RELEASES.md @@ -200,4 +200,14 @@ Based on: ### Generated - [csharp v7.0.0] sync-for-expenses ### Releases -- [NuGet v7.0.0] https://www.nuget.org/packages/Codat.Sync.Expenses/7.0.0 - sync-for-expenses \ No newline at end of file +- [NuGet v7.0.0] https://www.nuget.org/packages/Codat.Sync.Expenses/7.0.0 - sync-for-expenses + +## 2026-03-04 15:07:37 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.741.1 (2.849.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v7.1.0] sync-for-expenses +### Releases +- [NuGet v7.1.0] https://www.nuget.org/packages/Codat.Sync.Expenses/7.1.0 - sync-for-expenses \ No newline at end of file diff --git a/sync-for-expenses/USAGE.md b/sync-for-expenses/USAGE.md index 83982b781..2ce94d24b 100644 --- a/sync-for-expenses/USAGE.md +++ b/sync-for-expenses/USAGE.md @@ -1,16 +1,15 @@ ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); diff --git a/sync-for-expenses/docs/Models/Components/AccountMappingInfoAccountType.md b/sync-for-expenses/docs/Models/Components/AccountMappingInfoAccountType.md index 399ad2212..7497047a5 100644 --- a/sync-for-expenses/docs/Models/Components/AccountMappingInfoAccountType.md +++ b/sync-for-expenses/docs/Models/Components/AccountMappingInfoAccountType.md @@ -2,6 +2,14 @@ Type of the account. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = AccountMappingInfoAccountType.Asset; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/AccountPrototype.md b/sync-for-expenses/docs/Models/Components/AccountPrototype.md index b320dbf67..5c5b4671d 100644 --- a/sync-for-expenses/docs/Models/Components/AccountPrototype.md +++ b/sync-for-expenses/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/sync-for-expenses/docs/Models/Components/AccountStatus.md b/sync-for-expenses/docs/Models/Components/AccountStatus.md index cddd64b3d..3b31b1d5a 100644 --- a/sync-for-expenses/docs/Models/Components/AccountStatus.md +++ b/sync-for-expenses/docs/Models/Components/AccountStatus.md @@ -2,6 +2,14 @@ Status of the account +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = AccountStatus.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/AccountType.md b/sync-for-expenses/docs/Models/Components/AccountType.md index 938ae1468..1f465068b 100644 --- a/sync-for-expenses/docs/Models/Components/AccountType.md +++ b/sync-for-expenses/docs/Models/Components/AccountType.md @@ -2,6 +2,14 @@ Type of account +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = AccountType.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/AccountingAccount.md b/sync-for-expenses/docs/Models/Components/AccountingAccount.md index 110903295..0545ee0c3 100644 --- a/sync-for-expenses/docs/Models/Components/AccountingAccount.md +++ b/sync-for-expenses/docs/Models/Components/AccountingAccount.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-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/AccountingAddressType.md b/sync-for-expenses/docs/Models/Components/AccountingAddressType.md index 2c5f98c72..d92dee1f2 100644 --- a/sync-for-expenses/docs/Models/Components/AccountingAddressType.md +++ b/sync-for-expenses/docs/Models/Components/AccountingAddressType.md @@ -2,6 +2,14 @@ The type of the address +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = AccountingAddressType.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/AccountingBankAccount.md b/sync-for-expenses/docs/Models/Components/AccountingBankAccount.md index 48141683e..3ce58ea7e 100644 --- a/sync-for-expenses/docs/Models/Components/AccountingBankAccount.md +++ b/sync-for-expenses/docs/Models/Components/AccountingBankAccount.md @@ -22,8 +22,8 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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` | [CreateBankAccountResponseBankAccountType](../../Models/Components/CreateBankAccountResponseBankAccountType.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/sync-for-expenses/docs/Models/Components/AccountingCustomer.md b/sync-for-expenses/docs/Models/Components/AccountingCustomer.md index a555a2341..066b5da1d 100644 --- a/sync-for-expenses/docs/Models/Components/AccountingCustomer.md +++ b/sync-for-expenses/docs/Models/Components/AccountingCustomer.md @@ -14,13 +14,13 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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<[Items](../../Models/Components/Items.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/sync-for-expenses/docs/Models/Components/AccountingSupplier.md b/sync-for-expenses/docs/Models/Components/AccountingSupplier.md index 0dae70bbb..53fe1c6e0 100644 --- a/sync-for-expenses/docs/Models/Components/AccountingSupplier.md +++ b/sync-for-expenses/docs/Models/Components/AccountingSupplier.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-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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<[Items](../../Models/Components/Items.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/sync-for-expenses/docs/Models/Components/AdjustmentTransactionRequest.md b/sync-for-expenses/docs/Models/Components/AdjustmentTransactionRequest.md index 2ad824105..bf67bfeb8 100644 --- a/sync-for-expenses/docs/Models/Components/AdjustmentTransactionRequest.md +++ b/sync-for-expenses/docs/Models/Components/AdjustmentTransactionRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_check_mark: | Your unique identifier for the transaction. | | -| `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-23 00:00:00 +0000 UTC | +| `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 | | `Currency` | *string* | :heavy_check_mark: | Currency the transaction was recorded in. | | | `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. \| | | | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the adjustment transaction. | | diff --git a/sync-for-expenses/docs/Models/Components/BankAccount.md b/sync-for-expenses/docs/Models/Components/BankAccount.md index a21fa6a6e..14d4b9a3c 100644 --- a/sync-for-expenses/docs/Models/Components/BankAccount.md +++ b/sync-for-expenses/docs/Models/Components/BankAccount.md @@ -20,8 +20,8 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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` | [BankAccountType](../../Models/Components/BankAccountType.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/sync-for-expenses/docs/Models/Components/BankAccountStatus.md b/sync-for-expenses/docs/Models/Components/BankAccountStatus.md index 4ae20d422..c27c76e6c 100644 --- a/sync-for-expenses/docs/Models/Components/BankAccountStatus.md +++ b/sync-for-expenses/docs/Models/Components/BankAccountStatus.md @@ -2,6 +2,14 @@ Status of the bank account. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = BankAccountStatus.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/BankAccountType.md b/sync-for-expenses/docs/Models/Components/BankAccountType.md index 422338c05..44266602d 100644 --- a/sync-for-expenses/docs/Models/Components/BankAccountType.md +++ b/sync-for-expenses/docs/Models/Components/BankAccountType.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.Sync.Expenses.Models.Components; + +var value = BankAccountType.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/ClientRateLimitReachedWebhook.md b/sync-for-expenses/docs/Models/Components/ClientRateLimitReachedWebhook.md deleted file mode 100644 index f9688f30c..000000000 --- a/sync-for-expenses/docs/Models/Components/ClientRateLimitReachedWebhook.md +++ /dev/null @@ -1,16 +0,0 @@ -# ClientRateLimitReachedWebhook - -Webhook request body for a client that has reached their rate limit. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `ClientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | -| ~~`RuleId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | -| `RuleType` | *string* | :heavy_minus_sign: | The type of rule. | -| `AlertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `Message` | *string* | :heavy_minus_sign: | A human-readable message about the webhook. | -| `Data` | [ClientRateLimitReachedWebhookData](../../Models/Components/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/ClientRateLimitReachedWebhookData.md b/sync-for-expenses/docs/Models/Components/ClientRateLimitReachedWebhookData.md deleted file mode 100644 index 64767445b..000000000 --- a/sync-for-expenses/docs/Models/Components/ClientRateLimitReachedWebhookData.md +++ /dev/null @@ -1,9 +0,0 @@ -# ClientRateLimitReachedWebhookData - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | -| `ExpiresUtc` | *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-23 00:00:00 +0000 UTC | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/ClientRateLimitResetWebhook.md b/sync-for-expenses/docs/Models/Components/ClientRateLimitResetWebhook.md deleted file mode 100644 index d78d8b131..000000000 --- a/sync-for-expenses/docs/Models/Components/ClientRateLimitResetWebhook.md +++ /dev/null @@ -1,16 +0,0 @@ -# ClientRateLimitResetWebhook - -Webhook request body for a client that has had their rate limit reset. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `ClientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | -| ~~`RuleId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | -| `RuleType` | *string* | :heavy_minus_sign: | The type of rule. | -| `AlertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `Message` | *string* | :heavy_minus_sign: | A human-readable message about the webhook. | -| `Data` | [ClientRateLimitResetWebhookData](../../Models/Components/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/ClientRateLimitWebhook.md b/sync-for-expenses/docs/Models/Components/ClientRateLimitWebhook.md index 6a373aea1..b5ded115e 100644 --- a/sync-for-expenses/docs/Models/Components/ClientRateLimitWebhook.md +++ b/sync-for-expenses/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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/ClientRateLimitWebhookPayload.md b/sync-for-expenses/docs/Models/Components/ClientRateLimitWebhookPayload.md index d055dc184..ba8538894 100644 --- a/sync-for-expenses/docs/Models/Components/ClientRateLimitWebhookPayload.md +++ b/sync-for-expenses/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-23 00:00:00 +0000 UTC | \ 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/sync-for-expenses/docs/Models/Components/Company.md b/sync-for-expenses/docs/Models/Components/Company.md index 9cdcb20a7..dab61d6c1 100644 --- a/sync-for-expenses/docs/Models/Components/Company.md +++ b/sync-for-expenses/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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/CompanyInformation.md b/sync-for-expenses/docs/Models/Components/CompanyInformation.md index 8e3a1583f..58c53db1e 100644 --- a/sync-for-expenses/docs/Models/Components/CompanyInformation.md +++ b/sync-for-expenses/docs/Models/Components/CompanyInformation.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<[Phone](../../Models/Components/Phone.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-23 00:00:00 +0000 UTC | +| `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-23 00:00:00 +0000 UTC | +| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/CompanyInformationPhoneNumbersType.md b/sync-for-expenses/docs/Models/Components/CompanyInformationPhoneNumbersType.md new file mode 100644 index 000000000..59bab60d3 --- /dev/null +++ b/sync-for-expenses/docs/Models/Components/CompanyInformationPhoneNumbersType.md @@ -0,0 +1,22 @@ +# CompanyInformationPhoneNumbersType + +The type of phone number + +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = CompanyInformationPhoneNumbersType.Primary; +``` + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Primary` | Primary | +| `Landline` | Landline | +| `Mobile` | Mobile | +| `Fax` | Fax | +| `Unknown` | Unknown | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/CompanyInformationType.md b/sync-for-expenses/docs/Models/Components/CompanyInformationType.md index 6e5cf5fe1..fd5147e8c 100644 --- a/sync-for-expenses/docs/Models/Components/CompanyInformationType.md +++ b/sync-for-expenses/docs/Models/Components/CompanyInformationType.md @@ -2,6 +2,14 @@ The type of the weblink. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = CompanyInformationType.Website; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/CompanySyncStatus.md b/sync-for-expenses/docs/Models/Components/CompanySyncStatus.md index 32a78136e..c13c76bd8 100644 --- a/sync-for-expenses/docs/Models/Components/CompanySyncStatus.md +++ b/sync-for-expenses/docs/Models/Components/CompanySyncStatus.md @@ -8,8 +8,8 @@ | `CompanyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | d4d73051-ed31-42b6-99f6-d288cd940992 | | `SyncId` | *string* | :heavy_minus_sign: | Unique identifier of the sync. | a6a22aff-a43a-411d-a910-2dae73217cce | | `SyncStatusCode` | *int* | :heavy_minus_sign: | Status code of the sync. | 2000 | -| `SyncStatus` | *string* | :heavy_minus_sign: | Text status of the sync. | Complete | +| `SyncStatus` | *string* | :heavy_minus_sign: | Text status of the sync. | **Example 1:** Complete
**Example 2:** PushError
**Example 3:** Started
**Example 4:** NotStarted
**Example 5:** Pushing | | `ErrorMessage` | *string* | :heavy_minus_sign: | Error message of the sync. | | | `SyncExceptionMessage` | *string* | :heavy_minus_sign: | Exception message of the sync. | | -| `SyncUtc` | *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-23 00:00:00 +0000 UTC | +| `SyncUtc` | *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 | | `DataPushed` | *bool* | :heavy_minus_sign: | Boolean of whether the sync resulted in data being pushed. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/CompanyUpdateRequest.md b/sync-for-expenses/docs/Models/Components/CompanyUpdateRequest.md new file mode 100644 index 000000000..2e5fa23d7 --- /dev/null +++ b/sync-for-expenses/docs/Models/Components/CompanyUpdateRequest.md @@ -0,0 +1,10 @@ +# CompanyUpdateRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `Name` | *string* | :heavy_minus_sign: | Name of company being connected. | Bank of Dave | +| `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. | +| `Tags` | Dictionary | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/Connection.md b/sync-for-expenses/docs/Models/Components/Connection.md index 2f5ebafb1..fbb1ac7e9 100644 --- a/sync-for-expenses/docs/Models/Components/Connection.md +++ b/sync-for-expenses/docs/Models/Components/Connection.md @@ -24,7 +24,7 @@ Before you can use a data connection to pull or push data, the company must gran | `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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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 +| `ConnectionInfo` | Dictionary | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/Contact.md b/sync-for-expenses/docs/Models/Components/Contact.md index 737c66fd5..6ef629011 100644 --- a/sync-for-expenses/docs/Models/Components/Contact.md +++ b/sync-for-expenses/docs/Models/Components/Contact.md @@ -10,4 +10,4 @@ | `Phone` | List<[PhoneNumberItems](../../Models/Components/PhoneNumberItems.md)> | :heavy_minus_sign: | An array of Phone numbers. | | | `Address` | [Items](../../Models/Components/Items.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-23 00:00:00 +0000 UTC | \ 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/sync-for-expenses/docs/Models/Components/CreateAccountResponse.md b/sync-for-expenses/docs/Models/Components/CreateAccountResponse.md index 3da69673f..47d00c1ea 100644 --- a/sync-for-expenses/docs/Models/Components/CreateAccountResponse.md +++ b/sync-for-expenses/docs/Models/Components/CreateAccountResponse.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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/CreateBankAccountResponse.md b/sync-for-expenses/docs/Models/Components/CreateBankAccountResponse.md index 3a8f4e20f..8e2bd0567 100644 --- a/sync-for-expenses/docs/Models/Components/CreateBankAccountResponse.md +++ b/sync-for-expenses/docs/Models/Components/CreateBankAccountResponse.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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/CreateBankAccountResponseBankAccountType.md b/sync-for-expenses/docs/Models/Components/CreateBankAccountResponseBankAccountType.md index 1fa202f19..e5391ff15 100644 --- a/sync-for-expenses/docs/Models/Components/CreateBankAccountResponseBankAccountType.md +++ b/sync-for-expenses/docs/Models/Components/CreateBankAccountResponseBankAccountType.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.Sync.Expenses.Models.Components; + +var value = CreateBankAccountResponseBankAccountType.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/CreateCustomerResponse.md b/sync-for-expenses/docs/Models/Components/CreateCustomerResponse.md index 063806a73..ff2aae97a 100644 --- a/sync-for-expenses/docs/Models/Components/CreateCustomerResponse.md +++ b/sync-for-expenses/docs/Models/Components/CreateCustomerResponse.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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/CreateSupplierResponse.md b/sync-for-expenses/docs/Models/Components/CreateSupplierResponse.md index 372dfabd9..67c7b462e 100644 --- a/sync-for-expenses/docs/Models/Components/CreateSupplierResponse.md +++ b/sync-for-expenses/docs/Models/Components/CreateSupplierResponse.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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/Customer.md b/sync-for-expenses/docs/Models/Components/Customer.md index 5efd32013..d6a6a00a2 100644 --- a/sync-for-expenses/docs/Models/Components/Customer.md +++ b/sync-for-expenses/docs/Models/Components/Customer.md @@ -12,13 +12,13 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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<[Items](../../Models/Components/Items.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/sync-for-expenses/docs/Models/Components/CustomerStatus.md b/sync-for-expenses/docs/Models/Components/CustomerStatus.md index 228196657..59a54f7de 100644 --- a/sync-for-expenses/docs/Models/Components/CustomerStatus.md +++ b/sync-for-expenses/docs/Models/Components/CustomerStatus.md @@ -2,6 +2,14 @@ Status of customer. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = CustomerStatus.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/DataConnectionError.md b/sync-for-expenses/docs/Models/Components/DataConnectionError.md index 48e3b7bbb..2e7779da3 100644 --- a/sync-for-expenses/docs/Models/Components/DataConnectionError.md +++ b/sync-for-expenses/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-23 00:00:00 +0000 UTC | +| `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-23 00:00:00 +0000 UTC | \ 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/sync-for-expenses/docs/Models/Components/DataConnectionStatus.md b/sync-for-expenses/docs/Models/Components/DataConnectionStatus.md index 5d13bea51..62f8cdd66 100644 --- a/sync-for-expenses/docs/Models/Components/DataConnectionStatus.md +++ b/sync-for-expenses/docs/Models/Components/DataConnectionStatus.md @@ -2,6 +2,14 @@ The current authorization status of the data connection. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = DataConnectionStatus.PendingAuth; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/DataStatus.md b/sync-for-expenses/docs/Models/Components/DataStatus.md index c30915d87..800c638ef 100644 --- a/sync-for-expenses/docs/Models/Components/DataStatus.md +++ b/sync-for-expenses/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_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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/DataType.md b/sync-for-expenses/docs/Models/Components/DataType.md index 4f6ed3417..1de84b651 100644 --- a/sync-for-expenses/docs/Models/Components/DataType.md +++ b/sync-for-expenses/docs/Models/Components/DataType.md @@ -2,6 +2,14 @@ Available data types +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = DataType.AccountTransactions; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/DataTypes.md b/sync-for-expenses/docs/Models/Components/DataTypes.md index 3ea6fa56e..c4602f1fd 100644 --- a/sync-for-expenses/docs/Models/Components/DataTypes.md +++ b/sync-for-expenses/docs/Models/Components/DataTypes.md @@ -2,6 +2,14 @@ Available data types +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = DataTypes.AccountTransactions; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/DatasetStatus.md b/sync-for-expenses/docs/Models/Components/DatasetStatus.md index d5bf9440f..9c238e264 100644 --- a/sync-for-expenses/docs/Models/Components/DatasetStatus.md +++ b/sync-for-expenses/docs/Models/Components/DatasetStatus.md @@ -2,6 +2,14 @@ The current status of the dataset. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = DatasetStatus.Initial; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/ErrorStatus.md b/sync-for-expenses/docs/Models/Components/ErrorStatus.md index 9dc662553..9b9eabd01 100644 --- a/sync-for-expenses/docs/Models/Components/ErrorStatus.md +++ b/sync-for-expenses/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.Sync.Expenses.Models.Components; + +var value = ErrorStatus.Active; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/ExpenseContactRefType.md b/sync-for-expenses/docs/Models/Components/ExpenseContactRefType.md index 0ba2c1b19..d456a9be2 100644 --- a/sync-for-expenses/docs/Models/Components/ExpenseContactRefType.md +++ b/sync-for-expenses/docs/Models/Components/ExpenseContactRefType.md @@ -2,6 +2,14 @@ The type of contact. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = ExpenseContactRefType.Supplier; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/ExpenseTransaction.md b/sync-for-expenses/docs/Models/Components/ExpenseTransaction.md index 031da4ea7..6224fe06d 100644 --- a/sync-for-expenses/docs/Models/Components/ExpenseTransaction.md +++ b/sync-for-expenses/docs/Models/Components/ExpenseTransaction.md @@ -7,7 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_check_mark: | Your unique identifier for the transaction. | 4d7c6929-7770-412b-91bb-44d3bc71d111 | | `Type` | [Models.Components.Type](../../Models/Components/Type.md) | :heavy_check_mark: | The type of transaction. | Payment | -| `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-23 00:00:00 +0000 UTC | +| `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: | Currency the transaction was recorded in. | GBP | | `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. \| | | | `ContactRef` | [ExpenseContactRef](../../Models/Components/ExpenseContactRef.md) | :heavy_minus_sign: | N/A | | diff --git a/sync-for-expenses/docs/Models/Components/ExpensesSyncWebhook.md b/sync-for-expenses/docs/Models/Components/ExpensesSyncWebhook.md index c548dc4ad..1958bc600 100644 --- a/sync-for-expenses/docs/Models/Components/ExpensesSyncWebhook.md +++ b/sync-for-expenses/docs/Models/Components/ExpensesSyncWebhook.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. | expenses.sync.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-23 00:00:00 +0000 UTC | +| `EventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** expenses.sync.successful
**Example 2:** expenses.sync.unsuccessful | +| `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` | [ExpensesSyncWebhookPayload](../../Models/Components/ExpensesSyncWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/IntegrationType.md b/sync-for-expenses/docs/Models/Components/IntegrationType.md index 78eb657b0..1c5c26c0a 100644 --- a/sync-for-expenses/docs/Models/Components/IntegrationType.md +++ b/sync-for-expenses/docs/Models/Components/IntegrationType.md @@ -2,6 +2,14 @@ Type of transaction that has been processed e.g. Expense or Bank Feed. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = IntegrationType.Expenses; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/InvoiceToType.md b/sync-for-expenses/docs/Models/Components/InvoiceToType.md index 92ef30fb6..a3ea2358b 100644 --- a/sync-for-expenses/docs/Models/Components/InvoiceToType.md +++ b/sync-for-expenses/docs/Models/Components/InvoiceToType.md @@ -2,6 +2,14 @@ The type of contact. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = InvoiceToType.Customer; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/PhoneNumberType.md b/sync-for-expenses/docs/Models/Components/ItemsType.md similarity index 65% rename from sync-for-expenses/docs/Models/Components/PhoneNumberType.md rename to sync-for-expenses/docs/Models/Components/ItemsType.md index 4d49c6915..0fecb51a6 100644 --- a/sync-for-expenses/docs/Models/Components/PhoneNumberType.md +++ b/sync-for-expenses/docs/Models/Components/ItemsType.md @@ -1,7 +1,15 @@ -# PhoneNumberType +# ItemsType The type of phone number +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = ItemsType.Primary; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/Phone.md b/sync-for-expenses/docs/Models/Components/Phone.md index fc3068bd8..20c262b5f 100644 --- a/sync-for-expenses/docs/Models/Components/Phone.md +++ b/sync-for-expenses/docs/Models/Components/Phone.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `Number` | *string* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | -| `Type` | [PhoneNumberType](../../Models/Components/PhoneNumberType.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` | [CompanyInformationPhoneNumbersType](../../Models/Components/CompanyInformationPhoneNumbersType.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/PhoneNumberItems.md b/sync-for-expenses/docs/Models/Components/PhoneNumberItems.md index dd01427b9..b3af9cc12 100644 --- a/sync-for-expenses/docs/Models/Components/PhoneNumberItems.md +++ b/sync-for-expenses/docs/Models/Components/PhoneNumberItems.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `Number` | *string* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | -| `Type` | [PhoneNumberType](../../Models/Components/PhoneNumberType.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` | [ItemsType](../../Models/Components/ItemsType.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/PropertieDataType.md b/sync-for-expenses/docs/Models/Components/PropertieDataType.md index 1defb94d6..fa837c967 100644 --- a/sync-for-expenses/docs/Models/Components/PropertieDataType.md +++ b/sync-for-expenses/docs/Models/Components/PropertieDataType.md @@ -2,6 +2,14 @@ Available data types +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = PropertieDataType.AccountTransactions; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/PullOperation.md b/sync-for-expenses/docs/Models/Components/PullOperation.md index 9df28d4da..936c87ec5 100644 --- a/sync-for-expenses/docs/Models/Components/PullOperation.md +++ b/sync-for-expenses/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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/PushChangeType.md b/sync-for-expenses/docs/Models/Components/PushChangeType.md index 7585e9c8c..498c0ac92 100644 --- a/sync-for-expenses/docs/Models/Components/PushChangeType.md +++ b/sync-for-expenses/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.Sync.Expenses.Models.Components; + +var value = PushChangeType.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/PushOperation.md b/sync-for-expenses/docs/Models/Components/PushOperation.md index 20f657589..e3a760fb2 100644 --- a/sync-for-expenses/docs/Models/Components/PushOperation.md +++ b/sync-for-expenses/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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/PushOperationStatus.md b/sync-for-expenses/docs/Models/Components/PushOperationStatus.md index 4e041b534..f34308de6 100644 --- a/sync-for-expenses/docs/Models/Components/PushOperationStatus.md +++ b/sync-for-expenses/docs/Models/Components/PushOperationStatus.md @@ -2,6 +2,14 @@ The current status of the push operation. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = PushOperationStatus.Pending; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/PushOptionType.md b/sync-for-expenses/docs/Models/Components/PushOptionType.md index f1bb37088..74da58c92 100644 --- a/sync-for-expenses/docs/Models/Components/PushOptionType.md +++ b/sync-for-expenses/docs/Models/Components/PushOptionType.md @@ -2,6 +2,14 @@ The option type. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = PushOptionType.Array; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/ReimbursableExpenseTransaction.md b/sync-for-expenses/docs/Models/Components/ReimbursableExpenseTransaction.md index b2fd54d99..6de86b007 100644 --- a/sync-for-expenses/docs/Models/Components/ReimbursableExpenseTransaction.md +++ b/sync-for-expenses/docs/Models/Components/ReimbursableExpenseTransaction.md @@ -9,8 +9,8 @@ | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the reimbursable expense. | | | `ContactRef` | [ReimbursementContactRef](../../Models/Components/ReimbursementContactRef.md) | :heavy_check_mark: | N/A | | | `ApAccountRef` | [ApAccountRef](../../Models/Components/ApAccountRef.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-23 00:00:00 +0000 UTC | -| `DueDate` | *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-23 00:00:00 +0000 UTC | +| `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_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: | Currency the transaction was recorded in. | GBP | | `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. \| | | | `Notes` | *string* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | diff --git a/sync-for-expenses/docs/Models/Components/SourceType.md b/sync-for-expenses/docs/Models/Components/SourceType.md index 3ddd34f70..42de0d7c7 100644 --- a/sync-for-expenses/docs/Models/Components/SourceType.md +++ b/sync-for-expenses/docs/Models/Components/SourceType.md @@ -2,6 +2,14 @@ The type of platform of the connection. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = SourceType.Accounting; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/Status.md b/sync-for-expenses/docs/Models/Components/Status.md index c15395bab..860c4a888 100644 --- a/sync-for-expenses/docs/Models/Components/Status.md +++ b/sync-for-expenses/docs/Models/Components/Status.md @@ -2,6 +2,14 @@ The current status of the dataset. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = Status.Initial; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/Supplier.md b/sync-for-expenses/docs/Models/Components/Supplier.md index 82089452e..c088eb402 100644 --- a/sync-for-expenses/docs/Models/Components/Supplier.md +++ b/sync-for-expenses/docs/Models/Components/Supplier.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-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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<[Items](../../Models/Components/Items.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/sync-for-expenses/docs/Models/Components/SupplierStatus.md b/sync-for-expenses/docs/Models/Components/SupplierStatus.md index 328b27e13..67d973034 100644 --- a/sync-for-expenses/docs/Models/Components/SupplierStatus.md +++ b/sync-for-expenses/docs/Models/Components/SupplierStatus.md @@ -2,6 +2,14 @@ Status of the supplier. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = SupplierStatus.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/SyncCompleteWebhook.md b/sync-for-expenses/docs/Models/Components/SyncCompleteWebhook.md deleted file mode 100644 index f01f5fb11..000000000 --- a/sync-for-expenses/docs/Models/Components/SyncCompleteWebhook.md +++ /dev/null @@ -1,17 +0,0 @@ -# SyncCompleteWebhook - -Webhook request body used to notify that a sync has completed. - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `ClientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | -| `CompanyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| ~~`RuleId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | | -| `RuleType` | *string* | :heavy_minus_sign: | The type of rule. | | -| `AlertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `Message` | *string* | :heavy_minus_sign: | A human-readable message about the webhook. | | -| `Data` | [SyncCompleteWebhookData](../../Models/Components/SyncCompleteWebhookData.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/SyncCompleteWebhookData.md b/sync-for-expenses/docs/Models/Components/SyncCompleteWebhookData.md deleted file mode 100644 index 61b661c10..000000000 --- a/sync-for-expenses/docs/Models/Components/SyncCompleteWebhookData.md +++ /dev/null @@ -1,9 +0,0 @@ -# SyncCompleteWebhookData - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `SyncId` | *string* | :heavy_minus_sign: | Unique identifier for the failed sync. | a9367074-b5c3-42c4-9be4-be129f43577e | -| `SyncType` | *string* | :heavy_minus_sign: | The type of sync being performed. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/SyncFailedWebhook.md b/sync-for-expenses/docs/Models/Components/SyncFailedWebhook.md deleted file mode 100644 index 6c412b922..000000000 --- a/sync-for-expenses/docs/Models/Components/SyncFailedWebhook.md +++ /dev/null @@ -1,17 +0,0 @@ -# SyncFailedWebhook - -Webhook request body used to notify that a sync has failed. - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `ClientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | -| `CompanyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| ~~`RuleId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | | -| `RuleType` | *string* | :heavy_minus_sign: | The type of rule. | | -| `AlertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `Message` | *string* | :heavy_minus_sign: | A human-readable message about the webhook. | | -| `Data` | [SyncFailedWebhookData](../../Models/Components/SyncFailedWebhookData.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/SyncFailedWebhookData.md b/sync-for-expenses/docs/Models/Components/SyncFailedWebhookData.md deleted file mode 100644 index e04c5e7e8..000000000 --- a/sync-for-expenses/docs/Models/Components/SyncFailedWebhookData.md +++ /dev/null @@ -1,10 +0,0 @@ -# SyncFailedWebhookData - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `SyncId` | *string* | :heavy_minus_sign: | Unique identifier for the failed sync. | a9367074-b5c3-42c4-9be4-be129f43577e | -| `SyncType` | *string* | :heavy_minus_sign: | The type of sync being performed. | | -| `FailureStage` | *string* | :heavy_minus_sign: | The stage of the job the sync failed. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md b/sync-for-expenses/docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md index 912012980..eef81d0d6 100644 --- a/sync-for-expenses/docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md +++ b/sync-for-expenses/docs/Models/Components/TrackingRefAdjustmentTransactionDataType.md @@ -2,6 +2,14 @@ The type of the linked reference +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = TrackingRefAdjustmentTransactionDataType.TrackingCategories; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/TrackingRefDataType.md b/sync-for-expenses/docs/Models/Components/TrackingRefDataType.md index f361d49c8..dd4325629 100644 --- a/sync-for-expenses/docs/Models/Components/TrackingRefDataType.md +++ b/sync-for-expenses/docs/Models/Components/TrackingRefDataType.md @@ -2,6 +2,14 @@ The type of the linked reference +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = TrackingRefDataType.TrackingCategories; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/TransactionStatus.md b/sync-for-expenses/docs/Models/Components/TransactionStatus.md index 578a3bca5..eb1447f77 100644 --- a/sync-for-expenses/docs/Models/Components/TransactionStatus.md +++ b/sync-for-expenses/docs/Models/Components/TransactionStatus.md @@ -2,6 +2,14 @@ Status of the transaction. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = TransactionStatus.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/TransactionStatus1.md b/sync-for-expenses/docs/Models/Components/TransactionStatus1.md index b19093bc7..033bb3b57 100644 --- a/sync-for-expenses/docs/Models/Components/TransactionStatus1.md +++ b/sync-for-expenses/docs/Models/Components/TransactionStatus1.md @@ -2,6 +2,14 @@ Status of transaction. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = TransactionStatus1.Unknown; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/TransferTransactionRequest.md b/sync-for-expenses/docs/Models/Components/TransferTransactionRequest.md index b859924fc..c0b62814f 100644 --- a/sync-for-expenses/docs/Models/Components/TransferTransactionRequest.md +++ b/sync-for-expenses/docs/Models/Components/TransferTransactionRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `Description` | *string* | :heavy_minus_sign: | Any private, company notes about the transaction. | Transfer from bank account Y to bank account Z | -| `Date` | *string* | :heavy_check_mark: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `From` | [From](../../Models/Components/From.md) | :heavy_check_mark: | N/A | | -| `To` | [To](../../Models/Components/To.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `Description` | *string* | :heavy_minus_sign: | Any private, company notes about the transaction. | Transfer from bank account Y to bank account Z | +| `Date` | *string* | :heavy_check_mark: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `From` | [From](../../Models/Components/From.md) | :heavy_check_mark: | N/A | | +| `To` | [To](../../Models/Components/To.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/Type.md b/sync-for-expenses/docs/Models/Components/Type.md index 87d5be8c2..cd10af446 100644 --- a/sync-for-expenses/docs/Models/Components/Type.md +++ b/sync-for-expenses/docs/Models/Components/Type.md @@ -2,6 +2,14 @@ The type of transaction. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = Type.Payment; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/UpdateCustomerResponse.md b/sync-for-expenses/docs/Models/Components/UpdateCustomerResponse.md index 124a93fc4..498718a9e 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateCustomerResponse.md +++ b/sync-for-expenses/docs/Models/Components/UpdateCustomerResponse.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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md b/sync-for-expenses/docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md index 9f0070ed9..78fb1ed66 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md +++ b/sync-for-expenses/docs/Models/Components/UpdateCustomerResponseAccountingCustomer.md @@ -14,13 +14,13 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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<[Items](../../Models/Components/Items.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/sync-for-expenses/docs/Models/Components/UpdateExpenseRequestType.md b/sync-for-expenses/docs/Models/Components/UpdateExpenseRequestType.md index 1443e2a16..e5091ac19 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateExpenseRequestType.md +++ b/sync-for-expenses/docs/Models/Components/UpdateExpenseRequestType.md @@ -2,6 +2,14 @@ The type of transaction. +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = UpdateExpenseRequestType.Payment; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/UpdateExpenseResponse.md b/sync-for-expenses/docs/Models/Components/UpdateExpenseResponse.md index 5f9d1478a..709b6f8ba 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateExpenseResponse.md +++ b/sync-for-expenses/docs/Models/Components/UpdateExpenseResponse.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `SyncId` | *string* | :heavy_minus_sign: | Unique identifier for the update expense sync. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `SyncId` | *string* | :heavy_minus_sign: | Unique identifier for the update expense sync. | 1ad0695c-4566-4715-918c-adbb03eac81e | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md b/sync-for-expenses/docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md index 7d7676b05..ae88bc8fd 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/Models/Components/UpdateReimbursableExpenseTransactionRequest.md @@ -8,8 +8,8 @@ | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the reimbursable expense. | | | `ContactRef` | [ReimbursementContactRef](../../Models/Components/ReimbursementContactRef.md) | :heavy_check_mark: | N/A | | | `ApAccountRef` | [ApAccountRef](../../Models/Components/ApAccountRef.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-23 00:00:00 +0000 UTC | -| `DueDate` | *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-23 00:00:00 +0000 UTC | +| `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_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: | Currency the transaction was recorded in. | GBP | | `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. \| | | | `Notes` | *string* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | diff --git a/sync-for-expenses/docs/Models/Components/UpdateSupplierResponse.md b/sync-for-expenses/docs/Models/Components/UpdateSupplierResponse.md index 35d273f15..b7336aa3b 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateSupplierResponse.md +++ b/sync-for-expenses/docs/Models/Components/UpdateSupplierResponse.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-23 00:00:00 +0000 UTC | -| `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-23 00:00:00 +0000 UTC | +| `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/sync-for-expenses/docs/Models/Components/UpdateSupplierResponseAccountingSupplier.md b/sync-for-expenses/docs/Models/Components/UpdateSupplierResponseAccountingSupplier.md index 70c870a7a..968346cfe 100644 --- a/sync-for-expenses/docs/Models/Components/UpdateSupplierResponseAccountingSupplier.md +++ b/sync-for-expenses/docs/Models/Components/UpdateSupplierResponseAccountingSupplier.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-23 00:00:00 +0000 UTC | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `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<[Items](../../Models/Components/Items.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/sync-for-expenses/docs/Models/Components/ValidFor.md b/sync-for-expenses/docs/Models/Components/ValidFor.md index 2c38b5425..317f80931 100644 --- a/sync-for-expenses/docs/Models/Components/ValidFor.md +++ b/sync-for-expenses/docs/Models/Components/ValidFor.md @@ -1,5 +1,13 @@ # ValidFor +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = ValidFor.ExpenseTransactionsPayment; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Components/ValidTransactionTypes.md b/sync-for-expenses/docs/Models/Components/ValidTransactionTypes.md index faebe1a23..8b5107f76 100644 --- a/sync-for-expenses/docs/Models/Components/ValidTransactionTypes.md +++ b/sync-for-expenses/docs/Models/Components/ValidTransactionTypes.md @@ -1,5 +1,13 @@ # ValidTransactionTypes +## Example Usage + +```csharp +using Codat.Sync.Expenses.Models.Components; + +var value = ValidTransactionTypes.Payment; +``` + ## Values diff --git a/sync-for-expenses/docs/Models/Requests/CreateAccountResponse.md b/sync-for-expenses/docs/Models/Requests/CreateAccountResponse.md index c80373d60..2ceb00ef1 100644 --- a/sync-for-expenses/docs/Models/Requests/CreateAccountResponse.md +++ b/sync-for-expenses/docs/Models/Requests/CreateAccountResponse.md @@ -8,4 +8,4 @@ | `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 | -| `CreateAccountResponse` | [Models.Components.CreateAccountResponse](../../Models/Components/CreateAccountResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `CreateAccountResponseValue` | [Models.Components.CreateAccountResponse](../../Models/Components/CreateAccountResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/CreateBankAccountResponse.md b/sync-for-expenses/docs/Models/Requests/CreateBankAccountResponse.md index b21283e6a..5a3bea130 100644 --- a/sync-for-expenses/docs/Models/Requests/CreateBankAccountResponse.md +++ b/sync-for-expenses/docs/Models/Requests/CreateBankAccountResponse.md @@ -8,4 +8,4 @@ | `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 | -| `CreateBankAccountResponse` | [Models.Components.CreateBankAccountResponse](../../Models/Components/CreateBankAccountResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `CreateBankAccountResponseValue` | [Models.Components.CreateBankAccountResponse](../../Models/Components/CreateBankAccountResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/CreateCompanyResponse.md b/sync-for-expenses/docs/Models/Requests/CreateCompanyResponse.md index def78685c..ebbbbda7f 100644 --- a/sync-for-expenses/docs/Models/Requests/CreateCompanyResponse.md +++ b/sync-for-expenses/docs/Models/Requests/CreateCompanyResponse.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 | | -| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
}
]
} | \ 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 | | +| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
]
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/CreateCustomerResponse.md b/sync-for-expenses/docs/Models/Requests/CreateCustomerResponse.md index 5c08d6f8d..4449aedab 100644 --- a/sync-for-expenses/docs/Models/Requests/CreateCustomerResponse.md +++ b/sync-for-expenses/docs/Models/Requests/CreateCustomerResponse.md @@ -8,4 +8,4 @@ | `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 | -| `CreateCustomerResponse` | [Models.Components.CreateCustomerResponse](../../Models/Components/CreateCustomerResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `CreateCustomerResponseValue` | [Models.Components.CreateCustomerResponse](../../Models/Components/CreateCustomerResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/CreateSupplierResponse.md b/sync-for-expenses/docs/Models/Requests/CreateSupplierResponse.md index e10b4d398..d721fd9b9 100644 --- a/sync-for-expenses/docs/Models/Requests/CreateSupplierResponse.md +++ b/sync-for-expenses/docs/Models/Requests/CreateSupplierResponse.md @@ -8,4 +8,4 @@ | `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 | -| `CreateSupplierResponse` | [Models.Components.CreateSupplierResponse](../../Models/Components/CreateSupplierResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `CreateSupplierResponseValue` | [Models.Components.CreateSupplierResponse](../../Models/Components/CreateSupplierResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/GetCompanyResponse.md b/sync-for-expenses/docs/Models/Requests/GetCompanyResponse.md index 2151d7b95..816d16523 100644 --- a/sync-for-expenses/docs/Models/Requests/GetCompanyResponse.md +++ b/sync-for-expenses/docs/Models/Requests/GetCompanyResponse.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 | | -| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
}
]
} | \ 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 | | +| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
]
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/GetCustomerRequest.md b/sync-for-expenses/docs/Models/Requests/GetCustomerRequest.md index 1ca255188..a2f1f2d21 100644 --- a/sync-for-expenses/docs/Models/Requests/GetCustomerRequest.md +++ b/sync-for-expenses/docs/Models/Requests/GetCustomerRequest.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/sync-for-expenses/docs/Models/Requests/GetSupplierRequest.md b/sync-for-expenses/docs/Models/Requests/GetSupplierRequest.md index cf887ab10..fd9b1f775 100644 --- a/sync-for-expenses/docs/Models/Requests/GetSupplierRequest.md +++ b/sync-for-expenses/docs/Models/Requests/GetSupplierRequest.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/sync-for-expenses/docs/Models/Requests/ListCompaniesRequest.md b/sync-for-expenses/docs/Models/Requests/ListCompaniesRequest.md index edfdc6b36..350f218c0 100644 --- a/sync-for-expenses/docs/Models/Requests/ListCompaniesRequest.md +++ b/sync-for-expenses/docs/Models/Requests/ListCompaniesRequest.md @@ -3,9 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `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 | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `Tags` | *string* | :heavy_minus_sign: | 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). | region=uk && team=invoice-finance | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/ReplaceCompanyRequest.md b/sync-for-expenses/docs/Models/Requests/ReplaceCompanyRequest.md new file mode 100644 index 000000000..b3b949cbb --- /dev/null +++ b/sync-for-expenses/docs/Models/Requests/ReplaceCompanyRequest.md @@ -0,0 +1,9 @@ +# ReplaceCompanyRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `CompanyRequestBody` | [CompanyRequestBody](../../Models/Components/CompanyRequestBody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Components/ClientRateLimitResetWebhookData.md b/sync-for-expenses/docs/Models/Requests/ReplaceCompanyResponse.md similarity index 79% rename from sync-for-expenses/docs/Models/Components/ClientRateLimitResetWebhookData.md rename to sync-for-expenses/docs/Models/Requests/ReplaceCompanyResponse.md index b6cadb02d..46ff9ecba 100644 --- a/sync-for-expenses/docs/Models/Components/ClientRateLimitResetWebhookData.md +++ b/sync-for-expenses/docs/Models/Requests/ReplaceCompanyResponse.md @@ -1,11 +1,11 @@ -# ClientRateLimitResetWebhookData +# ReplaceCompanyResponse ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `QuotaRemaining` | *long* | :heavy_minus_sign: | Total number of requests remaining for your client. | | -| `ResetReason` | *string* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | -| `DailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | -| `ExpiresUtc` | *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-23 00:00:00 +0000 UTC | \ 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 | | +| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
]
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/UpdateCompanyRequest.md b/sync-for-expenses/docs/Models/Requests/UpdateCompanyRequest.md index 70ad89eee..2351dd6e6 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateCompanyRequest.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateCompanyRequest.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 | -| `CompanyRequestBody` | [CompanyRequestBody](../../Models/Components/CompanyRequestBody.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 | +| `CompanyUpdateRequest` | [CompanyUpdateRequest](../../Models/Components/CompanyUpdateRequest.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/UpdateCompanyResponse.md b/sync-for-expenses/docs/Models/Requests/UpdateCompanyResponse.md index 1605884f0..7df91368d 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateCompanyResponse.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateCompanyResponse.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 | | -| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
}
]
} | \ 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 | | +| `Company` | [Company](../../Models/Components/Company.md) | :heavy_minus_sign: | OK | {
"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"
]
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/UpdateCustomerRequest.md b/sync-for-expenses/docs/Models/Requests/UpdateCustomerRequest.md index a532ecb11..105c6be57 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateCustomerRequest.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateCustomerRequest.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | +| `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 | | `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. | | | `ForceUpdate` | *bool* | :heavy_minus_sign: | 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. | | diff --git a/sync-for-expenses/docs/Models/Requests/UpdateCustomerResponse.md b/sync-for-expenses/docs/Models/Requests/UpdateCustomerResponse.md index 9e7cec120..8bd7b3a32 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateCustomerResponse.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateCustomerResponse.md @@ -8,4 +8,4 @@ | `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 | -| `UpdateCustomerResponse` | [Models.Components.UpdateCustomerResponse](../../Models/Components/UpdateCustomerResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `UpdateCustomerResponseValue` | [Models.Components.UpdateCustomerResponse](../../Models/Components/UpdateCustomerResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md b/sync-for-expenses/docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md index 6665d94c5..88fa50615 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateReimbursableExpenseTransactionRequest.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `TransactionId` | *string* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | -| `UpdateReimbursableExpenseTransactionRequest` | [Models.Components.UpdateReimbursableExpenseTransactionRequest](../../Models/Components/UpdateReimbursableExpenseTransactionRequest.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `UpdateReimbursableExpenseTransactionRequestValue` | [Models.Components.UpdateReimbursableExpenseTransactionRequest](../../Models/Components/UpdateReimbursableExpenseTransactionRequest.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Requests/UpdateSupplierRequest.md b/sync-for-expenses/docs/Models/Requests/UpdateSupplierRequest.md index 885a8af8b..ba6dc9267 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateSupplierRequest.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateSupplierRequest.md @@ -7,7 +7,7 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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 | +| `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 | | `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. | | | `ForceUpdate` | *bool* | :heavy_minus_sign: | 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. | | diff --git a/sync-for-expenses/docs/Models/Requests/UpdateSupplierResponse.md b/sync-for-expenses/docs/Models/Requests/UpdateSupplierResponse.md index 92b834b95..69ca38ca0 100644 --- a/sync-for-expenses/docs/Models/Requests/UpdateSupplierResponse.md +++ b/sync-for-expenses/docs/Models/Requests/UpdateSupplierResponse.md @@ -8,4 +8,4 @@ | `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 | -| `UpdateSupplierResponse` | [Models.Components.UpdateSupplierResponse](../../Models/Components/UpdateSupplierResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `UpdateSupplierResponseValue` | [Models.Components.UpdateSupplierResponse](../../Models/Components/UpdateSupplierResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Webhooks/ClientRateLimitReachedResponse1.md b/sync-for-expenses/docs/Models/Webhooks/ClientRateLimitReachedResponse1.md deleted file mode 100644 index be0a6f609..000000000 --- a/sync-for-expenses/docs/Models/Webhooks/ClientRateLimitReachedResponse1.md +++ /dev/null @@ -1,10 +0,0 @@ -# ClientRateLimitReachedResponse1 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Webhooks/ClientRateLimitResetResponse1.md b/sync-for-expenses/docs/Models/Webhooks/ClientRateLimitResetResponse1.md deleted file mode 100644 index 5a6778e68..000000000 --- a/sync-for-expenses/docs/Models/Webhooks/ClientRateLimitResetResponse1.md +++ /dev/null @@ -1,10 +0,0 @@ -# ClientRateLimitResetResponse1 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Webhooks/SyncCompletedResponse.md b/sync-for-expenses/docs/Models/Webhooks/SyncCompletedResponse.md deleted file mode 100644 index ed04eb894..000000000 --- a/sync-for-expenses/docs/Models/Webhooks/SyncCompletedResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SyncCompletedResponse - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/sync-for-expenses/docs/Models/Webhooks/SyncFailedResponse.md b/sync-for-expenses/docs/Models/Webhooks/SyncFailedResponse.md deleted file mode 100644 index 6422b7e02..000000000 --- a/sync-for-expenses/docs/Models/Webhooks/SyncFailedResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SyncFailedResponse - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/accounts/README.md b/sync-for-expenses/docs/sdks/accounts/README.md index b20010122..a1deef97c 100644 --- a/sync-for-expenses/docs/sdks/accounts/README.md +++ b/sync-for-expenses/docs/sdks/accounts/README.md @@ -1,5 +1,4 @@ # Accounts -(*Accounts*) ## Overview @@ -16,17 +15,17 @@ The *Create account* endpoint creates a new [account](https://docs.codat.io/sync [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. -**Integration-specific behaviour** +**Integration-specific behavior** Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; -using System.Collections.Generic; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -39,10 +38,10 @@ CreateAccountRequest req = new CreateAccountRequest() { Description = "Invoices the business has issued but has not yet collected payment on.", FullyQualifiedCategory = "Asset.Current", FullyQualifiedName = "Cash On Hand", - Currency = "USD", + Currency = "GBP", CurrentBalance = 0M, - Type = Codat.Sync.Expenses.Models.Components.AccountType.Asset, - Status = Codat.Sync.Expenses.Models.Components.AccountStatus.Active, + Type = AccountType.Asset, + Status = AccountStatus.Active, }, }; @@ -65,7 +64,8 @@ var res = await sdk.Accounts.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## GetCreateModel @@ -74,16 +74,188 @@ The *Get create account model* endpoint returns the expected data for the reques [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. -**Integration-specific behaviour** +**Integration-specific behavior** See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -111,5 +283,6 @@ var res = await sdk.Accounts.GetCreateModelAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/adjustments/README.md b/sync-for-expenses/docs/sdks/adjustments/README.md index 2d8639660..891412621 100644 --- a/sync-for-expenses/docs/sdks/adjustments/README.md +++ b/sync-for-expenses/docs/sdks/adjustments/README.md @@ -1,5 +1,4 @@ # Adjustments -(*Adjustments*) ## Overview @@ -21,13 +20,14 @@ Adjustments represent write-offs and transaction alterations, such as foreign ex |-----------------------|-----------| | QuickBooks Desktop | Yes | -### Example Usage +### Example Usage: Create adjustment + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; -using Codat.Sync.Expenses.Models.Components; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -35,25 +35,38 @@ CreateAdjustmentTransactionRequest req = new CreateAdjustmentTransactionRequest( CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", RequestBody = new List() { new AdjustmentTransactionRequest() { - Id = "7a621cf0-21cd-49cf-8540-3315211a509a", - Date = "2022-10-23T00:00:00Z", - Currency = "Moroccan Dirham", + Id = "3357b3df-5f2e-465d-b9ba-226519dbb8f1", + Date = "2024-05-21T00:00:00+00:00", + Currency = "USD", + CurrencyRate = 1M, + Reference = "test reference", Lines = new List() { new AdjustmentTransactionLine() { Amount = 50M, AccountRef = new RecordRef() { - Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + Id = "80000018-1671793811", }, - Description = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + Description = "debit line", TrackingRefs = new List() { new TrackingRefAdjustmentTransaction() { - Id = "e9a1b63d-9ff0-40e7-8038-016354b987e6", - DataType = Codat.Sync.Expenses.Models.Components.TrackingRefAdjustmentTransactionDataType.TrackingCategories, + Id = "80000003-1674553958", }, }, InvoiceTo = new InvoiceTo() { Id = "80000002-1674552702", - Type = Codat.Sync.Expenses.Models.Components.InvoiceToType.Customer, + Type = InvoiceToType.Customer, + }, + }, + new AdjustmentTransactionLine() { + Amount = -50M, + AccountRef = new RecordRef() { + Id = "80000028-1671794219", + }, + Description = "credit line", + TrackingRefs = new List() { + new TrackingRefAdjustmentTransaction() { + Id = "80000003-1674553958", + }, }, }, }, @@ -63,6 +76,60 @@ CreateAdjustmentTransactionRequest req = new CreateAdjustmentTransactionRequest( var res = await sdk.Adjustments.CreateAsync(req); +// handle response +``` +### Example Usage: Example 1 + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateAdjustmentTransactionRequest req = new CreateAdjustmentTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new AdjustmentTransactionRequest() { + Id = "6a13b8cf-d482-4389-9f93-08d52faa3dc0", + Date = "2022-10-23T00:00:00Z", + Currency = "Lilangeni", + Lines = new List() {}, + }, + }, +}; + +var res = await sdk.Adjustments.CreateAsync(req); + +// handle response +``` +### Example Usage: Malformed query + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateAdjustmentTransactionRequest req = new CreateAdjustmentTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new AdjustmentTransactionRequest() { + Id = "6a13b8cf-d482-4389-9f93-08d52faa3dc0", + Date = "2022-10-23T00:00:00Z", + Currency = "Lilangeni", + Lines = new List() {}, + }, + }, +}; + +var res = await sdk.Adjustments.CreateAsync(req); + // handle response ``` @@ -80,5 +147,6 @@ var res = await sdk.Adjustments.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/attachments/README.md b/sync-for-expenses/docs/sdks/attachments/README.md index d571f0eae..e7e763e94 100644 --- a/sync-for-expenses/docs/sdks/attachments/README.md +++ b/sync-for-expenses/docs/sdks/attachments/README.md @@ -1,5 +1,4 @@ # Attachments -(*Attachments*) ## Overview @@ -15,25 +14,27 @@ The *Upload attachment* endpoint uploads an attachment in the accounting softwar [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. -**Integration-specific behaviour** +**Integration-specific behavior** Each accounting software supports different file formats and sizes. -| Integration | File size | File extension |Supported transaction type -|-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| -| **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | -| **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` | -| **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` | -| **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types -| **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | -| **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF +| Integration | File size | File extension | Supported transactions | +|-----------------------------------|-----------|-------------------------------------------------------|------------------------| +| **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | +| **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `expense-transactions.Payment`, `expense-transactions.Refund`, `reimbursable-expense-transactions` | +| **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`expense-transactions.Payment`, `expense-transactions.Refund` | +| **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types +| **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | +| **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` +| **Zoho Books** | 5MB | GIF, PNG, JPEG, JPG, BMP, PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` | ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -62,5 +63,6 @@ var res = await sdk.Attachments.UploadAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/bankaccounts/README.md b/sync-for-expenses/docs/sdks/bankaccounts/README.md index fbdc35e50..430f460bb 100644 --- a/sync-for-expenses/docs/sdks/bankaccounts/README.md +++ b/sync-for-expenses/docs/sdks/bankaccounts/README.md @@ -1,5 +1,4 @@ # BankAccounts -(*BankAccounts*) ## Overview @@ -12,21 +11,21 @@ Create bank accounts and view create bank account options. ## Create -The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company's connection. - -[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. - -**Integration-specific behaviour** - +The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company's connection. + +[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + +**Integration-specific behavior** + Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model). -### Example Usage +### Example Usage: Malformed query + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; -using System.Collections.Generic; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -36,8 +35,61 @@ CreateBankAccountRequest req = new CreateBankAccountRequest() { BankAccount = new BankAccount() { ModifiedDate = "2022-10-23T00:00:00Z", SourceModifiedDate = "2022-10-23T00:00:00Z", - Currency = "USD", - Status = Codat.Sync.Expenses.Models.Components.BankAccountStatus.Active, + Currency = "GBP", + Status = BankAccountStatus.Active, + }, +}; + +var res = await sdk.BankAccounts.CreateAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateBankAccountRequest req = new CreateBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + BankAccount = new BankAccount() { + AccountName = "GBP Bank Account", + AccountType = BankAccountType.Debit, + AccountNumber = "12345678", + Currency = "GBP", + Status = BankAccountStatus.Active, + }, +}; + +var res = await sdk.BankAccounts.CreateAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateBankAccountRequest req = new CreateBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + BankAccount = new BankAccount() { + AccountName = "Xero GBP Bank Account", + AccountType = BankAccountType.Debit, + SortCode = "445566", + AccountNumber = "12345678", + Currency = "GBP", + Status = BankAccountStatus.Active, }, }; @@ -60,26 +112,180 @@ var res = await sdk.BankAccounts.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## GetCreateModel -The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company and integration. - -[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. - -**Integration-specific behaviour** - -See the *response examples* for integration-specific indicative models. +The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company and integration. + +[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + +**Integration-specific behavior** + +See the *response examples* for integration-specific indicative models. + + +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; -### Example Usage +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: KashFlow + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateBankAccountsModelRequest req = new GetCreateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.BankAccounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -107,5 +313,6 @@ var res = await sdk.BankAccounts.GetCreateModelAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md b/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md deleted file mode 100644 index e86931ee9..000000000 --- a/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# CodatSyncExpenses SDK - -## Overview - -Sync for Expenses: The API for Sync for Expenses. - -Sync for Expenses is an API and a set of supporting tools. It has been built to -enable corporate card and expense management platforms to provide high-quality -integrations with multiple accounting software through a standardized API. - -[Explore product](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) - -Not seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). - ---- - -## Endpoints - -| Endpoints | Description | -| :- |:- | -| Companies | Create and manage your SMB users' companies. | -| Connections | Create new and manage existing data connections for a company. | -| Configuration | View and manage mapping configuration and defaults for expense transactions. | -| Sync | Monitor the status of data syncs. | -| Expenses | Create and update transactions that represent your customers' spend. | -| Transfers | Create and update transactions that represent the movement of your customers' money. | -| Reimbursements | Create and update transactions that represent your customers' repayable spend. | -| Attachments | Attach receipts to a transaction for a complete audit trail. | -| Transaction status | Monitor the status of individual transactions in data syncs. | -| Manage data | Control and monitor the retrieval of data from an integration. | -| Push operations | View historic push operations. | -| Accounts | Create accounts and view account schemas. | -| Customers | Get, create, and update customers. | -| Suppliers | Get, create, and update suppliers. | - - -### Available Operations diff --git a/sync-for-expenses/docs/sdks/companies/README.md b/sync-for-expenses/docs/sdks/companies/README.md index 42a37b927..873f291b9 100644 --- a/sync-for-expenses/docs/sdks/companies/README.md +++ b/sync-for-expenses/docs/sdks/companies/README.md @@ -1,5 +1,4 @@ # Companies -(*Companies*) ## Overview @@ -9,6 +8,7 @@ Create and manage your SMB users' companies. * [List](#list) - List companies * [Create](#create) - Create company +* [Replace](#replace) - Replace company * [Update](#update) - Update company * [Delete](#delete) - Delete a company * [Get](#get) - Get company @@ -20,20 +20,53 @@ Create and manage your SMB users' companies. A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. -### Example Usage +## Filter by tags + +The *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): + +- equals (`=`) +- not equals (`!=`) +- contains (`~`) + +For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: +- Foreign key: `uid = {yourCustomerId}` +- Region: `region != uk` +- Owning team and region: `region = uk && owningTeam = invoice-finance` +### Example Usage: List of Companies + + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListCompaniesRequest req = new ListCompaniesRequest() { - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", }; var res = await sdk.Companies.ListAsync(req); @@ -55,7 +88,8 @@ var res = await sdk.Companies.ListAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Create @@ -67,12 +101,48 @@ Each company can have multiple [connections](https://docs.codat.io/sync-for-expe 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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; -using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -83,6 +153,23 @@ CompanyRequestBody req = new CompanyRequestBody() { var res = await sdk.Companies.CreateAsync(req); +// handle response +``` +### Example Usage: With no description + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CompanyRequestBody req = new CompanyRequestBody() { + Name = "Technicalium", +}; + +var res = await sdk.Companies.CreateAsync(req); + // handle response ``` @@ -100,29 +187,122 @@ var res = await sdk.Companies.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | -## Update +## Replace -Use the *Update company* endpoint to update both the name and description of the company. +Use 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. A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero 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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; -using System.Collections.Generic; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -UpdateCompanyRequest req = new UpdateCompanyRequest() { +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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ReplaceCompanyRequest req = new ReplaceCompanyRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", CompanyRequestBody = new CompanyRequestBody() { + Name = "New Name", + }, +}; + +var res = await sdk.Companies.ReplaceAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `request` | [ReplaceCompanyRequest](../../Models/Requests/ReplaceCompanyRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ReplaceCompanyResponse](../../Models/Requests/ReplaceCompanyResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Update + +Use the *Update company* endpoint to update the name, description, or tags of the company. + +The *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. + +A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. + +### Example Usage: Unauthorized + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.", }, @@ -130,6 +310,51 @@ UpdateCompanyRequest req = new UpdateCompanyRequest() { var res = await sdk.Companies.UpdateAsync(req); +// handle response +``` +### Example Usage: Update name + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +UpdateCompanyRequest req = new UpdateCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CompanyUpdateRequest = new CompanyUpdateRequest() { + Tags = new Dictionary() { + { "refrence", "new reference" }, + }, + }, +}; + +var res = await sdk.Companies.UpdateAsync(req); + // handle response ``` @@ -147,7 +372,8 @@ var res = await sdk.Companies.UpdateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Delete @@ -160,10 +386,11 @@ Each company can have multiple [connections](https://docs.codat.io/sync-for-expe ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -190,7 +417,8 @@ var res = await sdk.Companies.DeleteAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Get @@ -201,12 +429,49 @@ A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) repres Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero 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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -233,5 +498,6 @@ var res = await sdk.Companies.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/companyinfo/README.md b/sync-for-expenses/docs/sdks/companyinfo/README.md index beb25694f..b8b82cb8e 100644 --- a/sync-for-expenses/docs/sdks/companyinfo/README.md +++ b/sync-for-expenses/docs/sdks/companyinfo/README.md @@ -1,5 +1,4 @@ # CompanyInfo -(*CompanyInfo*) ## Overview @@ -15,10 +14,11 @@ Gets the latest basic info for a company. ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -45,5 +45,6 @@ var res = await sdk.CompanyInfo.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/configuration/README.md b/sync-for-expenses/docs/sdks/configuration/README.md index 16b3c9dd7..c2136029e 100644 --- a/sync-for-expenses/docs/sdks/configuration/README.md +++ b/sync-for-expenses/docs/sdks/configuration/README.md @@ -1,5 +1,4 @@ # Configuration -(*Configuration*) ## Overview @@ -16,10 +15,11 @@ Gets a company's expense sync configuration ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -46,7 +46,8 @@ var res = await sdk.Configuration.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Set @@ -55,10 +56,11 @@ Sets a company's expense sync configuration ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -92,5 +94,6 @@ var res = await sdk.Configuration.SetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/connections/README.md b/sync-for-expenses/docs/sdks/connections/README.md index 4fd5a39b6..ea152ea33 100644 --- a/sync-for-expenses/docs/sdks/connections/README.md +++ b/sync-for-expenses/docs/sdks/connections/README.md @@ -1,5 +1,4 @@ # Connections -(*Connections*) ## Overview @@ -20,17 +19,16 @@ Create new and manage existing data connections for a company. ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListConnectionsRequest req = new ListConnectionsRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", }; @@ -54,7 +52,8 @@ var res = await sdk.Connections.ListAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Create @@ -63,12 +62,34 @@ 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.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(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.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -98,7 +119,8 @@ var res = await sdk.Connections.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Get @@ -107,10 +129,11 @@ var res = await sdk.Connections.CreateAsync(req); ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -138,7 +161,8 @@ var res = await sdk.Connections.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Delete @@ -148,10 +172,11 @@ This operation is not reversible. The end user would need to reauthorize a new d ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -179,7 +204,8 @@ var res = await sdk.Connections.DeleteAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Unlink @@ -188,16 +214,20 @@ var res = await sdk.Connections.DeleteAsync(req); ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); UnlinkConnectionRequest req = new UnlinkConnectionRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + RequestBody = new UnlinkConnectionUpdateConnection() { + Status = DataConnectionStatus.Unlinked, + }, }; var res = await sdk.Connections.UnlinkAsync(req); @@ -219,7 +249,8 @@ var res = await sdk.Connections.UnlinkAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## CreatePartnerExpenseConnection @@ -228,10 +259,11 @@ Creates a partner expense data connection ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -258,5 +290,6 @@ var res = await sdk.Connections.CreatePartnerExpenseConnectionAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/customers/README.md b/sync-for-expenses/docs/sdks/customers/README.md index deab65a3a..31f8b56bc 100644 --- a/sync-for-expenses/docs/sdks/customers/README.md +++ b/sync-for-expenses/docs/sdks/customers/README.md @@ -1,5 +1,4 @@ # Customers -(*Customers*) ## Overview @@ -21,66 +20,730 @@ 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/sync-for-expenses-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCustomersRequest req = new ListCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Customers.ListAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `request` | [ListCustomersRequest](../../Models/Requests/ListCustomersRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListCustomersResponse](../../Models/Requests/ListCustomersResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get customer* endpoint returns a single customer for a given customerId. + +[Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). + + +### Example Usage: Clear Books + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -ListCustomersRequest req = new ListCustomersRequest() { +GetCustomerRequest req = new GetCustomerRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - Page = 1, - PageSize = 100, - Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", - OrderBy = "-modifiedDate", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", }; -var res = await sdk.Customers.ListAsync(req); +var res = await sdk.Customers.GetAsync(req); // handle response ``` +### Example Usage: FreeAgent -### Parameters + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `request` | [ListCustomersRequest](../../Models/Requests/ListCustomersRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -**[ListCustomersResponse](../../Models/Requests/ListCustomersResponse.md)** +var res = await sdk.Customers.GetAsync(req); -### Errors +// handle response +``` +### Example Usage: FreshBooks -| Error Type | Status Code | Content Type | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429, 500, 503 | application/json | -| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; -## Get +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get customer* endpoint returns a single customer for a given customerId. +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -[Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +var res = await sdk.Customers.GetAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Example Usage +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCustomerRequest req = new GetCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); GetCustomerRequest req = new GetCustomerRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - CustomerId = "7110701885", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", }; var res = await sdk.Customers.GetAsync(req); @@ -102,7 +765,8 @@ var res = await sdk.Customers.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Create @@ -111,16 +775,17 @@ The *Create customer* endpoint creates a new [customer](https://docs.codat.io/sy [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. -**Integration-specific behaviour** +**Integration-specific behavior** Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -131,20 +796,15 @@ CreateCustomerRequest req = new CreateCustomerRequest() { Customer = new Customer() { ModifiedDate = "2022-10-23T00:00:00Z", SourceModifiedDate = "2022-10-23T00:00:00Z", - DefaultCurrency = "USD", + DefaultCurrency = "GBP", Contacts = new List() { new Contact() { - Phone = new List() { - new PhoneNumberItems() { - Number = "+44 25691 154789", - Type = Codat.Sync.Expenses.Models.Components.PhoneNumberType.Primary, - }, - }, - Status = Codat.Sync.Expenses.Models.Components.CustomerStatus.Archived, + Phone = null, + Status = CustomerStatus.Unknown, ModifiedDate = "2022-10-23T00:00:00Z", }, }, - Status = Codat.Sync.Expenses.Models.Components.CustomerStatus.Unknown, + Status = CustomerStatus.Unknown, }, }; @@ -167,7 +827,8 @@ var res = await sdk.Customers.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Update @@ -176,16 +837,17 @@ The *Update customer* endpoint updates an existing [customer](https://docs.codat [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. -**Integration-specific behaviour** +**Integration-specific behavior** Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -193,24 +855,24 @@ var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); UpdateCustomerRequest req = new UpdateCustomerRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", - CustomerId = "EILBDVJVNUAGVKRQ", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", Customer = new Customer() { ModifiedDate = "2022-10-23T00:00:00Z", SourceModifiedDate = "2022-10-23T00:00:00Z", - DefaultCurrency = "EUR", + DefaultCurrency = "GBP", Contacts = new List() { new Contact() { Phone = new List() { new PhoneNumberItems() { - Number = "(877) 492-8687", - Type = Codat.Sync.Expenses.Models.Components.PhoneNumberType.Mobile, + Number = "+44 25691 154789", + Type = ItemsType.Primary, }, }, - Status = Codat.Sync.Expenses.Models.Components.CustomerStatus.Archived, + Status = CustomerStatus.Unknown, ModifiedDate = "2022-10-23T00:00:00Z", }, }, - Status = Codat.Sync.Expenses.Models.Components.CustomerStatus.Archived, + Status = CustomerStatus.Active, }, }; @@ -233,5 +895,6 @@ var res = await sdk.Customers.UpdateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/expenses/README.md b/sync-for-expenses/docs/sdks/expenses/README.md index f5cade5ae..6375e0110 100644 --- a/sync-for-expenses/docs/sdks/expenses/README.md +++ b/sync-for-expenses/docs/sdks/expenses/README.md @@ -1,5 +1,4 @@ # Expenses -(*Expenses*) ## Overview @@ -25,15 +24,19 @@ The *Create expense* endpoint creates an [expense transaction](https://docs.coda | QuickBooks Desktop | Yes | | QuickBooks Online | Yes | | Oracle NetSuite | Yes | +| Sage Intacct | Yes | | Xero | Yes | +| Zoho Books | Yes | -### Example Usage +### Example Usage: Example 1 + + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; -using Codat.Sync.Expenses.Models.Components; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -48,7 +51,6 @@ CreateExpenseTransactionRequest req = new CreateExpenseTransactionRequest() { CurrencyRate = 1M, ContactRef = new ExpenseContactRef() { Id = "430", - Type = Codat.Sync.Expenses.Models.Components.ExpenseContactRefType.Supplier, }, BankAccountRef = new BankAccountReference() { Id = "97", @@ -68,13 +70,69 @@ CreateExpenseTransactionRequest req = new CreateExpenseTransactionRequest() { new TrackingRef() { Id = "DEPARTMENT_3", }, + new TrackingRef() {}, + }, + InvoiceTo = new InvoiceTo() { + Id = "504", + Type = InvoiceToType.Customer, + }, + }, + }, + Notes = "amazon purchase", + }, + }, +}; + +var res = await sdk.Expenses.CreateAsync(req); + +// handle response +``` +### Example Usage: Malformed query + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateExpenseTransactionRequest req = new CreateExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new ExpenseTransaction() { + Id = "a44135b0-6882-489a-83fe-a0c57a4afb19", + Type = Codat.Sync.Expenses.Models.Components.Type.Payment, + IssueDate = "2024-05-21T00:00:00+00:00", + Currency = "GBP", + CurrencyRate = 1M, + ContactRef = new ExpenseContactRef() { + Id = "430", + }, + BankAccountRef = new BankAccountReference() { + Id = "97", + }, + MerchantName = "Amazon UK", + Lines = new List() { + new ExpenseTransactionLine() { + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "23_Bills", + }, + AccountRef = new RecordRef() { + Id = "35", + }, + TrackingRefs = new List() { new TrackingRef() { - DataType = Codat.Sync.Expenses.Models.Components.TrackingRefDataType.TrackingCategories, + Id = "DEPARTMENT_3", }, + new TrackingRef() {}, }, InvoiceTo = new InvoiceTo() { Id = "504", - Type = Codat.Sync.Expenses.Models.Components.InvoiceToType.Customer, + Type = InvoiceToType.Customer, }, }, }, @@ -85,6 +143,115 @@ CreateExpenseTransactionRequest req = new CreateExpenseTransactionRequest() { var res = await sdk.Expenses.CreateAsync(req); +// handle response +``` +### Example Usage: Payment + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateExpenseTransactionRequest req = new CreateExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new ExpenseTransaction() { + Id = "4d7c6929-7770-412b-91bb-44d3bc71d111", + Type = Codat.Sync.Expenses.Models.Components.Type.Payment, + IssueDate = "2024-05-21T00:00:00+00:00", + Currency = "GBP", + CurrencyRate = 1M, + ContactRef = new ExpenseContactRef() { + Id = "430", + }, + BankAccountRef = new BankAccountReference() { + Id = "97", + }, + MerchantName = "Amazon UK", + Lines = new List() { + new ExpenseTransactionLine() { + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "23_Bills", + }, + AccountRef = new RecordRef() { + Id = "35", + }, + TrackingRefs = new List() { + new TrackingRef() { + Id = "DEPARTMENT_5", + }, + }, + InvoiceTo = new InvoiceTo() { + Id = "504", + Type = InvoiceToType.Customer, + }, + }, + }, + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + }, + }, +}; + +var res = await sdk.Expenses.CreateAsync(req); + +// handle response +``` +### Example Usage: Refund + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateExpenseTransactionRequest req = new CreateExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new ExpenseTransaction() { + Id = "7008d3f2-aeb4-11ed-afa1-0242ac120002", + Type = Codat.Sync.Expenses.Models.Components.Type.Refund, + IssueDate = "2024-02-17T00:00:00+00:00", + Currency = "GBP", + ContactRef = new ExpenseContactRef() { + Id = "430", + }, + BankAccountRef = new BankAccountReference() { + Id = "97", + }, + MerchantName = "Amazon UK", + Lines = new List() { + new ExpenseTransactionLine() { + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "23_Bills", + }, + AccountRef = new RecordRef() { + Id = "42", + }, + TrackingRefs = new List() { + new TrackingRef() { + Id = "DEPARTMENT_6", + }, + }, + }, + }, + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + }, + }, +}; + +var res = await sdk.Expenses.CreateAsync(req); + // handle response ``` @@ -102,7 +269,8 @@ var res = await sdk.Expenses.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Update @@ -111,21 +279,31 @@ The *Update expense* endpoint updates an existing [expense transaction](https:// [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. -### Supported Integrations +### Supported integrations The following integrations are supported for the [Payment](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) transaction `type` only: | Integration | Supported | |-----------------------|-----------| | FreeAgent | Yes | +| QuickBooks Desktop | Yes | | QuickBooks Online | Yes | | Oracle NetSuite | Yes | +| Sage Intacct | Yes | | Xero | Yes | +| Zoho Books | Yes | + +#### Integration-specific behavior + +| Integration | Specifics | +|-----------------------|-----------| +| Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.| -### Example Usage +### Example Usage: Malformed query + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -134,12 +312,11 @@ UpdateExpenseTransactionRequest req = new UpdateExpenseTransactionRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", UpdateExpenseRequest = new UpdateExpenseRequest() { - Type = Codat.Sync.Expenses.Models.Components.UpdateExpenseRequestType.Payment, + Type = UpdateExpenseRequestType.Payment, IssueDate = "2022-06-28T00:00:00.000Z", Currency = "GBP", ContactRef = new ExpenseContactRef() { Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", - Type = Codat.Sync.Expenses.Models.Components.ExpenseContactRefType.Supplier, }, BankAccountRef = new UpdateExpenseRequestBankAccountReference() { Id = "787dfb37-5707-4dc0-8a86-8d74e4cc78ea", @@ -155,18 +332,63 @@ UpdateExpenseTransactionRequest req = new UpdateExpenseTransactionRequest() { AccountRef = new RecordRef() { Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", }, - ItemRef = new ItemRef() { - Id = "80000002-1675158984", + ItemRef = null, + TrackingRefs = null, + InvoiceTo = null, + }, + }, + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + }, +}; + +var res = await sdk.Expenses.UpdateAsync(req); + +// handle response +``` +### Example Usage: Payment + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +UpdateExpenseTransactionRequest req = new UpdateExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", + UpdateExpenseRequest = new UpdateExpenseRequest() { + Type = UpdateExpenseRequestType.Payment, + IssueDate = "2024-05-21T00:00:00+00:00", + Currency = "GBP", + CurrencyRate = 1M, + ContactRef = new ExpenseContactRef() { + Id = "430", + }, + BankAccountRef = new UpdateExpenseRequestBankAccountReference() { + Id = "97", + }, + MerchantName = "Amazon UK", + Lines = new List() { + new ExpenseTransactionLine() { + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "23_Bills", + }, + AccountRef = new RecordRef() { + Id = "35", }, TrackingRefs = new List() { new TrackingRef() { - Id = "e9a1b63d-9ff0-40e7-8038-016354b987e6", - DataType = Codat.Sync.Expenses.Models.Components.TrackingRefDataType.TrackingCategories, + Id = "DEPARTMENT_5", }, }, InvoiceTo = new InvoiceTo() { - Id = "80000002-1674552702", - Type = Codat.Sync.Expenses.Models.Components.InvoiceToType.Customer, + Id = "504", + Type = InvoiceToType.Customer, }, }, }, @@ -193,5 +415,6 @@ var res = await sdk.Expenses.UpdateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 422, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 422, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/managedata/README.md b/sync-for-expenses/docs/sdks/managedata/README.md index fb2de2a96..0bd0ed6df 100644 --- a/sync-for-expenses/docs/sdks/managedata/README.md +++ b/sync-for-expenses/docs/sdks/managedata/README.md @@ -1,5 +1,4 @@ # ManageData -(*ManageData*) ## Overview @@ -23,10 +22,11 @@ This is an asynchronous operation, and will bring updated data into Codat from t ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -53,7 +53,8 @@ var res = await sdk.ManageData.RefreshAllDataTypesAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Get @@ -62,10 +63,11 @@ Get the state of each data type for a company ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -92,7 +94,8 @@ var res = await sdk.ManageData.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## RefreshDataType @@ -103,16 +106,17 @@ This is an asynchronous operation, and will bring updated data into Codat from t ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); RefreshDataTypeRequest req = new RefreshDataTypeRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - DataType = Codat.Sync.Expenses.Models.Components.DataType.Invoices, + DataType = DataType.Invoices, }; var res = await sdk.ManageData.RefreshDataTypeAsync(req); @@ -134,7 +138,8 @@ var res = await sdk.ManageData.RefreshDataTypeAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## ListPullOperations @@ -143,17 +148,16 @@ Gets the pull operation history (datasets) for a given company. ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListPullOperationsRequest req = new ListPullOperationsRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", }; @@ -177,7 +181,8 @@ var res = await sdk.ManageData.ListPullOperationsAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## GetPullOperation @@ -186,16 +191,17 @@ Retrieve information about a single dataset or pull operation. ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); GetPullOperationRequest req = new GetPullOperationRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - DatasetId = "71a4c0fb-8e15-45bd-958d-330b4e6e9f07", + DatasetId = "fa5f3e86-bd80-49b8-853c-5fbba4b201f5", }; var res = await sdk.ManageData.GetPullOperationAsync(req); @@ -217,5 +223,6 @@ var res = await sdk.ManageData.GetPullOperationAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/mappingoptions/README.md b/sync-for-expenses/docs/sdks/mappingoptions/README.md index f8ecb6b94..9cf999c86 100644 --- a/sync-for-expenses/docs/sdks/mappingoptions/README.md +++ b/sync-for-expenses/docs/sdks/mappingoptions/README.md @@ -1,5 +1,4 @@ # MappingOptions -(*MappingOptions*) ## Overview @@ -15,10 +14,11 @@ Gets the mapping options (accounts, trackingCategories and taxRates) for a compa ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -45,5 +45,6 @@ var res = await sdk.MappingOptions.GetMappingOptionsAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/pushoperations/README.md b/sync-for-expenses/docs/sdks/pushoperations/README.md index 60ccede46..74145cdc0 100644 --- a/sync-for-expenses/docs/sdks/pushoperations/README.md +++ b/sync-for-expenses/docs/sdks/pushoperations/README.md @@ -1,5 +1,4 @@ # PushOperations -(*PushOperations*) ## Overview @@ -16,17 +15,16 @@ List push operation records. ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListPushOperationsRequest req = new ListPushOperationsRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - Page = 1, - PageSize = 100, Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", OrderBy = "-modifiedDate", }; @@ -50,7 +48,8 @@ var res = await sdk.PushOperations.ListAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Get @@ -59,16 +58,17 @@ Retrieve push operation. ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); GetPushOperationRequest req = new GetPushOperationRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - PushOperationKey = "b888f774-3e7c-4135-a18c-6b985523c4bc", + PushOperationKey = "660e8684-c0fb-4468-9e2a-b2e3b115d747", }; var res = await sdk.PushOperations.GetAsync(req); @@ -90,5 +90,6 @@ var res = await sdk.PushOperations.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/reimbursements/README.md b/sync-for-expenses/docs/sdks/reimbursements/README.md index 456ab7359..fdbb24404 100644 --- a/sync-for-expenses/docs/sdks/reimbursements/README.md +++ b/sync-for-expenses/docs/sdks/reimbursements/README.md @@ -1,5 +1,4 @@ # Reimbursements -(*Reimbursements*) ## Overview @@ -12,25 +11,83 @@ Create and update transactions that represent your customers' repayable spend. ## Create -Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection. - -[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform). - -### Supported Integrations -| Integration | Supported | -|-----------------------|-----------| -| FreeAgent | Yes | -| QuickBooks Desktop | Yes | -| QuickBooks Online | Yes | +Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection. + +[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform). + +### Supported Integrations +| Integration | Supported | +|-----------------------|-----------| +| FreeAgent | Yes | +| QuickBooks Desktop | Yes | +| QuickBooks Online | Yes | | Oracle NetSuite | Yes | +| Zoho Books | Yes | +| Sage Intacct | Yes | -### Example Usage +### Example Usage: Create reimbursable expense + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateReimbursableExpenseTransactionRequest req = new CreateReimbursableExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new ReimbursableExpenseTransaction() { + Id = "4d7c6929-7770-412b-91bb-44d3bc71d111", + Reference = "expenses w/c 01/07", + ContactRef = new ReimbursementContactRef() { + Id = "752", + }, + IssueDate = "2024-05-21", + DueDate = "2024-05-21", + Currency = "GBP", + CurrencyRate = 1M, + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + Lines = new List() { + new ReimbursableExpenseTransactionLine() { + Description = "Hotel", + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "23_Bills", + }, + AccountRef = new RecordRef() { + Id = "35", + }, + TrackingRefs = new List() { + new TrackingRef() { + Id = "DEPARTMENT_5", + }, + }, + InvoiceTo = new InvoiceTo() { + Id = "504", + Type = InvoiceToType.Customer, + }, + }, + }, + }, + }, +}; + +var res = await sdk.Reimbursements.CreateAsync(req); + +// handle response +``` +### Example Usage: Example 1 + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -42,9 +99,64 @@ CreateReimbursableExpenseTransactionRequest req = new CreateReimbursableExpenseT ContactRef = new ReimbursementContactRef() { Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", }, - ApAccountRef = new ApAccountRef() { - Id = "8000004C-1724173136", + ApAccountRef = null, + IssueDate = "2022-10-23T00:00:00Z", + DueDate = "2022-10-23T00:00:00Z", + Currency = "GBP", + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + Lines = new List() { + new ReimbursableExpenseTransactionLine() { + Description = "2-night hotel stay", + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + }, + AccountRef = new RecordRef() { + Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + }, + ItemRef = new ItemRef() { + Id = "80000002-1675158984", + }, + TrackingRefs = new List() { + new TrackingRef() { + Id = "e9a1b63d-9ff0-40e7-8038-016354b987e6", + }, + }, + InvoiceTo = new InvoiceTo() { + Id = "80000002-1674552702", + Type = InvoiceToType.Customer, + }, + }, }, + }, + }, +}; + +var res = await sdk.Reimbursements.CreateAsync(req); + +// handle response +``` +### Example Usage: Malformed query + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateReimbursableExpenseTransactionRequest req = new CreateReimbursableExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new List() { + new ReimbursableExpenseTransaction() { + Id = "4d7c6929-7770-412b-91bb-44d3bc71d111", + ContactRef = new ReimbursementContactRef() { + Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + }, + ApAccountRef = null, IssueDate = "2022-10-23T00:00:00Z", DueDate = "2022-10-23T00:00:00Z", Currency = "GBP", @@ -66,12 +178,11 @@ CreateReimbursableExpenseTransactionRequest req = new CreateReimbursableExpenseT TrackingRefs = new List() { new TrackingRef() { Id = "e9a1b63d-9ff0-40e7-8038-016354b987e6", - DataType = Codat.Sync.Expenses.Models.Components.TrackingRefDataType.TrackingCategories, }, }, InvoiceTo = new InvoiceTo() { Id = "80000002-1674552702", - Type = Codat.Sync.Expenses.Models.Components.InvoiceToType.Customer, + Type = InvoiceToType.Customer, }, }, }, @@ -98,36 +209,39 @@ var res = await sdk.Reimbursements.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Update -The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection. - -Updating an existing [reimbursable expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateReimbursableExpenseTransactionRequest) will update the existing **bill** against an employee (who exists as a supplier in the accounting software). - -### Supported Integrations -| Integration | Supported | -|-----------------------|-----------| -| FreeAgent | Yes | -| QuickBooks Online | Yes | +The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection. + +Updating an existing [reimbursable expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateReimbursableExpenseTransactionRequest) will update the existing **bill** against an employee (who exists as a supplier in the accounting software). + +### Supported Integrations +| Integration | Supported | +|-----------------------|-----------| +| FreeAgent | Yes | +| QuickBooks Online | Yes | | Oracle NetSuite | Yes | +| Sage Intacct | Yes | +| Zoho Books | Yes | -### Example Usage +### Example Usage: Example 1 + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -Models.Requests.UpdateReimbursableExpenseTransactionRequest req = new Models.Requests.UpdateReimbursableExpenseTransactionRequest() { +Models.Requests.UpdateReimbursableExpenseTransactionRequest req = new Codat.Sync.Expenses.Models.Requests.UpdateReimbursableExpenseTransactionRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", - UpdateReimbursableExpenseTransactionRequest = new Models.Components.UpdateReimbursableExpenseTransactionRequest() { + UpdateReimbursableExpenseTransactionRequestValue = new Codat.Sync.Expenses.Models.Components.UpdateReimbursableExpenseTransactionRequest() { ContactRef = new ReimbursementContactRef() { Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", }, @@ -155,12 +269,119 @@ Models.Requests.UpdateReimbursableExpenseTransactionRequest req = new Models.Req TrackingRefs = new List() { new TrackingRef() { Id = "e9a1b63d-9ff0-40e7-8038-016354b987e6", - DataType = Codat.Sync.Expenses.Models.Components.TrackingRefDataType.TrackingCategories, }, }, InvoiceTo = new InvoiceTo() { Id = "80000002-1674552702", - Type = Codat.Sync.Expenses.Models.Components.InvoiceToType.Customer, + Type = InvoiceToType.Customer, + }, + }, + }, + }, +}; + +var res = await sdk.Reimbursements.UpdateAsync(req); + +// handle response +``` +### Example Usage: Malformed query + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +Models.Requests.UpdateReimbursableExpenseTransactionRequest req = new Codat.Sync.Expenses.Models.Requests.UpdateReimbursableExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", + UpdateReimbursableExpenseTransactionRequestValue = new Codat.Sync.Expenses.Models.Components.UpdateReimbursableExpenseTransactionRequest() { + ContactRef = new ReimbursementContactRef() { + Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + }, + ApAccountRef = new ApAccountRef() { + Id = "8000004C-1724173136", + }, + IssueDate = "2022-10-23T00:00:00Z", + DueDate = "2022-10-23T00:00:00Z", + Currency = "GBP", + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + Lines = new List() { + new ReimbursableExpenseTransactionLine() { + Description = "2-night hotel stay", + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + }, + AccountRef = new RecordRef() { + Id = "40e3e57c-2322-4898-966c-ca41adfd23fd", + }, + ItemRef = new ItemRef() { + Id = "80000002-1675158984", + }, + TrackingRefs = new List() { + new TrackingRef() { + Id = "e9a1b63d-9ff0-40e7-8038-016354b987e6", + }, + }, + InvoiceTo = new InvoiceTo() { + Id = "80000002-1674552702", + Type = InvoiceToType.Customer, + }, + }, + }, + }, +}; + +var res = await sdk.Reimbursements.UpdateAsync(req); + +// handle response +``` +### Example Usage: Update reimbursable expense + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using System.Collections.Generic; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +Models.Requests.UpdateReimbursableExpenseTransactionRequest req = new Codat.Sync.Expenses.Models.Requests.UpdateReimbursableExpenseTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", + UpdateReimbursableExpenseTransactionRequestValue = new Codat.Sync.Expenses.Models.Components.UpdateReimbursableExpenseTransactionRequest() { + Reference = "expenses w/c 01/07", + ContactRef = new ReimbursementContactRef() { + Id = "752", + }, + IssueDate = "2024-05-21", + DueDate = "2024-05-21", + Currency = "GBP", + CurrencyRate = 1M, + Notes = "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", + Lines = new List() { + new ReimbursableExpenseTransactionLine() { + Description = "Hotel", + NetAmount = 100M, + TaxAmount = 20M, + TaxRateRef = new RecordRef() { + Id = "23_Bills", + }, + AccountRef = new RecordRef() { + Id = "35", + }, + TrackingRefs = new List() { + new TrackingRef() { + Id = "DEPARTMENT_5", + }, + }, + InvoiceTo = new InvoiceTo() { + Id = "504", + Type = InvoiceToType.Customer, }, }, }, @@ -186,5 +407,6 @@ var res = await sdk.Reimbursements.UpdateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/suppliers/README.md b/sync-for-expenses/docs/sdks/suppliers/README.md index f790909b3..0db8b2d0c 100644 --- a/sync-for-expenses/docs/sdks/suppliers/README.md +++ b/sync-for-expenses/docs/sdks/suppliers/README.md @@ -1,5 +1,4 @@ # Suppliers -(*Suppliers*) ## Overview @@ -18,69 +17,759 @@ The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.i [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). - +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-all-data-types). -### Example Usage +### Supported Integrations + +| Integration | Supported | +|-------------------------------|-----------| +| Dynamics 365 Business Central | Yes | +| FreeAgent | Yes | +| Oracle NetSuite | Yes | +| QuickBooks Desktop | Yes | +| QuickBooks Online | Yes | +| Sage Intacct | Yes | +| Xero | Yes | +| Zoho Books | Yes | + + +### Example Usage: Clear Books + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListSuppliersRequest req = new ListSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Suppliers.ListAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `request` | [ListSuppliersRequest](../../Models/Requests/ListSuppliersRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListSuppliersResponse](../../Models/Requests/ListSuppliersResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get supplier* endpoint returns a single supplier for a given supplierId. + +[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-all-data-types). + +### Supported Integrations + +| Integration | Supported | +|-------------------------------|-----------| +| Dynamics 365 Business Central | Yes | +| FreeAgent | Yes | +| Oracle NetSuite | Yes | +| QuickBooks Desktop | Yes | +| QuickBooks Online | Yes | +| Sage Intacct | Yes | +| Xero | Yes | +| Zoho Books | Yes | + + +### Example Usage: Clear Books + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -ListSuppliersRequest req = new ListSuppliersRequest() { +GetSupplierRequest req = new GetSupplierRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - Page = 1, - PageSize = 100, - Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", - OrderBy = "-modifiedDate", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", }; -var res = await sdk.Suppliers.ListAsync(req); +var res = await sdk.Suppliers.GetAsync(req); // handle response ``` +### Example Usage: FreshBooks -### Parameters + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `request` | [ListSuppliersRequest](../../Models/Requests/ListSuppliersRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -**[ListSuppliersResponse](../../Models/Requests/ListSuppliersResponse.md)** +var res = await sdk.Suppliers.GetAsync(req); -### Errors +// handle response +``` +### Example Usage: KashFlow -| Error Type | Status Code | Content Type | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429, 500, 503 | application/json | -| Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; -## Get +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get supplier* endpoint returns a single supplier for a given supplierId. +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +var res = await sdk.Suppliers.GetAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: Oracle NetSuite + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; -### Example Usage +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetSupplierRequest req = new GetSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); GetSupplierRequest req = new GetSupplierRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - SupplierId = "7110701885", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", }; var res = await sdk.Suppliers.GetAsync(req); @@ -102,26 +791,41 @@ var res = await sdk.Suppliers.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Create -The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. - -[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - -**Integration-specific behaviour** - -Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). +The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. +[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. -### Example Usage +**Integration-specific behavior** + +Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). + +### Supported Integrations + +| Integration | Supported | +|-------------------------------|-----------| +| Dynamics 365 Business Central | Yes | +| FreeAgent | Yes | +| Oracle NetSuite | Yes | +| QuickBooks Desktop | Yes | +| QuickBooks Online | Yes | +| Sage Intacct | Yes | +| Xero | Yes | +| Zoho Books | Yes | + +### Example Usage: Malformed query + + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -139,7 +843,7 @@ CreateSupplierRequest req = new CreateSupplierRequest() { Phone = "07999 999999", Addresses = new List() { new Items() { - Type = Codat.Sync.Expenses.Models.Components.AccountingAddressType.Billing, + Type = AccountingAddressType.Billing, Line1 = "Unit 51", Line2 = "Bakersfield Industrial Estate", City = "Bakersfield", @@ -149,7 +853,7 @@ CreateSupplierRequest req = new CreateSupplierRequest() { }, RegistrationNumber = "string", TaxNumber = "string", - Status = Codat.Sync.Expenses.Models.Components.SupplierStatus.Unknown, + Status = SupplierStatus.Unknown, DefaultCurrency = "string", Metadata = new Metadata() { IsDeleted = true, @@ -157,12 +861,12 @@ CreateSupplierRequest req = new CreateSupplierRequest() { SupplementalData = new SupplementalData() { Content = new Dictionary>() { { "property1", new Dictionary() { - { "property1", null }, - { "property2", null }, + { "property1", "" }, + { "property2", "" }, } }, { "property2", new Dictionary() { - { "property1", null }, - { "property2", null }, + { "property1", "" }, + { "property2", "" }, } }, }, }, @@ -171,6 +875,31 @@ CreateSupplierRequest req = new CreateSupplierRequest() { var res = await sdk.Suppliers.CreateAsync(req); +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateSupplierRequest req = new CreateSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Supplier = new Supplier() { + Id = "73593", + SupplierName = "test 20230420 1004", + ContactName = "Joe Bloggs", + Status = SupplierStatus.Active, + }, +}; + +var res = await sdk.Suppliers.CreateAsync(req); + // handle response ``` @@ -188,25 +917,36 @@ var res = await sdk.Suppliers.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Update -The *Update supplier* endpoint updates an existing [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. - -[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - -**Integration-specific behaviour** - +The *Update supplier* endpoint updates an existing [supplier](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) for a given company's connection. + +[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + +**Integration-specific behavior** + Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). +### Supported Integrations + +| Integration | Supported | +|-------------------|-----------| +| FreeAgent | Yes | +| QuickBooks Online | Yes | +| Xero | Yes | + + ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; using System.Collections.Generic; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -214,7 +954,7 @@ var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); UpdateSupplierRequest req = new UpdateSupplierRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", - SupplierId = "EILBDVJVNUAGVKRQ", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", Supplier = new Supplier() { ModifiedDate = "2022-10-23T00:00:00Z", SourceModifiedDate = "2022-10-23T00:00:00Z", @@ -225,7 +965,7 @@ UpdateSupplierRequest req = new UpdateSupplierRequest() { Phone = "07999 999999", Addresses = new List() { new Items() { - Type = Codat.Sync.Expenses.Models.Components.AccountingAddressType.Billing, + Type = AccountingAddressType.Billing, Line1 = "Unit 51", Line2 = "Bakersfield Industrial Estate", City = "Bakersfield", @@ -235,7 +975,7 @@ UpdateSupplierRequest req = new UpdateSupplierRequest() { }, RegistrationNumber = "string", TaxNumber = "string", - Status = Codat.Sync.Expenses.Models.Components.SupplierStatus.Unknown, + Status = SupplierStatus.Unknown, DefaultCurrency = "string", Metadata = new Metadata() { IsDeleted = true, @@ -243,12 +983,12 @@ UpdateSupplierRequest req = new UpdateSupplierRequest() { SupplementalData = new SupplementalData() { Content = new Dictionary>() { { "property1", new Dictionary() { - { "property1", null }, - { "property2", null }, + { "property1", "" }, + { "property2", "" }, } }, { "property2", new Dictionary() { - { "property1", null }, - { "property2", null }, + { "property1", "" }, + { "property2", "" }, } }, }, }, @@ -274,5 +1014,6 @@ var res = await sdk.Suppliers.UpdateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/sync/README.md b/sync-for-expenses/docs/sdks/sync/README.md index ae363bdd0..2acae3009 100644 --- a/sync-for-expenses/docs/sdks/sync/README.md +++ b/sync-for-expenses/docs/sdks/sync/README.md @@ -1,5 +1,4 @@ # Sync -(*Sync*) ## Overview @@ -18,10 +17,11 @@ Gets the status of the last successful sync ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -48,7 +48,8 @@ var res = await sdk.Sync.GetLastSuccessfulSyncAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## GetLatestSync @@ -57,10 +58,11 @@ Gets the latest sync status ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -87,7 +89,8 @@ var res = await sdk.Sync.GetLatestSyncAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## List @@ -96,10 +99,11 @@ Gets a list of sync statuses ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -126,7 +130,8 @@ var res = await sdk.Sync.ListAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Get @@ -135,10 +140,11 @@ Get the sync status for a specified sync ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -166,5 +172,6 @@ var res = await sdk.Sync.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/transactionstatus/README.md b/sync-for-expenses/docs/sdks/transactionstatus/README.md index c546759b9..a3375df29 100644 --- a/sync-for-expenses/docs/sdks/transactionstatus/README.md +++ b/sync-for-expenses/docs/sdks/transactionstatus/README.md @@ -1,5 +1,4 @@ # TransactionStatus -(*TransactionStatus*) ## Overview @@ -16,18 +15,17 @@ Gets the transactions and status for a sync ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); ListSyncTransactionsRequest req = new ListSyncTransactionsRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", SyncId = "6fb40d5e-b13e-11ed-afa1-0242ac120002", - Page = 1, - PageSize = 100, }; var res = await sdk.TransactionStatus.ListAsync(req); @@ -49,7 +47,8 @@ var res = await sdk.TransactionStatus.ListAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | ## Get @@ -58,10 +57,11 @@ Gets the status of a transaction for a sync ### Example Usage + ```csharp using Codat.Sync.Expenses; -using Codat.Sync.Expenses.Models.Requests; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -90,5 +90,6 @@ var res = await sdk.TransactionStatus.GetAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/transfers/README.md b/sync-for-expenses/docs/sdks/transfers/README.md index 1b5e8e0e0..b72066930 100644 --- a/sync-for-expenses/docs/sdks/transfers/README.md +++ b/sync-for-expenses/docs/sdks/transfers/README.md @@ -1,5 +1,4 @@ # Transfers -(*Transfers*) ## Overview @@ -11,26 +10,101 @@ Create and update transactions that represent the movement of your customers' mo ## Create -Use the *Create transfer* endpoint to create or update a [transfer transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/TransferTransactionRequest) in the accounting software for a given company's connection. - -Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card. - -The `from.amount` and `to.amount` fields are in the native currency of the account. - -### Supported Integrations -| Integration | Supported | -|-----------------------|-----------| -| FreeAgent | Yes | -| QuickBooks Desktop | Yes | -| QuickBooks Online | Yes | -| Xero | Yes | - -### Example Usage +Use the *Create transfer* endpoint to create or update a [transfer transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/TransferTransactionRequest) in the accounting software for a given company's connection. +Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card. + +The `from.amount` and `to.amount` fields are in the native currency of the account. + +### Supported Integrations +| Integration | Create transfer | Update transfer | +|-----------------------|------------------|------------------| +| Dynamics | No | No | +| FreeAgent | Yes | Yes | +| NetSuite | No | No | +| QuickBooks Desktop | Yes | No | +| QuickBooks Online | Yes | Yes | +| Sage Intacct | No | No | +| Xero | Yes | No | +| Zoho Books | No | No | + +### Example Usage: Create transfer + + +```csharp +using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateTransferTransactionRequest req = new CreateTransferTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", + TransferTransactionRequest = new TransferTransactionRequest() { + Description = "Sample transfer description", + Date = "2021-05-21T00:00:00+00:00", + From = new From() { + AccountRef = new AccountReference() { + Id = "787dfb37-5707-4dc0-8a86-8d74e4cc78ea", + }, + Amount = 100M, + }, + To = new To() { + AccountRef = new TransferTransactionRequestAccountReference() { + Id = "777dfb37-5506-3dc0-6g86-8d34z4cc78ea", + }, + Amount = 100M, + }, + }, +}; + +var res = await sdk.Transfers.CreateAsync(req); + +// handle response +``` +### Example Usage: Example 1 + + ```csharp using Codat.Sync.Expenses; +using Codat.Sync.Expenses.Models.Components; using Codat.Sync.Expenses.Models.Requests; + +var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateTransferTransactionRequest req = new CreateTransferTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + TransactionId = "336694d8-2dca-4cb5-a28d-3ccb83e55eee", + TransferTransactionRequest = new TransferTransactionRequest() { + Description = "Transfer from bank account Y to bank account Z", + Date = "2022-10-23T00:00:00Z", + From = new From() { + AccountRef = new AccountReference() { + Id = "", + }, + Amount = 7329.18M, + }, + To = new To() { + AccountRef = new TransferTransactionRequestAccountReference() { + Id = "", + }, + Amount = 522.15M, + }, + }, +}; + +var res = await sdk.Transfers.CreateAsync(req); + +// handle response +``` +### Example Usage: Malformed query + + +```csharp +using Codat.Sync.Expenses; using Codat.Sync.Expenses.Models.Components; +using Codat.Sync.Expenses.Models.Requests; var sdk = new CodatSyncExpenses(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); @@ -44,13 +118,13 @@ CreateTransferTransactionRequest req = new CreateTransferTransactionRequest() { AccountRef = new AccountReference() { Id = "", }, - Amount = 6384.24M, + Amount = 7329.18M, }, To = new To() { AccountRef = new TransferTransactionRequestAccountReference() { Id = "", }, - Amount = 4174.58M, + Amount = 522.15M, }, }, }; @@ -74,5 +148,6 @@ var res = await sdk.Transfers.CreateAsync(req); | Error Type | Status Code | Content Type | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| Codat.Sync.Expenses.Models.Errors.ErrorMessage | 500, 503 | application/json | | Codat.Sync.Expenses.Models.Errors.SDKException | 4XX, 5XX | \*/\* | \ No newline at end of file