A flexible API for pulling accounting data, normalized and aggregated from 20 accounting integrations. Standardize how you connect to your customers’ accounting software. View, create, update, and delete data in the same way for all the leading accounting platforms. [Read more...](https://docs.cod
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.codat.io
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
A flexible API for pulling accounting data, normalized and aggregated from 20 accounting integrations. Standardize how you connect to your customers’ accounting software. View, create, update, and delete data in the same way for all the leading accounting platforms. [Read more...](https://docs.codat.io/accounting-api/overview) [See our OpenAPI spec](https://github.com/codatio/oas)
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies/{companyId}/connections/{connectionId}/data/accountTransactions | List account transactions Gets the account transactions for a given company. Account transactions |
GET | /companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId} | Get account transaction Gets the account transactions for a given company.Gets the specified account transacti |
GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts | List bank accounts Gets the list of bank accounts for a given connection Bank accounts |
GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId} | Get bank account Gets the bank account with a given ID Bank accounts |
GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions | List bank transactions for bank account Gets bank transactions for a given bank account ID Bank account transa |
GET | /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments | List bill attachments Get bill attachments Bills |
GET | /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId} | Get bill attachment Get bill attachment Bills |
GET | /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download | Download bill attachment Download bill attachment Bills |
GET | /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments | List customer attachments Get customer attachments Customers |
GET | /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId} | Get customer attachment Get customer attachment Customers |
GET | /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download | Download customer attachment Download customer attachment Customers |
GET | /companies/{companyId}/connections/{connectionId}/data/directCosts | List direct costs Gets the direct costs for the company. Direct costs |
GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId} | Get direct cost Gets the specified direct cost for a given company. Direct costs |
GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments | List direct cost attachments Gets all attachments for the specified direct cost for a given company. Direct co |
GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId} | Get direct cost attachment Gets the specified direct cost attachment for a given company. Direct costs |
GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download | Download direct cost attachment Downloads an attachment for the specified direct cost for a given company. Dir |
GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes | Get direct incomes Gets the direct incomes for a given company. Direct incomes |
GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId} | Get direct income Gets the specified direct income for a given company and connection. Direct incomes |
GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments | List direct income attachments Gets all attachments for the specified direct income for a given company. Direc |
GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId} | Get direct income attachment Gets the specified direct income attachment for a given company. Direct incomes |
GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download | Download direct income attachment Downloads an attachment for the specified direct income for a given company. |
GET | /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments | Get invoice attachments Get invoice attachments Invoices |
GET | /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId} | Get invoice attachment Get invoice attachment Invoices |
GET | /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download | Download invoice attachment Download invoice attachments Invoices |
GET | /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments | List supplier attachments Get supplier attachments Suppliers |
GET | /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId} | Get supplier attachment Get supplier attachment Suppliers |
GET | /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download | Download supplier attachment Download supplier attachment Suppliers |
GET | /companies/{companyId}/connections/{connectionId}/data/transfers | List transfers Gets the transfers for a given company. Transfers |
GET | /companies/{companyId}/connections/{connectionId}/data/transfers/{transferId} | Get transfer Gets the specified transfer for a given company. Transfers |
GET | /companies/{companyId}/connections/{connectionId}/options/bankAccounts | Get create/update bank account model Get create/update bank account model. Returns the expected data for the r |
GET | /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions | List push options for bank account bank transactions Gets the options of pushing bank account transactions. Ba |
GET | /companies/{companyId}/connections/{connectionId}/options/billCreditNotes | Get create/update bill credit note model Get create/update bill credit note model. > **Supported Integrations |
GET | /companies/{companyId}/connections/{connectionId}/options/billPayments | Get create bill payment model Get create bill payment model. > **Supported Integrations** > > Check out our |
GET | /companies/{companyId}/connections/{connectionId}/options/bills | Get create/update bill model Get create/update bill model. > **Supported Integrations** > > Check out our [ |
GET | /companies/{companyId}/connections/{connectionId}/options/chartOfAccounts | Get create account model Get create account model. Returns the expected data for the request payload. See the |
GET | /companies/{companyId}/connections/{connectionId}/options/creditNotes | Get create/update credit note model Get create/update credit note model. Returns the expected data for the req |
GET | /companies/{companyId}/connections/{connectionId}/options/customers | Get create/update customer model Get create/update customer model. Returns the expected data for the request p |
GET | /companies/{companyId}/connections/{connectionId}/options/directCosts | Get create direct cost model Get create direct cost model. Returns the expected data for the request payload. |
GET | /companies/{companyId}/connections/{connectionId}/options/directIncomes | Get create direct income model Get create direct income model. Returns the expected data for the request paylo |
GET | /companies/{companyId}/connections/{connectionId}/options/invoices | Get create/update invoice model Get create/update invoice model. Returns the expected data for the request pay |
and 87 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Accounting.json
Codat's Assess API enable you to make smarter credit decisions on your small business customers. Assess enriches your customer's accounting, commerce and banking data to surface actionable insights you didn't have before. [Read more...](https://www.codat.io/assess/) [See our OpenAPI spec](https://github.com/codatio/oas)
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies/{companyId}/reports/enhancedBalanceSheet/accounts | Enhanced Balance Sheet Accounts The Enhanced Balance Sheet Accounts endpoint returns a list of categorized acc |
GET | /companies/{companyId}/reports/enhancedCashFlow/transactions | Get enhanced cash flow report The Enhanced Cash Flow Transactions endpoint provides a fully categorized list o |
GET | /companies/{companyId}/reports/enhancedInvoices | Enhanced Invoices Report Gets a list of invoices linked to the corresponding banking transaction Reports |
GET | /companies/{companyId}/reports/enhancedProfitAndLoss/accounts | Enhanced Profit and Loss Accounts The Enhanced Profit and Loss Accounts endpoint returns a list of categorized |
GET | /data/assess/accounts/categories | List account categories Lists available account categories Codat's categorisation engine can provide. Categori |
GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details | Lists data integrity details for date type Gets record-by-record match results for a given company and datatyp |
GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status | Get data integrity status Gets match status for a given company and datatype. Data integrity |
GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries | Get data integrity summary Gets match summary for a given company and datatype, optionally restricted by a Cod |
GET | /data/companies/{companyId}/assess/excel | Get status of Excel report Returns the status of the latest report requested. Excel reports |
POST | /data/companies/{companyId}/assess/excel | Generate an Excel report Generate an Excel report which can subsequently be downloaded. Excel reports |
GET | /data/companies/{companyId}/assess/excel/download | Download generated excel report Download the previously generated Excel report to a local drive. Excel reports |
POST | /data/companies/{companyId}/assess/excel/download | Download generated excel report Download the previously generated Excel report to a local drive. Excel reports |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing | Get the marketing metrics from an accounting source for a given company. Request an Excel report for download. |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories | List suggested and confirmed account categories Lists suggested and confirmed chart of account categories for |
PATCH | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories | Confirm categories for accounts Comfirms the categories for all or a batch of accounts for a specific connecti |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories | Get suggested and/or confirmed category for a specific account Get category for specific nominal account. Cate |
PATCH | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories | Patch account categories Update category for a specific nominal account Categories |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention | Get the customer retention metrics for a specific company. Gets the customer retention metrics for a specific |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue | Get the lifetime value metric for a specific company. Gets the lifetime value metric for a specific company co |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders | Get order information for a specific company Gets the order information for a specific company connection, ove |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds | Get the refunds information for a specific company Gets the refunds information for a specific company connect |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue | Commerce Revenue Metrics Get the revenue and revenue growth for a specific company connection, over one or mor |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/enhancedBalanceSheet | Enhanced Balance Sheet Gets a fully categorized balance sheet statement for a given company, over one or more |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/enhancedProfitAndLoss | Enhanced Profit and Loss Gets a fully categorized profit and loss statement for a given company, over one or m |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/financialMetrics | List financial metrics Gets all the available financial metrics for a given company, over one or more periods. |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr | Get key metrics for subscription revenue Gets key metrics for subscription revenue. Reports |
GET | /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/process | Request production of key subscription revenue metrics Request production of key subscription revenue metrics. |
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Assess.json
The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to provide high-quality integrations with numerous accounting platform through standardized API, seamlessly transforming business sale's data into accounting artefacts. [Read More...](https://docs.codat.io/sfc/overview)
| method | path | what the vendor says it does |
|---|---|---|
GET | /clients/{clientId}/config/ui/accounts/platform/{platformKey} | List visible accounts Enable retrieval for accounts which are visible on sync flow. Sync flow preferences |
POST | /companies/{companyId}/sync/commerce/latest | Run a Commerce sync from the last successful sync Run a Commerce sync from the last successful sync up to the |
GET | /config/companies/{companyId}/sync/commerce | Retrieve config preferences set for a company. Retrieve current config preferences. Configuration |
POST | /config/companies/{companyId}/sync/commerce | Create or update configuration. Make changes to configuration preferences. Configuration |
GET | /config/integrations | List information on Codat's supported integrations Retrieve a list of available integrations support by dataty |
GET | /config/integrations/{platformKey}/branding | Get branding for an integration Retrieve Integration branding assets. Integrations |
GET | /config/sync/commerce/{commerceKey}/{accountingKey}/start | Retrieve sync flow url Get a URL for Sync Flow including a one time passcode. Sync flow preferences |
GET | /meta/companies | List companies Retrieve a list of all companies the client has created. Company management |
POST | /meta/companies/sync | Create a sync for commerce company Creates a Codat company with a commerce partner data connection. Company ma |
GET | /meta/companies/{companyId}/connections | List data connections Retrieve previously created data connections. Company management |
POST | /meta/companies/{companyId}/connections | Create a data connection Create a data connection for company. Company management |
PATCH | /meta/companies/{companyId}/connections/{connectionId} | Update data connection Update a data connection Company management |
POST | /meta/companies/{companyId}/sync/commerce/historic | Run a Commerce sync from a given date range Run a Commerce sync from the specified start date to the specified |
GET | /meta/companies/{companyId}/sync/commerce/status | Get status for a company's syncs Check the sync history and sync status for a company. Configuration |
PATCH | /sync/commerce/config/ui/accounts/platform/{commerceKey} | Update the visible accounts on Sync Flow To enable update of accounts visible preferences set on Sync Flow. Sy |
GET | /sync/commerce/config/ui/text | Retrieve preferences for text fields on Sync Flow To enable retrieval of preferences set for the text fields o |
PATCH | /sync/commerce/config/ui/text | Update preferences for text fields on sync flow To enable update of preferences set for the text fields on syn |
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Sync-Commerce.json
The API for Sync for Expenses. Sync for Expenses is an API and a set of supporting tools. It has been built to enable corporate card and expense management platforms to provide high-quality integrations with multiple accounting platforms through a standardized API. [Read more...](https://docs.codat.io/sync-for-expenses/overview) [See our OpenAPI spec](https://github.com/codatio/oas)
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies/{companyId}/sync/expenses/config | Get company configuration Gets a companies expense sync configuration Configuration |
POST | /companies/{companyId}/sync/expenses/config | Set company configuration Sets a companies expense sync configuration Configuration |
POST | /companies/{companyId}/sync/expenses/connections/partnerExpense | Create Partner Expense connection Creates a Partner Expense data connection Connections |
POST | /companies/{companyId}/sync/expenses/data/expense-transactions | Create expense-transactions Create an expense transaction Expenses |
GET | /companies/{companyId}/sync/expenses/mappingOptions | Mapping options Gets the expense mapping options for a companies accounting software Mapping options |
POST | /companies/{companyId}/sync/expenses/syncs | Initiate sync Initiate sync of pending transactions. Sync |
GET | /companies/{companyId}/sync/expenses/syncs/lastSuccessful/status | Last successful sync Gets the status of the last successfull sync Sync status |
GET | /companies/{companyId}/sync/expenses/syncs/latest/status | Latest sync status Gets the latest sync status Sync status |
GET | /companies/{companyId}/sync/expenses/syncs/list/status | List sync statuses Gets a list of sync statuses Sync status |
GET | /companies/{companyId}/sync/expenses/syncs/{syncId}/status | Get Sync status Get the sync status for a specified sync Sync status |
GET | /companies/{companyId}/sync/expenses/syncs/{syncId}/transactions | Get Sync transactions Get's the transactions and status for a sync Transaction status |
GET | /companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId} | Get Sync Transaction Gets the status of a transaction for a sync Transaction status |
POST | /companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments | Upload attachment Creates an attachment in the accounting software against the given transactionId Expenses |
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Expenses.json
Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems. Standardize how you connect to your customers’ payment, PoS, and eCommerce systems. Retrieve orders, payouts, payments, and product data in the same way for all the leading commerce platforms. [Read more...](https://docs.codat.io/commerce-api/overview) [See our OpenAPI spec](https://github.com/cod
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-customers | List customers List all commerce customers for the given company and data connection Customers |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-disputes | List disputes List commerce disputes Disputes |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-info | Get company info Retrieve information about the company, as seen in the commerce platform. This may include i |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-locations | List locations Retrieve a list of locations as seen in the commerce platform. A `location` is a geographic pl |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-orders | List orders Get a list of orders placed or held on the linked commerce platform Orders |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods | List payment methods Retrieve a list of payment methods, such as card, cash or other online payment methods, a |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-payments | List payments List commerce payments for the given company & data connection. Payments |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-productCategories | List product categories Product categories are used to classify a group of products together, either by type ( |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-products | List products The Products data type provides the company's product inventory, and includes the price and quan |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-taxComponents | List tax components This endpoint returns a lits of tax rates from the commerce platform, including tax rate n |
GET | /companies/{companyId}/connections/{connectionId}/data/commerce-transactions | List transactions Details of all financial transactions recorded in the commerce or point of sale system are a |
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Commerce.json
Codat's Banking API allows you to access standardised data from over bank accounts via third party providers. Standardize how you connect to your customers’ bank accounts. Retrieve bank account and bank transaction data in the same way via our partnerships with Plaid and TrueLayer. [Read more...](https://docs.codat.io/banking-api/overview) [See our OpenAPI spec](https://github.com/codatio/oas)
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances | List account balances Gets a list of balances for a bank account including end-of-day batch balance or running |
GET | /companies/{companyId}/connections/{connectionId}/data/banking-accounts | List accounts Gets a list of all bank accounts of the SMB, with rich data like balances, account numbers and i |
GET | /companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId} | Get account Gets a specified bank account for a given company Accounts |
GET | /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories | List all transaction categories Gets a list of hierarchical categories associated with a transaction for great |
GET | /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId} | Get transaction category Gets a specified bank transaction category for a given company Transaction categories |
GET | /companies/{companyId}/connections/{connectionId}/data/banking-transactions | List transactions Gets a list of transactions incurred by a bank account. Transactions |
GET | /companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId} | Get bank transaction Gets a specified bank transaction for a given company Transactions |
GET | /companies/{companyId}/data/banking-transactions | List banking transactions Gets a list of transactions incurred by a company across all bank accounts. Transact |
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Banking.json
Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms. A bank feed is a connection between a source bank account—in your application—and a target bank account in a supported accounting package. [Read more...](https://docs.codat.io/bank-feeds-api/overview) [See our OpenAPI spec](https://github.com/codatio/oas)
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts | List bank feed bank accounts Get BankFeed BankAccounts for a single data source connected to a single company. |
PUT | /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts | Create bank feed bank accounts Put BankFeed BankAccounts for a single data source connected to a single compan |
PATCH | /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{accountId} | Update bank feed bank account Update a single BankFeed BankAccount for a single data source connected to a sin |
GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions | List bank transactions for bank account Gets bank transactions for a given bank account ID Bank account transa |
GET | /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions | List push options for bank account bank transactions Gets the options of pushing bank account transactions. Ba |
POST | /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions | Create bank transactions Posts bank transactions to the accounting package for a given company. > **Supported |
specification origin: https://raw.githubusercontent.com/codatio/oas/main/json/Codat-Bank-Feeds.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.