diff --git a/static/oas/Codat-Lending.json b/static/oas/Codat-Lending.json
index 3d5a67048..b0bde0e09 100644
--- a/static/oas/Codat-Lending.json
+++ b/static/oas/Codat-Lending.json
@@ -165,6 +165,10 @@
{
"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": "Reports",
+ "description": "Endpoints to manage generation of reports"
}
],
"paths": {
@@ -319,7 +323,7 @@
}
},
"operationId": "list-companies",
- "description": "The *List companies* endpoint returns a list of [companies] 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.",
+ "description": "The *List companies* endpoint returns a list of [companies] associated to your instances.\n\nA [company](https://docs.codat.io/DOCS_PATH#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/DOCS_PATH#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -416,7 +420,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "Use 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": "Use the *Create company* endpoint to create a new [company](https://docs.codat.io/DOCS_PATH#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/DOCS_PATH#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/DOCS_PATH#/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": {
@@ -444,7 +448,7 @@
"/companies/{companyId}": {
"put": {
"summary": "Update company",
- "description": "Use the *Update company* endpoint to update both the name and description of the company. \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": "Use the *Update company* endpoint to update both the name and description of the company. \n\nA [company](https://docs.codat.io/DOCS_PATH#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/DOCS_PATH#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.",
"operationId": "update-company",
"parameters": [
{
@@ -518,7 +522,7 @@
"$ref": "#/components/parameters/companyId"
}
],
- "description": "The *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": "The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/DOCS_PATH#/schemas/Company), its [connections](https://docs.codat.io/DOCS_PATH#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/DOCS_PATH#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/DOCS_PATH#/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"
],
@@ -552,7 +556,7 @@
"get": {
"summary": "Get company",
"operationId": "get-company",
- "description": "The *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": "The *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/DOCS_PATH#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/DOCS_PATH#/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"
@@ -711,7 +715,7 @@
},
"post": {
"summary": "Create connection",
- "description": "Creates a connection for the company by providing a valid `platformKey`. \n\nUse the [List Integrations](https://docs.codat.io/lending-api#/operations/list-integrations) endpoint to access valid platform keys. ",
+ "description": "Creates a connection for the company by providing a valid `platformKey`. \n\nUse the [List Integrations](https://docs.codat.io/DOCS_PATH#/operations/list-integrations) endpoint to access valid platform keys. ",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
@@ -1818,7 +1822,7 @@
},
"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.\nThis endpoint helps you understand whether match data is available and, if so, how to usefully query it.\n\nThe response tells you:\n\n- Whether match results are available.\n- When the results were generated, and their status.\n- The connection IDs, amounts, and dates involved to support useful querying."
+ "description": "The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/DOCS_PATH#/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.\nThis endpoint helps you understand whether match data is available and, if so, how to usefully query it.\n\nThe response tells you:\n\n- Whether match results are available.\n- When the results were generated, and their status.\n- The connection IDs, amounts, and dates involved to support useful querying."
}
},
"/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries": {
@@ -1873,7 +1877,7 @@
},
"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/list-data-type-data-integrity-details) endpoint.",
+ "description": "The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/DOCS_PATH#/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/DOCS_PATH#/operations/list-data-type-data-integrity-details) endpoint.",
"parameters": [
{
"$ref": "#/components/parameters/query"
@@ -1948,7 +1952,7 @@
"$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.\n\nThe [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetails) are paginated and support ordering, following the same conventions as our other data endpoints."
+ "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.\n\nThe [details](https://docs.codat.io/DOCS_PATH#/schemas/DataIntegrityDetails) are paginated and support ordering, following the same conventions as our other data endpoints."
}
},
"/companies/{companyId}/reports/enhancedProfitAndLoss/accounts": {
@@ -3137,353 +3141,7 @@
"$ref": "#/components/schemas/EnhancedCashFlowTransactions"
},
"example": {
- "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"
- }
- ]
- }
- ]
+ "$ref": "#/components/examples/EnhancedCashflowExample"
}
}
}
@@ -3873,7 +3531,7 @@
],
"post": {
"summary": "Generate loan transactions report",
- "description": "The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report.\n\nLearn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview).\n\nMake sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint.\n",
+ "description": "The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report.\n\nLearn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview).\n\nMake sure you have [synced a company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data) recently before calling the endpoint.\n",
"tags": [
"Liabilities"
],
@@ -3911,7 +3569,7 @@
},
"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.\n\nThis detail gives analysts a better idea of the loan obligations a company may have.\n\nMake sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint.\n",
+ "description": "The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/DOCS_PATH#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations.\n\nThis detail gives analysts a better idea of the loan obligations a company may have.\n\nMake sure you have [synced a company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data) recently before calling the endpoint.\n",
"tags": [
"Liabilities"
],
@@ -3977,7 +3635,7 @@
],
"post": {
"summary": "Generate loan summaries report",
- "description": "The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report.\n\nLearn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview).\n\nMake sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint.\n",
+ "description": "The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report.\n\nLearn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview).\n\nMake sure you have [synced a company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data) recently before calling the endpoint.\n",
"tags": [
"Liabilities"
],
@@ -4012,7 +3670,7 @@
},
"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.\n\nThe endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection.\n\nMake sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint.\n",
+ "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.\n\nThe endpoint returns a list of a company's [loan summaries](https://docs.codat.io/DOCS_PATH#/schemas/LoanSummary) for each valid data connection.\n\nMake sure you have [synced a company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data) recently before calling the endpoint.\n",
"tags": [
"Liabilities"
],
@@ -4971,7 +4629,7 @@
},
"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.\n\nIn response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request.\n\n### Report types\n\n| reportType | Description |\n|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| [audit](https://docs.codat.io/lending/excel/audit-report) | 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. |\n| [enhancedCashFlow](https://docs.codat.io/lending/excel/enhanced-invoices-report) | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. |\n| [enhancedFinancials](https://docs.codat.io/lending/excel/enhanced-financials-report) | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. |\n| [enhancedInvoices](https://docs.codat.io/lending/excel/enhanced-invoices-report) | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. |\n\n[Learn more](https://docs.codat.io/lending/excel/overview) about valid Excel report types.\n\n\n",
+ "description": "The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter.\n\nIn response, the endpoint returns the [status](https://docs.codat.io/DOCS_PATH#/schemas/ExcelStatus) detailing the current state of the report generation request.\n\n### Report types\n\n| reportType | Description |\n|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| [audit](https://docs.codat.io/lending/excel/audit-report) | 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. |\n| [enhancedCashFlow](https://docs.codat.io/lending/excel/enhanced-invoices-report) | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. |\n| [enhancedFinancials](https://docs.codat.io/lending/excel/enhanced-financials-report) | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. |\n| [enhancedInvoices](https://docs.codat.io/lending/excel/enhanced-invoices-report) | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. |\n\n[Learn more](https://docs.codat.io/lending/excel/overview) about valid Excel report types.\n\n\n",
"parameters": [
{
"$ref": "#/components/parameters/excelReportType"
@@ -5090,7 +4748,7 @@
"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 ",
+ "description": "The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection.\n\n[Account transactions](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-account-transactions",
"x-speakeasy-group": "transactions.account-transactions",
"parameters": [
@@ -5546,7 +5204,7 @@
"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.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account 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",
+ "description": "The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.\n\n[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
@@ -5757,7 +5415,7 @@
"Financial statements"
],
"summary": "List 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 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).",
+ "description": "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).",
"operationId": "list-accounting-accounts",
"x-speakeasy-group": "financial-statements.accounts",
"parameters": [
@@ -7262,7 +6920,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get account* endpoint returns a single account for a given accountId.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get account* endpoint returns a single account for a given accountId.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-account",
"x-speakeasy-group": "financial-statements.accounts"
}
@@ -9292,7 +8950,7 @@
"$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 ",
+ "description": "The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-bill-credit-notes",
"x-speakeasy-group": "accounts-payable.bill-credit-notes"
}
@@ -10230,7 +9888,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.\n\n[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-bill-credit-note",
"x-speakeasy-group": "accounts-payable.bill-credit-notes"
}
@@ -11635,7 +11293,7 @@
"$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 ",
+ "description": "The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection.\n\n[Bill payments](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-bill-payments",
"x-speakeasy-group": "accounts-payable.bill-payments"
}
@@ -12253,7 +11911,7 @@
}
},
"summary": "Get bill payment",
- "description": "The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.\n\n[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.\n\n[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-bill-payment",
"x-speakeasy-group": "accounts-payable.bill-payments"
}
@@ -15412,7 +15070,7 @@
"$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.\n\n[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.\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### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.\n",
+ "description": "The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.\n",
"operationId": "list-accounting-bills",
"x-speakeasy-group": "accounts-payable.bills"
}
@@ -17074,7 +16732,7 @@
}
},
"summary": "Get bill",
- "description": "The *Get bill* endpoint returns a single bill for a given billId.\n\n[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.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill.\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\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.\n",
+ "description": "The *Get bill* endpoint returns a single bill for a given billId.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.\n",
"operationId": "get-accounting-bill",
"x-speakeasy-group": "accounts-payable.bills"
}
@@ -17134,7 +16792,7 @@
"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`.\n\n[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.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments.\n"
+ "description": "The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments.\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}": {
@@ -17193,7 +16851,7 @@
}
},
"summary": "Get bill attachment",
- "description": "The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.\n\n[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.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a bill attachment.\n",
+ "description": "The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a bill attachment.\n",
"operationId": "get-accounting-bill-attachment",
"x-speakeasy-group": "accounts-payable.bills"
}
@@ -17255,7 +16913,7 @@
}
},
"summary": "Download bill attachment",
- "description": "The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.\n\n[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.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support downloading a bill attachment.\n",
+ "description": "The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support downloading a bill attachment.\n",
"operationId": "download-accounting-bill-attachment",
"x-speakeasy-group": "accounts-payable.bills"
}
@@ -19560,7 +19218,7 @@
"$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 ",
+ "description": "The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.\n\n[Credit notes](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-credit-notes",
"x-speakeasy-group": "accounts-receivable.credit-notes"
}
@@ -20685,7 +20343,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get credit note* endpoint returns a single credit note for a given creditNoteId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get credit note* endpoint returns a single credit note for a given creditNoteId.\n\n[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-credit-note",
"x-speakeasy-group": "accounts-receivable.credit-notes"
}
@@ -22527,7 +22185,7 @@
"$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 ",
+ "description": "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-customers",
"x-speakeasy-group": "accounts-receivable.customers"
}
@@ -23304,7 +22962,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get customer* endpoint returns a single customer for a given customerId.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific 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",
+ "description": "The *Get customer* endpoint returns a single customer for a given customerId.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-customer",
"x-speakeasy-group": "accounts-receivable.customers"
}
@@ -23362,7 +23020,7 @@
}
},
"summary": "List customer attachments",
- "description": "The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments.\n",
+ "description": "The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments.\n",
"operationId": "list-accounting-customer-attachments",
"x-speakeasy-group": "accounts-receivable.customers"
}
@@ -23421,7 +23079,7 @@
}
},
"summary": "Get customer attachment",
- "description": "The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment.\n",
+ "description": "The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment.\n",
"operationId": "get-accounting-customer-attachment",
"x-speakeasy-group": "accounts-receivable.customers"
}
@@ -23481,7 +23139,7 @@
}
},
"summary": "Download customer attachment",
- "description": "The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment.\n",
+ "description": "The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment.\n",
"operationId": "download-accounting-customer-attachment",
"x-speakeasy-group": "accounts-receivable.customers"
}
@@ -24986,7 +24644,7 @@
"$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 purchases of items that are paid off at the point of the 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 ",
+ "description": "The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-direct-costs",
"x-speakeasy-group": "transactions.direct-costs"
}
@@ -25635,7 +25293,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get direct cost* endpoint returns a single direct cost for a given directCostId.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get direct cost* endpoint returns a single direct cost for a given directCostId.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-direct-cost",
"x-speakeasy-group": "transactions.direct-costs"
}
@@ -25696,7 +25354,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment.\n",
+ "description": "The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment.\n",
"operationId": "get-accounting-direct-cost-attachment",
"x-speakeasy-group": "transactions.direct-costs"
}
@@ -25758,7 +25416,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment.\n",
+ "description": "The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment.\n",
"operationId": "download-accounting-direct-cost-attachment",
"x-speakeasy-group": "transactions.direct-costs"
}
@@ -25817,7 +25475,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments.\n",
+ "description": "The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments.\n",
"operationId": "list-accounting-direct-cost-attachments",
"x-speakeasy-group": "transactions.direct-costs"
}
@@ -27013,7 +26671,7 @@
"$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 sales of items directly to a customer where payment is received 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 ",
+ "description": "The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-direct-incomes",
"x-speakeasy-group": "accounts-receivable.direct-incomes"
}
@@ -27583,7 +27241,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get direct income* endpoint returns a single direct income for a given directIncomeId.\n\n[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get direct income* endpoint returns a single direct income for a given directIncomeId.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-direct-income",
"x-speakeasy-group": "accounts-receivable.direct-incomes"
}
@@ -27647,7 +27305,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.\n\n[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment.\n",
+ "description": "The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment.\n",
"operationId": "get-accounting-direct-income-attachment",
"x-speakeasy-group": "accounts-receivable.direct-incomes"
}
@@ -27712,7 +27370,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.\n\n[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment.\n",
+ "description": "The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment.\n",
"operationId": "download-accounting-direct-income-attachment",
"x-speakeasy-group": "accounts-receivable.direct-incomes"
}
@@ -27770,7 +27428,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.\n\n[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments.\n",
+ "description": "The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments.\n",
"operationId": "list-accounting-direct-income-attachments",
"x-speakeasy-group": "accounts-receivable.direct-incomes"
}
@@ -27897,7 +27555,7 @@
"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",
+ "description": "The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.\n\n[Invoices](https://docs.codat.io/accounting-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/DOCS_PATH#/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": [
@@ -38624,7 +38282,7 @@
}
},
"summary": "Get invoice",
- "description": "The *Get invoice* endpoint returns a single invoice for a given invoiceId.\n\n[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice.\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### 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",
+ "description": "The *Get invoice* endpoint returns a single invoice for a given invoiceId.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\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": "get-accounting-invoice",
"x-speakeasy-group": "accounts-receivable.invoices"
}
@@ -38744,7 +38402,7 @@
}
},
"summary": "List invoice attachments",
- "description": "The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.\n\n[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments.\n",
+ "description": "The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments.\n",
"operationId": "list-accounting-invoice-attachments",
"x-speakeasy-group": "accounts-receivable.invoices"
}
@@ -38805,7 +38463,7 @@
}
},
"summary": "Get invoice attachment",
- "description": "The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.\n\n[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment.\n",
+ "description": "The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment.\n",
"operationId": "get-accounting-invoice-attachment",
"x-speakeasy-group": "accounts-receivable.invoices"
}
@@ -38867,7 +38525,7 @@
}
},
"summary": "Download invoice attachment",
- "description": "The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.\n\n[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment.\n",
+ "description": "The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment.\n",
"operationId": "download-accounting-invoice-attachment",
"x-speakeasy-group": "accounts-receivable.invoices"
}
@@ -40718,7 +40376,7 @@
"$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 ",
+ "description": "The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-journal-entries",
"x-speakeasy-group": "transactions.journal-entries"
}
@@ -41570,7 +41228,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.\n\n[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-journal-entry",
"x-speakeasy-group": "transactions.journal-entries"
}
@@ -41870,7 +41528,7 @@
"$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 ",
+ "description": "The *List journals* endpoint returns a list of [journals](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-journals",
"x-speakeasy-group": "transactions.journals"
}
@@ -42008,7 +41666,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get journal* endpoint returns a single journal for a given journalId.\n\n[Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get journal* endpoint returns a single journal for a given journalId.\n\n[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-journal",
"x-speakeasy-group": "transactions.journals"
}
@@ -43580,7 +43238,7 @@
"$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 ",
+ "description": "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-payments",
"x-speakeasy-group": "accounts-receivable.payments"
}
@@ -44259,7 +43917,7 @@
}
},
"summary": "Get payment",
- "description": "The *Get payment* endpoint returns a single payment for a given paymentId.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get payment* endpoint returns a single payment for a given paymentId.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-payment",
"x-speakeasy-group": "accounts-receivable.payments"
}
@@ -45389,7 +45047,7 @@
"$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 ",
+ "description": "The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-suppliers",
"x-speakeasy-group": "accounts-payable.suppliers"
}
@@ -45825,7 +45483,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get supplier* endpoint returns a single supplier for a given supplierId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get supplier* endpoint returns a single supplier for a given supplierId.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-supplier",
"x-speakeasy-group": "accounts-payable.suppliers"
}
@@ -45883,7 +45541,7 @@
}
},
"summary": "List supplier attachments",
- "description": "The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments.\n",
+ "description": "The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments.\n",
"operationId": "list-accounting-supplier-attachments",
"x-speakeasy-group": "accounts-payable.suppliers"
}
@@ -45942,7 +45600,7 @@
}
},
"summary": "Get supplier attachment",
- "description": "The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment.\n",
+ "description": "The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment.\n",
"operationId": "get-accounting-supplier-attachment",
"x-speakeasy-group": "accounts-payable.suppliers"
}
@@ -46002,7 +45660,7 @@
}
},
"summary": "Download supplier attachment",
- "description": "The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment.\n",
+ "description": "The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment.\n",
"operationId": "download-accounting-supplier-attachment",
"x-speakeasy-group": "accounts-payable.suppliers"
}
@@ -46829,7 +46487,7 @@
"$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 ",
+ "description": "The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.\n\n[Transfers](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"operationId": "list-accounting-transfers",
"x-speakeasy-group": "transactions.transfers"
}
@@ -47204,7 +46862,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get transfer* endpoint returns a single transfer for a given transferId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get transfer* endpoint returns a single transfer for a given transferId.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-accounting-transfer",
"x-speakeasy-group": "transactions.transfers"
}
@@ -47838,7 +47496,7 @@
"$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 "
+ "description": "The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection.\n\n[Bank accounts](https://docs.codat.io/accounting-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/DOCS_PATH#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}": {
@@ -48084,7 +47742,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get bank account* endpoint returns a single account for a given accountId.\n\n[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support getting a specific bank 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"
+ "description": "The *Get bank account* endpoint returns a single account for a given accountId.\n\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support getting a specific bank account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions": {
@@ -48094,7 +47752,7 @@
"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.\n\n[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.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank 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",
+ "description": "The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.\n\n[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "list-accounting-bank-account-transactions",
"x-speakeasy-name-override": "list-transactions",
"parameters": [
@@ -78700,7 +78358,7 @@
"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 ",
+ "description": "The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) for a given company's connection.\n\n[Account balances](https://docs.codat.io/banking-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
@@ -78844,7 +78502,7 @@
"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 ",
+ "description": "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/banking-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/banking-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
@@ -79043,7 +78701,7 @@
"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.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific 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",
+ "description": "The *Get account* endpoint returns a single account for a given accountId.\n\n[Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
@@ -79175,7 +78833,7 @@
"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 ",
+ "description": "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/banking-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -79429,7 +79087,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get transaction* endpoint returns a single transaction for a given transactionId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific 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",
+ "description": "The *Get transaction* endpoint returns a single transaction for a given transactionId.\n\n[Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"operationId": "get-banking-transaction",
"x-speakeasy-group": "banking.transactions"
}
@@ -79574,7 +79232,7 @@
"$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 "
+ "description": "The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) for a given company's connection.\n\n[Transaction categories](https://docs.codat.io/banking-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/DOCS_PATH#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}": {
@@ -79602,7 +79260,7 @@
"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.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n",
+ "description": "The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.\n\n[Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"responses": {
"200": {
"description": "Success",
@@ -79677,7 +79335,7 @@
"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 ",
+ "description": "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/commerce-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -80232,7 +79890,7 @@
"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.\n\n[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.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for integrations that support getting a specific 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",
+ "description": "The *Get customer* endpoint returns a single customer for a given customerId.\n\n[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for integrations that support getting a specific customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n",
"responses": {
"200": {
"description": "OK",
@@ -80621,7 +80279,7 @@
"$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 "
+ "description": "The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) for a given company's connection.\n\n[Disputes](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}": {
@@ -80727,7 +80385,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get dispute* endpoint returns a single dispute for a given disputeId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for integrations that support getting a specific dispute.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get dispute* endpoint returns a single dispute for a given disputeId.\n\n[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for integrations that support getting a specific dispute.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-info": {
@@ -81023,7 +80681,7 @@
"$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 "
+ "description": "The *List locations* endpoint returns a list of [locations](https://docs.codat.io/commerce-api#/schemas/Location) for a given company's connection.\n\n[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}": {
@@ -81150,7 +80808,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get location* endpoint returns a single location for a given locationId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for integrations that support getting a specific location.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get location* endpoint returns a single location for a given locationId.\n\n[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for integrations that support getting a specific location.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-orders": {
@@ -82559,7 +82217,7 @@
"$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 ",
+ "description": "The *List orders* endpoint returns a list of [orders](https://docs.codat.io/commerce-api#/schemas/Order) for a given company's connection.\n\n[Orders](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -83354,7 +83012,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get order* endpoint returns a single order for a given orderId.\n\n[Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for integrations that support getting a specific order.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get order* endpoint returns a single order for a given orderId.\n\n[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for integrations that support getting a specific order.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods": {
@@ -83667,7 +83325,7 @@
"$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 ",
+ "description": "The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) for a given company's connection.\n\n[Payment methods](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -83814,7 +83472,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.\n\n[Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for integrations that support getting a specific payment method.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.\n\n[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for integrations that support getting a specific payment method.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-payments": {
@@ -84263,7 +83921,7 @@
"$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 ",
+ "description": "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/commerce-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -84459,7 +84117,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get payment* endpoint returns a single payment for a given paymentId.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for integrations that support getting a specific payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get payment* endpoint returns a single payment for a given paymentId.\n\n[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for integrations that support getting a specific payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories": {
@@ -84567,7 +84225,7 @@
"$ref": "#/components/parameters/orderBy"
}
],
- "description": "The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection.\n\n[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n "
+ "description": "The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) for a given company's connection.\n\n[Product categories](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}": {
@@ -84636,7 +84294,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get product* endpoint returns a single product for a given productId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for integrations that support getting a specific product.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for integrations that support getting a specific product.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-products": {
@@ -85875,7 +85533,7 @@
"$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 "
+ "description": "The *List products* endpoint returns a list of [products](https://docs.codat.io/commerce-api#/schemas/Product) for a given company's connection.\n\n[Products](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}": {
@@ -86489,7 +86147,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-products) for integrations that support getting a specific product.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
+ "description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-products) for integrations that support getting a specific product.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-transactions": {
@@ -86801,7 +86459,7 @@
"$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 ",
+ "description": "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/commerce-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/DOCS_PATH#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
@@ -86962,7 +86620,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
- "description": "The *Get transaction* endpoint returns a single transaction for a given transactionId.\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\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for integrations that support getting a specific 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"
+ "description": "The *Get transaction* endpoint returns a single transaction for a given transactionId.\n\n[Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for integrations that support getting a specific transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/DOCS_PATH#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/files": {
@@ -88382,7 +88040,7 @@
},
"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 behaviour**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account.\r\n"
+ "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/accounting-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behaviour**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account.\r\n"
}
},
"/companies/{companyId}/connections/{connectionId}/push/bankAccounts": {
@@ -88454,7 +88112,7 @@
"$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 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/lending-api#/operations/get-create-update-bankAccounts-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account.",
+ "description": "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/accounting-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/accounting-api#/operations/get-create-update-bankAccounts-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account.",
"operationId": "create-bank-account",
"x-speakeasy-group": "loan-writeback.bank-accounts"
}
@@ -93454,7 +93112,7 @@
},
"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.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n"
+ "description": "The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company and integration.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n"
}
},
"/companies/{companyId}/connections/{connectionId}/push/accounts": {
@@ -93525,7 +93183,7 @@
"$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.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nRequired 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).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n",
+ "description": "The *Create account* endpoint creates a new [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n",
"operationId": "create-account",
"x-speakeasy-group": "loan-writeback.accounts"
}
@@ -98588,7 +98246,7 @@
},
"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 behaviour**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating and updating a supplier.\r\n"
+ "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/accounting-api#/schemas/Supplier) for a given company and integration.\r\n\r\n[Suppliers](https://docs.codat.io/accounting-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\nSee the *response examples* for integration-specific indicative models.\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating and updating a supplier.\r\n"
}
},
"/companies/{companyId}/connections/{connectionId}/push/suppliers": {
@@ -98669,7 +98327,7 @@
}
},
"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 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/lending-api#/operations/get-create-update-suppliers-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account.\r\n",
+ "description": "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/accounting-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/accounting-api#/operations/get-create-update-suppliers-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account.\r\n",
"operationId": "create-supplier",
"x-speakeasy-group": "loan-writeback.suppliers"
}
@@ -100382,7 +100040,7 @@
},
"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.\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\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating a transfer.\n"
+ "description": "The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company and integration.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating a transfer.\n"
}
},
"/companies/{companyId}/connections/{connectionId}/push/transfers": {
@@ -100436,7 +100094,6 @@
},
"amount": 12
},
- "status": "Unknown",
"trackingCategoryRefs": [
{
"id": "80000001-1674553252",
@@ -100489,7 +100146,7 @@
"$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.\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\n**Integration-specific behaviour**\n\nRequired 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).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating an account.\n",
+ "description": "The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/accounting-api#/operations/get-create-transfers-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating an account.\n",
"operationId": "create-transfer",
"x-speakeasy-group": "loan-writeback.transfers"
}
@@ -100511,7 +100168,7 @@
"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.\n\n[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.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.\n",
+ "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/accounting-api#/schemas/BankTransactions) for a given company and integration.\n\n[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.\n",
"operationId": "get-create-bank-transactions-model",
"x-speakeasy-group": "loan-writeback.bank-transactions",
"responses": {
@@ -100567,7 +100224,7 @@
"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.\n\n[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.\n\n**Integration-specific behaviour**\n\nRequired 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).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.\n",
+ "description": "The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.\n\n[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.\n",
"operationId": "create-bank-transactions",
"x-speakeasy-group": "loan-writeback.bank-transactions",
"parameters": [
@@ -104583,7 +104240,7 @@
},
"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.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating a direct cost.\n"
+ "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/accounting-api#/schemas/DirectCost) for a given company and integration.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating a direct cost.\n"
}
},
"/companies/{companyId}/connections/{connectionId}/push/directCosts": {
@@ -105014,7 +104671,7 @@
"$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.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs.\n\n**Integration-specific behaviour**\n\nRequired 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).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating an account.\n",
+ "description": "The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/accounting-api#/operations/get-create-directCosts-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating an account.\n",
"operationId": "create-direct-cost",
"x-speakeasy-group": "loan-writeback.direct-costs"
}
@@ -108642,7 +108299,7 @@
},
"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.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating a payment.\n"
+ "description": "The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company and integration.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating a payment.\n"
}
},
"/companies/{companyId}/connections/{connectionId}/push/payments": {
@@ -108885,7 +108542,7 @@
"$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.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\n**Integration-specific behaviour**\n\nRequired 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).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating an account.\n",
+ "description": "The *Create payment* endpoint creates a new [payment](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/accounting-api#/operations/get-create-payments-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating an account.\n",
"operationId": "create-payment",
"x-speakeasy-group": "loan-writeback.payments"
}
@@ -109198,111 +108855,850 @@
}
}
},
- "/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/upload": {
+ "/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.\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.",
+ "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}/{reportId}/status": {
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/companyId"
+ },
+ {
+ "$ref": "#/components/parameters/reportType"
+ },
+ {
+ "$ref": "#/components/parameters/reportId"
+ },
+ {
+ "$ref": "#/components/parameters/maxAge"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Reports"
+ ],
+ "summary": "Get report status",
+ "description": "Use the *Get report status* endpoint to retrieve details about a specific report. \n\nYou can either provide the ID of a report or use `latest` to get the most recent generated *reportName* report for the company\n\n",
+ "operationId": "get-report-status",
+ "x-speakeasy-name-override": "get-report-status",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportOperation"
+ }
+ }
+ }
+ },
+ "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": [
+ "Reports"
+ ],
+ "summary": "Generate report",
+ "description": "Use the *Generate report* endpoint to initiate the generation of a report of type *reportName*. This endpoint will refresh any required data from the company's data sources.",
+ "operationId": "generate-report",
+ "x-speakeasy-name-override": "generate-report",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportOperation"
+ }
+ }
+ }
+ },
+ "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": [
+ "Reports"
+ ],
+ "summary": "Get categorized bank statement transactions",
+ "description": "The *Get categorized bank statement transactions* endpoint provides a fully categorized list of banking transactions for a company. Transaction data is obtained from the company's banking data sources.\nBefore using this endpoint you must have [generated a report](https://docs.codat.io/DOCS_PATH#/operations/request-report) of type `categorizedBankStatement`.",
+ "operationId": "get-categorized-bank-statement-transactions",
+ "x-speakeasy-name-override": "get-categorized-bank-statement-transactions",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CategorizedBankStatementTransactions"
+ },
+ "example": {
+ "pageNumber": 1,
+ "pageSize": 100,
+ "totalResults": 2194,
+ "_links": {
+ "self": {
+ "href": "/companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions"
+ },
+ "current": {
+ "href": "/companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100"
+ },
+ "next": {
+ "href": "/companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100"
+ }
+ },
+ "results": [
+ {
+ "sourceRef": {
+ "sourceType": "Banking"
+ },
+ "accountRef": {
+ "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
+ "name": "Business Current Account"
+ },
+ "id": "ab5e07a0-5578-4d91-8421-2dc72713b74f",
+ "date": "2022-11-08T00:00:00",
+ "description": "Payment m86SDGpQr3",
+ "amount": -6905.44,
+ "currency": "GBP",
+ "transactionCategory": {
+ "confidence": 52.53,
+ "levels": [
+ "Expense",
+ "Operating"
+ ],
+ "confidences": [
+ 56,
+ 52.53
+ ]
+ },
+ "platformName": "Shopify",
+ "counterpartyNames": [
+ "Shopify"
+ ],
+ "modifiedDate": "2022-11-08T12:00:00"
+ },
+ {
+ "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": [
+ "Reports"
+ ],
+ "summary": "Get categorized bank statement accounts",
+ "description": "The *Get categorized bank statement accounts* endpoint provides a list of bank accounts associated with categorized transactions for a company. \n\nBefore using this endpoint you must have [generated a report](https://docs.codat.io/DOCS_PATH#/operations/request-report) of type `categorizedBankStatement`.",
+ "operationId": "get-categorized-bank-statement-accounts",
+ "x-speakeasy-name-override": "get-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": [
+ "Reports"
+ ],
+ "summary": "Download categorized bank statement Excel",
+ "description": "Use the *Download categorized bank statement Excel* endpoint to download the categorised bank statement in excel format. \nBefore using this endpoint you must have [generated a report](https://docs.codat.io/DOCS_PATH#/operations/request-report) 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": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
- "$ref": "#/components/parameters/connectionId"
- },
- {
- "$ref": "#/components/parameters/datasetId"
+ "$ref": "#/components/parameters/page"
},
{
- "$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/pageSize"
},
{
- "$ref": "#/components/parameters/connectionId"
+ "$ref": "#/components/parameters/query"
},
{
- "$ref": "#/components/parameters/datasetId"
+ "$ref": "#/components/parameters/orderBy"
}
],
- "post": {
+ "get": {
"tags": [
- "Bank statements"
+ "Reports"
],
- "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.\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.",
- "operationId": "end-bank-statement-upload-session",
- "x-speakeasy-name-override": "end-upload-session",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EndUploadSessionRequest"
- }
- }
- }
- },
+ "summary": "List reports",
+ "description": "Use the *List reports* endpoint to retrieve details about all reporst 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"
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportOperation/definitions/reports"
+ }
+ }
+ }
},
"400": {
"$ref": "#/components/responses/BadRequest"
@@ -109429,6 +109825,87 @@
}
}
}
+ },
+ "reports.categorizedBankStatement.generate.successful": {
+ "post": {
+ "description": "Called when a categorized bank statement is successfully generated for a company.",
+ "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"
+ ]
+ },
+ "generatedDate": {
+ "$ref": "#/components/schemas/DateTime",
+ "description": "The date time in UTC the event was generated in Codat."
+ },
+ "payload": {
+ "$ref": "#/webhooks/reports.categorizedBankStatement.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": [
+ {
+ "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."
+ }
+ }
+ }
}
},
"components": {
@@ -109499,7 +109976,7 @@
},
"AccountingAccount": {
"title": "Accounting: Account",
- "description": "> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\nView the coverage for accounts in the Data coverage explorer.\n\n## Overview\n\nAccounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/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.",
+ "description": "> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\nView the coverage for accounts in the Data coverage explorer.\n\n## Overview\n\nAccounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-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": {
@@ -109585,7 +110062,7 @@
"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).",
+ "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](/accounting-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.",
@@ -109678,7 +110155,7 @@
},
"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).\n\n> View the coverage for account transactions in the Data coverage explorer.\n\n## Overview\n\nIn 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.\n\nAccount transactions are created as a result of different business activities, for example:\n\n* Payments: for example, receiving money for payment against an invoice.\n* Bill payments: for example, spending money for a payment against a bill.\n* Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment.\n* Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.\n* Transfers: for example, transferring money between two bank accounts.\n\nAccount 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).",
+ "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/banking-api#/operations/list-all-banking-transactions).\n\n> View the coverage for account transactions in the Data coverage explorer.\n\n## Overview\n\nIn 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.\n\nAccount transactions are created as a result of different business activities, for example:\n\n* Payments: for example, receiving money for payment against an invoice.\n* Bill payments: for example, spending money for a payment against a bill.\n* Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment.\n* Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.\n* Transfers: for example, transferring money between two bank accounts.\n\nAccount transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer).",
"type": "object",
"allOf": [
{
@@ -109870,7 +110347,7 @@
},
"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.",
+ "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/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-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": {
@@ -109948,7 +110425,7 @@
"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.",
+ "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/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-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",
@@ -110083,7 +110560,7 @@
},
"AccountingBalanceSheet": {
"title": "Accounting: Balance sheet",
- "description": "> View the coverage for balance sheet in the Data coverage explorer.\n\n## Overview\n\nThe 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.\n\n> **Balance sheet or profit and loss report?**\n>\n> 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.\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 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).\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.",
+ "description": "> View the coverage for balance sheet in the Data coverage explorer.\n\n## Overview\n\nThe 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.\n\n> **Balance sheet or profit and loss report?**\n>\n> 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.\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 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/DOCS_PATH#/operations/update-sync-settings).\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",
"additionalProperties": false,
"properties": {
@@ -110147,7 +110624,7 @@
},
"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 datatype [here](https://docs.codat.io/lending-api#/schemas/Account)\n\n> View the coverage for bank accounts in the Data coverage explorer.\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.",
+ "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 datatype [here](https://docs.codat.io/banking-api#/schemas/Account)\n\n> View the coverage for bank accounts in the Data coverage explorer.\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": [
{
@@ -110343,7 +110820,7 @@
},
"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 datatype [here](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions)\n\n> View the coverage for bank transactions in the Data coverage explorer.\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.",
+ "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 datatype [here](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions)\n\n> View the coverage for bank transactions in the Data coverage explorer.\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": [
{
@@ -110439,7 +110916,7 @@
},
"AccountingBill": {
"title": "Accounting: Bill",
- "description": "> **Invoices or bills?**\n>\n> 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.\n>\n> See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills.\n\nView the coverage for bills in the Data coverage explorer.\n\n## Overview\n\nIn Codat, a bill contains details of:\n* When the bill was recorded in the accounting system.\n* How much the bill is for and the currency of the amount.\n* Who the bill was received from — the *supplier*.\n* What the bill is for — 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*.\n\nYou can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.",
+ "description": "> **Invoices or bills?**\n>\n> 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.\n>\n> See [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for the accounts receivable equivalent of bills.\n\nView the coverage for bills in the Data coverage explorer.\n\n## Overview\n\nIn Codat, a bill contains details of:\n* When the bill was recorded in the accounting system.\n* How much the bill is for and the currency of the amount.\n* Who the bill was received from — the *supplier*.\n* What the bill is for — 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*.\n\nYou can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.",
"type": "object",
"allOf": [
{
@@ -110730,7 +111207,7 @@
},
"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\nView the coverage for bill credit notes in the Data coverage explorer.\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.",
+ "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/accounting-api#/schemas/CreditNote).\n\nView the coverage for bill credit notes in the Data coverage explorer.\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/accounting-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/accounting-api#/schemas/Bill).\n* The supplier that issued the bill credit note.",
"type": "object",
"allOf": [
{
@@ -111132,7 +111609,7 @@
},
"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> View the coverage for bill payments in the Data coverage explorer.\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",
+ "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/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).\n\n> View the coverage for bill payments in the Data coverage explorer.\n\n## Overview\n\nBill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-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/accounting-api#/schemas/DirectCost) data model.\n\nBill payments is a child data type of [account transactions](https://docs.codat.io/accounting-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": [
{
@@ -112111,7 +112588,7 @@
},
"AccountingCreditNote": {
"title": "Accounting: Credit note",
- "description": "> View the coverage for credit notes in the Data coverage explorer.\n\n## 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.",
+ "description": "> View the coverage for credit notes in the Data coverage explorer.\n\n## 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/accounting-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": [
{
@@ -112408,7 +112885,7 @@
},
"AccountingCustomer": {
"title": "Accounting: Customer",
- "description": "> View the coverage for customers in the Data coverage explorer.\n\n## Overview\n\nA 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).\n\nCustomers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice).\n",
+ "description": "> View the coverage for customers in the Data coverage explorer.\n\n## Overview\n\nA 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).\n\nCustomers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice).\n",
"type": "object",
"allOf": [
{
@@ -112575,7 +113052,7 @@
},
"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.\n\n> View the coverage for direct costs in the Data coverage explorer.\n\n## Overview\n\nDirect costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.\n\nDirect costs include:\n * Purchasing an item and paying it off at the point of the purchase\n * Receiving cash from a refunded item if the refund is made by the supplier\n * Withdrawing money from a bank account \n * Writing a cheque\n\nDirect costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).",
+ "description": "> **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software.\n\n> View the coverage for direct costs in the Data coverage explorer.\n\n## Overview\n\nDirect costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.\n\nDirect costs include:\n * Purchasing an item and paying it off at the point of the purchase\n * Receiving cash from a refunded item if the refund is made by the supplier\n * Withdrawing money from a bank account \n * Writing a cheque\n\nDirect costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).",
"type": "object",
"allOf": [
{
@@ -112813,7 +113290,7 @@
},
"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> View the coverage for direct incomes in the Data coverage explorer.\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.\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 in cash to a contact.\n- Depositing money into a bank account.\n\nDirect incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n",
+ "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> View the coverage for direct incomes in the Data coverage explorer.\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.\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 in cash to a contact.\n- Depositing money into a bank account.\n\nDirect incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).\n",
"type": "object",
"allOf": [
{
@@ -112996,7 +113473,7 @@
},
"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\nView the coverage for invoices in the Data coverage explorer.\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.",
+ "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/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills.\n\nView the coverage for invoices in the Data coverage explorer.\n\n## Overview\n\nAn invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-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/accounting-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": [
{
@@ -113267,7 +113744,7 @@
},
"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\n\n> View the coverage for journals in the Data coverage explorer.\n\n## Overview\n\nIn 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.\n\nWhen 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.\n\nSuch journals can be divided into two categories:\n\n- Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.\n- General journals: journals used to record transactions that fall outside the scope of the special journals.\n\nMultiple journals or subjournals are used in the following Codat integrations:\n\n- [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory)\n- [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory)\n- [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional)\n\n> 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.\n",
+ "description": "> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type\n\n> View the coverage for journals in the Data coverage explorer.\n\n## Overview\n\nIn 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/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.\n\nWhen 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.\n\nSuch journals can be divided into two categories:\n\n- Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.\n- General journals: journals used to record transactions that fall outside the scope of the special journals.\n\nMultiple journals or subjournals are used in the following Codat integrations:\n\n- [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory)\n- [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory)\n- [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional)\n\n> 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.\n",
"type": "object",
"allOf": [
{
@@ -113385,7 +113862,7 @@
},
"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> View the coverage for journal entries in the Data coverage explorer.\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.",
+ "description": "> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type\n\n> View the coverage for journal entries in the Data coverage explorer.\n\n## Overview\n\nA journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-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": [
{
@@ -113578,7 +114055,7 @@
},
"AccountingPayment": {
"title": "Accounting: Payment",
- "description": "> **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> View the coverage for payments in the Data coverage explorer.\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 ```",
+ "description": "> **Payments or bill payments?**\n>\n> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills.\n\n> View the coverage for payments in the Data coverage explorer.\n\n## Overview\n\nPayments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-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/accounting-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": [
{
@@ -113801,7 +114278,7 @@
},
"AccountingPaymentMethod": {
"title": "Accounting: Payment method",
- "description": "> View the coverage for payment methods in the Data coverage explorer.\n\n## Overview\n\nA 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).",
+ "description": "> View the coverage for payment methods in the Data coverage explorer.\n\n## Overview\n\nA Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).",
"type": "object",
"allOf": [
{
@@ -113869,7 +114346,7 @@
},
"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> View the coverage for profit and loss in the Data coverage explorer.\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.",
+ "description": "> **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).\n\n> View the coverage for profit and loss in the Data coverage explorer.\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/DOCS_PATH#/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": {
@@ -113975,7 +114452,7 @@
},
"AccountingSupplier": {
"title": "Accounting: Supplier",
- "description": "> View the coverage for suppliers in the Data coverage explorer.\n\n## Overview\n\nFrom 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).",
+ "description": "> View the coverage for suppliers in the Data coverage explorer.\n\n## Overview\n\nFrom the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill).",
"type": "object",
"allOf": [
{
@@ -114230,7 +114707,7 @@
},
"AccountingTransfer": {
"title": "Accounting: Transfer",
- "description": "> View the coverage for transfers in the Data coverage explorer.\n\nA 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).",
+ "description": "> View the coverage for transfers in the Data coverage explorer.\n\nA 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/accounting-api#/schemas/AccountTransaction).",
"allOf": [
{
"properties": {
@@ -114259,17 +114736,6 @@
"$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,
@@ -114706,7 +115172,7 @@
},
"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.",
+ "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/banking-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": [
{
@@ -115098,6 +115564,227 @@
}
}
},
+ "CategorizedBankStatementAccounts": {
+ "title": "Categorized bank statement accounts",
+ "description": "> **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 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": "Accounts",
+ "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/AgedCurrencyOutstanding/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**\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 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"
+ }
+ }
+ }
+ },
"ClientRateLimitReachedWebhook": {
"title": "Client rate limit reached webhook",
"x-internal": true,
@@ -115902,7 +116589,7 @@
"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.",
+ "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/DOCS_PATH#/operations/get-companies-companyId-connections-connectionId-push) endpoint.",
"type": "string",
"format": "ISO3166 Alpha-3",
"examples": [
@@ -117406,7 +118093,7 @@
},
"Company": {
"title": "Company",
- "description": "In 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": "In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/DOCS_PATH#/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": [
{
@@ -117571,7 +118258,7 @@
},
"Connection": {
"title": "Connection",
- "description": "A 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": "A connection represents a [company's](https://docs.codat.io/DOCS_PATH#/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": {
@@ -117630,7 +118317,6 @@
},
"dataConnectionErrors": {
"type": "array",
- "nullable": true,
"items": {
"$ref": "#/components/schemas/Connection/definitions/dataConnectionError"
}
@@ -118279,7 +118965,26 @@
"type": "object",
"properties": {
"sourceRef": {
- "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/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\".",
@@ -118308,55 +119013,6 @@
}
}
},
- "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"
- }
- }
- }
- }
- ]
- },
- "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"
- }
- }
- }
- }
- ]
- },
"enhancedCashFlowItem": {
"type": "object",
"properties": {
@@ -118364,113 +119020,139 @@
"description": "An array of transaction data.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowTransaction"
- }
- }
- }
- },
- "enhancedCashFlowTransaction": {
- "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/AgedCurrencyOutstanding/properties/currency",
- "description": "The currency code for bank transaction."
- },
- "transactionCategory": {
- "description": "Contains an array of category levels.",
- "$ref": "#/components/schemas/EnhancedCashFlowTransactions/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/sourceRef"
- },
- "accountRef": {
- "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/accountRef"
- },
- "modifiedDate": {
- "description": "The date the bank transaction was last modified.",
- "$ref": "#/components/schemas/DateTime"
- }
- }
- },
- "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": {
+ "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/AgedCurrencyOutstanding/properties/currency",
+ "description": "The currency code for bank transaction."
+ },
"transactionCategory": {
- "confidence": 92.7,
- "levels": [
- "Asset",
- "Current",
- "Bank",
- "BankTransfers",
- "ShareholderTransfers"
- ],
- "confidences": [
- 92.7,
- 95,
- 96,
- 97.5,
- 100
+ "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": [
@@ -120200,6 +120882,67 @@
"value"
]
},
+ "ReportOperation": {
+ "title": "Report",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique identifier of the report",
+ "example": "52c0f26b-051a-43ff-b02a-258eec67f5ef"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "InProgress",
+ "Complete",
+ "Error"
+ ],
+ "description": "The status of the report generation"
+ },
+ "reportName": {
+ "type": "string",
+ "enum": [
+ "categorizedBankStatement"
+ ],
+ "description": "The name of the report generated"
+ },
+ "requested": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "updated": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "description": "Information about a report generation",
+ "definitions": {
+ "reports": {
+ "title": "Report Operations",
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ReportOperation"
+ },
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ }
+ },
+ {
+ "$ref": "#/components/schemas/PagingInfo"
+ }
+ ]
+ }
+ }
+ },
+ "ReportOperations": {
+ "$ref": "#/components/schemas/ReportOperation/definitions/reports"
+ },
"StartUploadSessionRequest": {
"title": "Upload session start request",
"type": "object",
@@ -120685,6 +121428,48 @@
"auth/get"
]
}
+ },
+ "reportType": {
+ "name": "reportType",
+ "description": "The type of the report",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "categorizedBankStatement"
+ ]
+ }
+ },
+ "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": {
@@ -120942,7 +121727,7 @@
"securitySchemes": {
"auth_header": {
"name": "Authorization",
- "description": "The word \"Basic\" followed by a space and your API key. [API keys](https://docs.codat.io/lending-api#/schemas/apiKeys) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/codat-api#/api-keys/api-keys-list), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.",
+ "description": "The word \"Basic\" followed by a space and your API key. [API keys](https://docs.codat.io/accounting-api#/schemas/apiKeys) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/codat-api#/api-keys/api-keys-list), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.",
"type": "apiKey",
"in": "header",
"x-speakeasy-example": "Basic BASE_64_ENCODED(API_KEY)"
@@ -120955,6 +121740,357 @@
"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"
+ }
+ ]
+ }
+ ]
+ }
}
}
}