From b306255cce8323bc68f0d4b7c811c2dceb0434cf Mon Sep 17 00:00:00 2001 From: Codat Pipeline Bot Date: Wed, 21 Oct 2026 09:22:46 +0000 Subject: [PATCH 1/2] Latest Open API Specification --- static/oas/Codat-Assess.json | 792 +--------------------------- static/oas/Codat-Lending.json | 949 ++++++---------------------------- 2 files changed, 159 insertions(+), 1582 deletions(-) diff --git a/static/oas/Codat-Assess.json b/static/oas/Codat-Assess.json index ffed0001c4..0b01c2422c 100644 --- a/static/oas/Codat-Assess.json +++ b/static/oas/Codat-Assess.json @@ -1395,71 +1395,6 @@ ] } }, - "/companies/{companyId}/reports/enhancedCashFlow/transactions": { - "parameters": [ - { - "$ref": "#/components/parameters/companyId" - } - ], - "get": { - "summary": "Get enhanced cash flow report", - "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.", - "tags": [ - "Reports" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions" - }, - "example": { - "$ref": "#/components/examples/EnhancedCashflowExample" - } - } - } - }, - "400": { - "$ref": "#/components/responses/Malformed-Query" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "402": { - "$ref": "#/components/responses/Payment-Required" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/Not-Found" - }, - "429": { - "$ref": "#/components/responses/Too-Many-Requests" - }, - "500": { - "$ref": "#/components/responses/Internal-Server-Error" - }, - "503": { - "$ref": "#/components/responses/Service-Unavailable" - } - }, - "operationId": "get-enhanced-cash-flow-transactions", - "parameters": [ - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/pageSize" - }, - { - "$ref": "#/components/parameters/query" - } - ] - } - }, "/companies/{companyId}/reports/enhancedInvoices": { "parameters": [ { @@ -3644,374 +3579,6 @@ } ] }, - "EnhancedCashFlowTransactions": { - "title": "Enhanced cash flow 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.", - "type": "object", - "properties": { - "reportInfo": { - "$ref": "#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo" - }, - "dataSources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/dataSource" - } - }, - "reportItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem" - } - } - }, - "definitions": { - "dataSource": { - "type": "object", - "properties": { - "accounts": { - "description": "An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts" - } - } - } - }, - "accounts": { - "title": "Accounts", - "type": "object", - "properties": { - "sourceRef": { - "title": "Report source reference", - "description": "A source reference containing the `sourceType` object \"Banking\".", - "type": "object", - "properties": { - "sourceType": { - "description": "The data source type.", - "type": "string" - } - }, - "examples": [ - { - "Example": { - "value": { - "sourceRef": { - "sourceType": "Banking" - } - } - } - } - ] - }, - "platformName": { - "description": "Name of the banking data source, e.g. \"Plaid\".", - "type": "string" - }, - "accountProvider": { - "description": "The bank or other financial institution providing the account.", - "type": "string" - }, - "accountName": { - "description": "The name of the account according to the provider.", - "type": "string" - }, - "accountType": { - "description": "The type of banking account, e.g. credit or debit.", - "type": "string" - }, - "currency": { - "$ref": "#/components/schemas/Currency", - "description": "The currency code for the bank account." - }, - "currentBalance": { - "description": "The balance of the bank account.", - "type": "number", - "format": "decimal" - } - } - }, - "enhancedCashFlowItem": { - "type": "object", - "properties": { - "transactions": { - "description": "An array of transaction data.", - "type": "array", - "items": { - "title": "Cash flow transaction", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the bank transaction.", - "type": "string" - }, - "date": { - "description": "The date the bank transaction was posted.", - "$ref": "#/components/schemas/EnhancedInvoicesReport/definitions/payment/properties/date" - }, - "description": { - "description": "The description of the bank transaction.", - "type": "string" - }, - "amount": { - "description": "The bank transaction amount.", - "type": "number", - "format": "decimal" - }, - "currency": { - "$ref": "#/components/schemas/Currency", - "description": "The currency code for bank transaction." - }, - "transactionCategory": { - "description": "Contains an array of category levels.", - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/transactionCategory" - }, - "platformName": { - "description": "Returns the payment processor responsible for the transaction.", - "type": "string" - }, - "counterpartyNames": { - "description": "An array of counterparty names involved in the transaction.", - "type": "array", - "items": { - "type": "string" - } - }, - "sourceRef": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef" - }, - "accountRef": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/accountRef" - }, - "modifiedDate": { - "description": "The date the bank transaction was last modified.", - "$ref": "#/components/schemas/EnhancedInvoicesReport/definitions/payment/properties/date" - }, - "isRecurring": { - "description": "Indicates if the transaction is classified as recurring by Codat's categorization engine.", - "type": "boolean", - "nullable": true - } - }, - "definitions": { - "accountRef": { - "title": "Account reference", - "description": "An account reference containing the account id and name.", - "type": "object", - "properties": { - "id": { - "description": "The id of the account.", - "type": "string" - }, - "name": { - "description": "The name of the account.", - "type": "string" - } - }, - "examples": [ - { - "Example": { - "value": { - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - } - } - } - } - ] - }, - "transactionCategory": { - "title": "Transaction category", - "type": "object", - "properties": { - "confidence": { - "description": "Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100.", - "type": "number", - "format": "decimal" - }, - "confidences": { - "description": "An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array.", - "type": "array", - "items": { - "type": "number", - "format": "decimal" - } - }, - "levels": { - "description": "The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "examples": [ - { - "Example": { - "value": { - "transactionCategory": { - "confidence": 92.7, - "levels": [ - "Asset", - "Current", - "Bank", - "BankTransfers", - "ShareholderTransfers" - ], - "confidences": [ - 92.7, - 95, - 96, - 97.5, - 100 - ] - } - } - } - } - ] - } - } - } - } - } - } - }, - "examples": [ - { - "reportInfo": { - "pageNumber": 1, - "pageSize": 100, - "totalResults": 2401, - "reportName": "Cash Flow transactions report", - "companyName": "Example Company", - "generatedDate": "2023-01-25T22:36:05.125Z" - }, - "dataSources": [ - { - "accounts": [ - { - "sourceRef": { - "sourceType": "Banking" - }, - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "platformName": "Plaid", - "accountProvider": "Bank of Sandbox", - "accountName": "Business Current Account", - "accountType": "Debit", - "currency": "USD", - "currentBalance": 1000, - "identifiers": [ - { - "type": "Debit", - "subType": "Current", - "number": 12345678, - "bankCode": 123456, - "iban": "US123456789", - "bic": "US123456789", - "maskedAccountNumber": 1234 - } - ] - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "id": "12345678-1234-1234-1234-123456789012", - "platformName": "Plaid", - "accountProvider": "Bank of Sandbox", - "accountName": "Business Saving Account", - "accountType": "Debit", - "currency": "USD", - "currentBalance": 5321, - "identifiers": [ - { - "type": "Debit", - "subType": "Saving", - "number": 87654321, - "bankCode": 654321, - "iban": "US987654321", - "bic": "US987654321", - "maskedAccountNumber": 4321 - } - ] - } - ] - } - ], - "reportItems": [ - { - "transactions": [ - { - "sourceRef": { - "sourceType": "Banking" - } - }, - { - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "date": "2023-01-25", - "description": "Payment to supplier", - "amount": 100, - "currency": "USD", - "transactionCategory": { - "confidence": 92.7, - "levels": [ - "Asset", - "Current", - "Bank" - ], - "confidences": [ - 92.7, - 95, - 96 - ] - }, - "platformName": "Plaid", - "counterpartyNames": [ - "Counterparty" - ], - "modifiedDate": "2023-01-25T22:36:05.125Z" - }, - { - "sourceRef": { - "sourceType": "Banking" - } - }, - { - "accountRef": { - "id": "12345678-1234-1234-1234-123456789012", - "name": "Business Saving Account" - }, - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "date": "2023-01-25", - "description": "Payment to supplier", - "amount": 100, - "currency": "USD", - "transactionCategory": null, - "confidence": 92.7, - "levels": [ - "Expense", - "Operating" - ], - "confidences": [ - 92.7, - 95 - ], - "platformName": "Plaid", - "counterpartyNames": [], - "modifiedDate": "2023-01-25T22:36:05.125Z" - } - ] - } - ] - } - ] - }, "EnhancedInvoicesReport": { "title": "Enhanced invoices report", "description": "The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by matching with the bank statement.", @@ -4561,8 +4128,7 @@ "enum": [ "audit", "enhancedFinancials", - "enhancedInvoices", - "enhancedCashFlow" + "enhancedInvoices" ], "description": "The type of the report requested in the query string." } @@ -5391,8 +4957,7 @@ "assess", "audit", "enhancedFinancials", - "enhancedInvoices", - "enhancedCashFlow" + "enhancedInvoices" ] }, "description": "The type of report you want to generate and download.", @@ -5659,359 +5224,6 @@ "in": "header", "x-speakeasy-example": "Basic BASE_64_ENCODED(API_KEY)" } - }, - "examples": { - "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" - } - ] - } - ] - } - } } } } diff --git a/static/oas/Codat-Lending.json b/static/oas/Codat-Lending.json index d104aabd17..bf20ecd9bd 100644 --- a/static/oas/Codat-Lending.json +++ b/static/oas/Codat-Lending.json @@ -3381,74 +3381,6 @@ ] } }, - "/companies/{companyId}/reports/enhancedCashFlow/transactions": { - "parameters": [ - { - "$ref": "#/components/parameters/companyId" - } - ], - "get": { - "summary": "Get categorized bank statement", - "operationId": "get-categorized-bank-statement", - "x-speakeasy-group": "banking.categorized-statement", - "description": "> **Categorization engine**\n>\n> The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.\n\nThe _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources.", - "tags": [ - "Bank statements" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions" - }, - "examples": { - "Categorized bank statement": { - "$ref": "#/components/examples/EnhancedCashflowExample" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/Malformed-Query" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "402": { - "$ref": "#/components/responses/Payment-Required" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/Not-Found" - }, - "429": { - "$ref": "#/components/responses/Too-Many-Requests" - }, - "500": { - "$ref": "#/components/responses/Internal-Server-Error" - }, - "503": { - "$ref": "#/components/responses/Service-Unavailable" - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/pageSize" - }, - { - "$ref": "#/components/parameters/query" - } - ] - } - }, "/companies/{companyId}/reports/enhancedInvoices": { "parameters": [ { @@ -4894,7 +4826,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` | 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` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. |\n| `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. |\n| `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. |\n\n[Learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) 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/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request.\n\n### Report types\n\n| reportType | Description |\n|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || [audit](https://docs.codat.io/lending/excel/audit-report) | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. |\n| `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. |\n| `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. |\n\n[Learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types.\n\n\n", "parameters": [ { "$ref": "#/components/parameters/excelReportType" @@ -116666,7 +116598,26 @@ "type": "string" }, "sourceRef": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef" + "title": "Report source reference", + "description": "A source reference containing the `sourceType` object \"Banking\".", + "type": "object", + "properties": { + "sourceType": { + "description": "The data source type.", + "type": "string" + } + }, + "examples": [ + { + "Example": { + "value": { + "sourceRef": { + "sourceType": "Banking" + } + } + } + } + ] }, "platformName": { "description": "Name of the banking data source, e.g. \"Plaid\".", @@ -116778,7 +116729,141 @@ "results": { "type": "array", "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items" + "title": "Cash flow transaction", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the bank transaction.", + "type": "string" + }, + "date": { + "description": "The date the bank transaction was posted.", + "$ref": "#/components/schemas/DateTime" + }, + "description": { + "description": "The description of the bank transaction.", + "type": "string" + }, + "amount": { + "description": "The bank transaction amount.", + "type": "number", + "format": "decimal" + }, + "currency": { + "$ref": "#/components/schemas/SourceAccount/properties/currency", + "description": "The currency code for bank transaction." + }, + "transactionCategory": { + "description": "Contains an array of category levels.", + "$ref": "#/components/schemas/CategorizedBankStatementTransactions/allOf/0/properties/results/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/CategorizedBankStatementAccounts/allOf/0/properties/results/items/properties/sourceRef" + }, + "accountRef": { + "$ref": "#/components/schemas/CategorizedBankStatementTransactions/allOf/0/properties/results/items/definitions/accountRef" + }, + "modifiedDate": { + "description": "The date the bank transaction was last modified.", + "$ref": "#/components/schemas/DateTime" + }, + "isRecurring": { + "description": "Indicates if the transaction is classified as recurring by Codat's categorization engine.", + "type": "boolean", + "nullable": true + } + }, + "definitions": { + "accountRef": { + "title": "Account reference", + "description": "An account reference containing the account id and name.", + "type": "object", + "properties": { + "id": { + "description": "The id of the account.", + "type": "string" + }, + "name": { + "description": "The name of the account.", + "type": "string" + } + }, + "examples": [ + { + "Example": { + "value": { + "accountRef": { + "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", + "name": "Business Current Account" + } + } + } + } + ] + }, + "transactionCategory": { + "title": "Transaction category", + "type": "object", + "properties": { + "confidence": { + "description": "Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100.", + "type": "number", + "format": "decimal" + }, + "confidences": { + "description": "An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array.", + "type": "array", + "items": { + "type": "number", + "format": "decimal" + } + }, + "levels": { + "description": "The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "examples": [ + { + "Example": { + "value": { + "transactionCategory": { + "confidence": 92.7, + "levels": [ + "Asset", + "Current", + "Bank", + "BankTransfers", + "ShareholderTransfers" + ], + "confidences": [ + 92.7, + 95, + 96, + 97.5, + 100 + ] + } + } + } + } + ] + } + } } } } @@ -119901,374 +119986,6 @@ } } }, - "EnhancedCashFlowTransactions": { - "title": "Enhanced cash flow 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.", - "type": "object", - "properties": { - "reportInfo": { - "$ref": "#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo" - }, - "dataSources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/dataSource" - } - }, - "reportItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem" - } - } - }, - "definitions": { - "dataSource": { - "type": "object", - "properties": { - "accounts": { - "description": "An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts" - } - } - } - }, - "accounts": { - "title": "Accounts", - "type": "object", - "properties": { - "sourceRef": { - "title": "Report source reference", - "description": "A source reference containing the `sourceType` object \"Banking\".", - "type": "object", - "properties": { - "sourceType": { - "description": "The data source type.", - "type": "string" - } - }, - "examples": [ - { - "Example": { - "value": { - "sourceRef": { - "sourceType": "Banking" - } - } - } - } - ] - }, - "platformName": { - "description": "Name of the banking data source, e.g. \"Plaid\".", - "type": "string" - }, - "accountProvider": { - "description": "The bank or other financial institution providing the account.", - "type": "string" - }, - "accountName": { - "description": "The name of the account according to the provider.", - "type": "string" - }, - "accountType": { - "description": "The type of banking account, e.g. credit or debit.", - "type": "string" - }, - "currency": { - "$ref": "#/components/schemas/SourceAccount/properties/currency", - "description": "The currency code for the bank account." - }, - "currentBalance": { - "description": "The balance of the bank account.", - "type": "number", - "format": "decimal" - } - } - }, - "enhancedCashFlowItem": { - "type": "object", - "properties": { - "transactions": { - "description": "An array of transaction data.", - "type": "array", - "items": { - "title": "Cash flow transaction", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the bank transaction.", - "type": "string" - }, - "date": { - "description": "The date the bank transaction was posted.", - "$ref": "#/components/schemas/DateTime" - }, - "description": { - "description": "The description of the bank transaction.", - "type": "string" - }, - "amount": { - "description": "The bank transaction amount.", - "type": "number", - "format": "decimal" - }, - "currency": { - "$ref": "#/components/schemas/SourceAccount/properties/currency", - "description": "The currency code for bank transaction." - }, - "transactionCategory": { - "description": "Contains an array of category levels.", - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/transactionCategory" - }, - "platformName": { - "description": "Returns the payment processor responsible for the transaction.", - "type": "string" - }, - "counterpartyNames": { - "description": "An array of counterparty names involved in the transaction.", - "type": "array", - "items": { - "type": "string" - } - }, - "sourceRef": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef" - }, - "accountRef": { - "$ref": "#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/accountRef" - }, - "modifiedDate": { - "description": "The date the bank transaction was last modified.", - "$ref": "#/components/schemas/DateTime" - }, - "isRecurring": { - "description": "Indicates if the transaction is classified as recurring by Codat's categorization engine.", - "type": "boolean", - "nullable": true - } - }, - "definitions": { - "accountRef": { - "title": "Account reference", - "description": "An account reference containing the account id and name.", - "type": "object", - "properties": { - "id": { - "description": "The id of the account.", - "type": "string" - }, - "name": { - "description": "The name of the account.", - "type": "string" - } - }, - "examples": [ - { - "Example": { - "value": { - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - } - } - } - } - ] - }, - "transactionCategory": { - "title": "Transaction category", - "type": "object", - "properties": { - "confidence": { - "description": "Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100.", - "type": "number", - "format": "decimal" - }, - "confidences": { - "description": "An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array.", - "type": "array", - "items": { - "type": "number", - "format": "decimal" - } - }, - "levels": { - "description": "The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "examples": [ - { - "Example": { - "value": { - "transactionCategory": { - "confidence": 92.7, - "levels": [ - "Asset", - "Current", - "Bank", - "BankTransfers", - "ShareholderTransfers" - ], - "confidences": [ - 92.7, - 95, - 96, - 97.5, - 100 - ] - } - } - } - } - ] - } - } - } - } - } - } - }, - "examples": [ - { - "reportInfo": { - "pageNumber": 1, - "pageSize": 100, - "totalResults": 2401, - "reportName": "Cash Flow transactions report", - "companyName": "Example Company", - "generatedDate": "2023-01-25T22:36:05.125Z" - }, - "dataSources": [ - { - "accounts": [ - { - "sourceRef": { - "sourceType": "Banking" - }, - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "platformName": "Plaid", - "accountProvider": "Bank of Sandbox", - "accountName": "Business Current Account", - "accountType": "Debit", - "currency": "USD", - "currentBalance": 1000, - "identifiers": [ - { - "type": "Debit", - "subType": "Current", - "number": 12345678, - "bankCode": 123456, - "iban": "US123456789", - "bic": "US123456789", - "maskedAccountNumber": 1234 - } - ] - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "id": "12345678-1234-1234-1234-123456789012", - "platformName": "Plaid", - "accountProvider": "Bank of Sandbox", - "accountName": "Business Saving Account", - "accountType": "Debit", - "currency": "USD", - "currentBalance": 5321, - "identifiers": [ - { - "type": "Debit", - "subType": "Saving", - "number": 87654321, - "bankCode": 654321, - "iban": "US987654321", - "bic": "US987654321", - "maskedAccountNumber": 4321 - } - ] - } - ] - } - ], - "reportItems": [ - { - "transactions": [ - { - "sourceRef": { - "sourceType": "Banking" - } - }, - { - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "date": "2023-01-25", - "description": "Payment to supplier", - "amount": 100, - "currency": "USD", - "transactionCategory": { - "confidence": 92.7, - "levels": [ - "Asset", - "Current", - "Bank" - ], - "confidences": [ - 92.7, - 95, - 96 - ] - }, - "platformName": "Plaid", - "counterpartyNames": [ - "Counterparty" - ], - "modifiedDate": "2023-01-25T22:36:05.125Z" - }, - { - "sourceRef": { - "sourceType": "Banking" - } - }, - { - "accountRef": { - "id": "12345678-1234-1234-1234-123456789012", - "name": "Business Saving Account" - }, - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "date": "2023-01-25", - "description": "Payment to supplier", - "amount": 100, - "currency": "USD", - "transactionCategory": null, - "confidence": 92.7, - "levels": [ - "Expense", - "Operating" - ], - "confidences": [ - 92.7, - 95 - ], - "platformName": "Plaid", - "counterpartyNames": [], - "modifiedDate": "2023-01-25T22:36:05.125Z" - } - ] - } - ] - } - ] - }, "EnhancedFinancialReport": { "title": "Enhanced report", "type": "object", @@ -120765,8 +120482,7 @@ "enum": [ "audit", "enhancedFinancials", - "enhancedInvoices", - "enhancedCashFlow" + "enhancedInvoices" ], "description": "The type of the report requested in the query string." } @@ -123185,357 +122901,6 @@ }, "summary": "Settings for uploading codat data" }, - "EnhancedCashflowExample": { - "value": { - "reportInfo": { - "pageNumber": 1, - "pageSize": 10, - "totalResults": 2194, - "reportName": "Cash flow transactions report", - "companyName": "test", - "generatedDate": "2023-03-24T16:44:17.5302732Z" - }, - "dataSources": [ - { - "accounts": [ - { - "sourceRef": { - "sourceType": "Banking" - }, - "platformName": "Banking Sandbox", - "accountProvider": "Lloyds Bank", - "accountName": "Business Savings Account", - "accountType": "Debit", - "currency": "GBP", - "currentBalance": 0 - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "platformName": "Banking Sandbox", - "accountProvider": "Lloyds Bank", - "accountName": "Banking - Business Credit Card", - "accountType": "Credit", - "currency": "GBP", - "currentBalance": 0 - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "platformName": "Banking Sandbox", - "accountProvider": "Lloyds Bank", - "accountName": "Business Undeposited Funds", - "accountType": "Debit", - "currency": "GBP", - "currentBalance": 0 - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "platformName": "Banking Sandbox", - "accountProvider": "Lloyds Bank", - "accountName": "Business Current Account", - "accountType": "Debit", - "currency": "GBP", - "currentBalance": 0 - } - ] - } - ], - "reportItems": [ - { - "transactions": [ - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "ab5e07a0-5578-4d91-8421-2dc72713b74f", - "date": "2022-11-08T00:00:00", - "description": "Payment m86SDGpQr3", - "amount": -6905.44, - "currency": "GBP", - "transactionCategory": { - "confidence": 52.53, - "levels": [ - "Expense", - "Operating" - ], - "confidences": [ - 56, - 52.53 - ] - }, - "platformName": "Shopify", - "counterpartyNames": [ - "Shopify" - ], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "9846bbed-46d3-472c-a848-1ce8ebea7213", - "date": "2022-11-08T00:00:00", - "description": "Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4", - "amount": 4332.84, - "currency": "GBP", - "transactionCategory": { - "confidence": 88, - "levels": [ - "Expense" - ], - "confidences": [ - 88 - ] - }, - "platformName": "Amazon", - "counterpartyNames": [ - "Amazon", - "Amazon Marketplace" - ], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "809b9470-c9fa-4257-bc9f-06a1dc7b0cbc", - "name": "Business Undeposited Funds" - }, - "id": "94b213fb-d742-435e-90f1-bfe723a076d5", - "date": "2022-11-08T00:00:00", - "description": "Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4", - "amount": 4034.3, - "currency": "GBP", - "transactionCategory": { - "confidence": 61.08, - "levels": [ - "Income", - "Revenue" - ], - "confidences": [ - 65, - 61.08 - ] - }, - "platformName": "Shopify", - "counterpartyNames": [], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "cfceb7ff-eaa2-45b6-aca7-fa0e0b439161", - "date": "2022-11-08T00:00:00", - "description": "Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e", - "amount": -313.76, - "currency": "GBP", - "transactionCategory": { - "confidence": 40.98, - "levels": [ - "Expense", - "CostOfSales" - ], - "confidences": [ - 40.98, - 99.9 - ] - }, - "platformName": "Amazon", - "counterpartyNames": [], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "809b9470-c9fa-4257-bc9f-06a1dc7b0cbc", - "name": "Business Undeposited Funds" - }, - "id": "ba814f14-0fe3-41d0-9308-57f40642ac75", - "date": "2022-11-08T00:00:00", - "description": "Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e", - "amount": -614.4, - "currency": "GBP", - "transactionCategory": { - "confidence": 55.84, - "levels": [ - "Income", - "Revenue" - ], - "confidences": [ - 55.84, - 75.5 - ] - }, - "platformName": "Zettle", - "counterpartyNames": [], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6", - "date": "2022-11-08T00:00:00", - "description": "Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4", - "amount": 5199.62, - "currency": "GBP", - "transactionCategory": { - "confidence": 57.85, - "levels": [ - "Expense" - ], - "confidences": [ - 57.85 - ] - }, - "platformName": "Amazon", - "counterpartyNames": [], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a", - "name": "Business Current Account" - }, - "id": "e0f08a0b-3575-4dde-98c4-3c854028d2d2", - "date": "2022-11-08T00:00:00", - "description": "Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa", - "amount": -21420.94, - "currency": "GBP", - "transactionCategory": { - "confidence": 70.58, - "levels": [ - "Expense", - "Operating" - ], - "confidences": [ - 70.58, - 100 - ] - }, - "platformName": "Amazon", - "counterpartyNames": [], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "809b9470-c9fa-4257-bc9f-06a1dc7b0cbc", - "name": "Business Undeposited Funds" - }, - "id": "4b70d379-8284-4f44-bb37-c7935df950cc", - "date": "2022-11-08T00:00:00", - "description": "Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449", - "amount": -30924.22, - "currency": "GBP", - "transactionCategory": { - "confidence": 48.26, - "levels": [ - "Income" - ], - "confidences": [ - 48.26 - ] - }, - "platformName": "DoorDash", - "counterpartyNames": [], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "809b9470-c9fa-4257-bc9f-06a1dc7b0cbc", - "name": "Business Undeposited Funds" - }, - "id": "76b73373-9345-472e-8edf-5be849d797fe", - "date": "2022-11-08T00:00:00", - "description": "Payment to supplier bQATU4eSb9", - "amount": -568.78, - "currency": "GBP", - "transactionCategory": { - "confidence": 65.21, - "levels": [ - "Income", - "Revenue" - ], - "confidences": [ - 65.21, - 100 - ] - }, - "platformName": "Uber", - "counterpartyNames": [ - "Uber" - ], - "modifiedDate": "2022-11-08T12:00:00" - }, - { - "sourceRef": { - "sourceType": "Banking" - }, - "accountRef": { - "id": "809b9470-c9fa-4257-bc9f-06a1dc7b0cbc", - "name": "Business Undeposited Funds" - }, - "id": "ee92fd6f-e0f7-4391-85fd-4b50921b973f", - "date": "2022-11-08T00:00:00", - "description": "Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd", - "amount": -13050.79, - "currency": "GBP", - "transactionCategory": { - "confidence": 92.33, - "levels": [ - "Income", - "Revenue" - ], - "confidences": [ - 92.33, - 92.33 - ] - }, - "platformName": "DoorDash", - "counterpartyNames": [ - "DoorDash" - ], - "modifiedDate": "2022-11-08T12:00:00" - } - ] - } - ] - } - }, "SingleReportExample": { "value": { "id": "6e9bae88-72c9-45ae-abe8-41fbf2871458", From 54e7ac8baa76e9acc4a56c3eba347a429d577892 Mon Sep 17 00:00:00 2001 From: Codat Pipeline Bot Date: Thu, 22 Oct 2026 15:57:05 +0000 Subject: [PATCH 2/2] Latest Open API Specification --- static/oas/Codat-Sync-Expenses.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/oas/Codat-Sync-Expenses.json b/static/oas/Codat-Sync-Expenses.json index 89940e14aa..d12cb4ba21 100644 --- a/static/oas/Codat-Sync-Expenses.json +++ b/static/oas/Codat-Sync-Expenses.json @@ -2129,7 +2129,7 @@ } }, "operationId": "update-expense-transaction", - "description": "The *Update expense* endpoint updates an existing [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) in the accounting software for a given company's connection. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. \n\n### Supported integrations\nThe following integrations are supported for the [Payment](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) transaction `type` only: \n| Integration | Supported |\n|-----------------------|-----------|\n| FreeAgent | Yes |\n| QuickBooks Desktop | Yes |\n| QuickBooks Online | Yes |\n| Oracle NetSuite | Yes |\n| Sage Intacct | Yes |\n| Xero | Yes |\n| Zoho Books | Yes |\n\n#### Integration-specific behavior\n\n| Integration | Specifics |\n|-----------------------|-----------|\n| Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.|", + "description": "The *Update expense* endpoint updates an existing [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) in the accounting software for a given company's connection. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. \n\n### Supported integrations\nThe following integrations are supported for each [transaction](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) `type`. The `Reward` and `Chargeback` transaction types are not supported for any integration.\n\n| Integration | Payment | Refund |\n|-----------------------|---------|--------|\n| FreeAgent | Yes | No |\n| QuickBooks Desktop | Yes | Yes |\n| QuickBooks Online | Yes | Yes |\n| Oracle NetSuite | Yes | No |\n| Sage Intacct | Yes | No |\n| Xero | Yes | No |\n| Zoho Books | Yes | No |\n\n#### Integration-specific behavior\n\n| Integration | Specifics |\n|-----------------------|-----------|\n| QuickBooks Desktop | `Refund` updates are supported for credit card accounts only. |\n| Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.|", "requestBody": { "content": { "application/json": {