Assess API
Codat's Assess API enable you to make smarter credit decisions on your small business customers. Assess enriches your customer's accounting, commerce and…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 27
Data integrity
- GETLists data integrity details for date type
/data/companies/:companyId/assess/dataTypes/:dataType/dataIntegrity/details?page=1&pageSize=100&query=string&orderBy=-modifiedDateGets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string. - GETGet data integrity status
/data/companies/:companyId/assess/dataTypes/:dataType/dataIntegrity/statusGets match status for a given company and datatype. - GETGet data integrity summary
/data/companies/:companyId/assess/dataTypes/:dataType/dataIntegrity/summaries?query=stringGets match summary for a given company and datatype, optionally restricted by a Codat query string.
Reports
- GETEnhanced Balance Sheet Accounts
/companies/:companyId/reports/enhancedBalanceSheet/accounts?reportDate=29-09-2020&numberOfPeriods=0The Enhanced Balance Sheet Accounts endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per… - GETGet enhanced cash flow report
/companies/:companyId/reports/enhancedCashFlow/transactions?page=1&pageSize=100&query=stringThe Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are… - GETEnhanced Invoices Report
/companies/:companyId/reports/enhancedInvoices?page=1&pageSize=100&query=stringGets a list of invoices linked to the corresponding banking transaction - GETEnhanced Profit and Loss Accounts
/companies/:companyId/reports/enhancedProfitAndLoss/accounts?reportDate=29-09-2020&numberOfPeriods=0The Enhanced Profit and Loss Accounts endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss. It also includes a balance… - GETGet the customer retention metrics for a specific company.
/data/companies/:companyId/connections/:connectionId/assess/commerceMetrics/customerRetention?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&periodUnit=Day&includeDisplayNames=trueGets the customer retention metrics for a specific company connection, over one or more periods of time. - GETGet the lifetime value metric for a specific company.
/data/companies/:companyId/connections/:connectionId/assess/commerceMetrics/lifetimeValue?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&periodUnit=Day&includeDisplayNames=trueGets the lifetime value metric for a specific company connection, over one or more periods of time. - GETGet order information for a specific company
/data/companies/:companyId/connections/:connectionId/assess/commerceMetrics/orders?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&periodUnit=Day&includeDisplayNames=trueGets the order information for a specific company connection, over one or more periods of time. - GETGet the refunds information for a specific company
/data/companies/:companyId/connections/:connectionId/assess/commerceMetrics/refunds?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&periodUnit=Day&includeDisplayNames=trueGets the refunds information for a specific company connection, over one or more periods of time. - GETCommerce Revenue Metrics
/data/companies/:companyId/connections/:connectionId/assess/commerceMetrics/revenue?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&periodUnit=Day&includeDisplayNames=trueGet the revenue and revenue growth for a specific company connection, over one or more periods of time. - GETEnhanced Balance Sheet
/data/companies/:companyId/connections/:connectionId/assess/enhancedBalanceSheet?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&includeDisplayNames=trueDeprecated. Gets a fully categorized balance sheet statement for a given company, over one or more period(s). - GETEnhanced Profit and Loss
/data/companies/:companyId/connections/:connectionId/assess/enhancedProfitAndLoss?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&includeDisplayNames=trueDeprecated. Gets a fully categorized profit and loss statement for a given company, over one or more period(s). - GETList financial metrics
/data/companies/:companyId/connections/:connectionId/assess/financialMetrics?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&showMetricInputs=trueDeprecated. Gets all the available financial metrics for a given company, over one or more periods. - GETGet key metrics for subscription revenue
/data/companies/:companyId/connections/:connectionId/assess/subscriptions/mrrGets key metrics for subscription revenue. - GETRequest production of key subscription revenue metrics
/data/companies/:companyId/connections/:connectionId/assess/subscriptions/processRequest production of key subscription revenue metrics.
Excel reports
- GETGet status of Excel report
/data/companies/:companyId/assess/excel?reportType=auditReturns the status of the latest report requested. - POSTGenerate an Excel report
/data/companies/:companyId/assess/excel?reportType=auditGenerate an Excel report which can subsequently be downloaded. - GETDownload generated excel report
/data/companies/:companyId/assess/excel/download?reportType=auditDownload the previously generated Excel report to a local drive. - POSTDownload generated excel report
/data/companies/:companyId/assess/excel/download?reportType=auditDeprecated. Download the previously generated Excel report to a local drive. - GETGet the marketing metrics from an accounting source for a given company.
/data/companies/:companyId/connections/:connectionId/assess/accountingMetrics/marketing?reportDate=29-09-2020&periodLength=0&numberOfPeriods=0&periodUnit=Day&includeDisplayNames=true&showInputValues=trueRequest an Excel report for download.
Categories
- GETList account categories
/data/assess/accounts/categoriesDeprecated. Lists available account categories Codat's categorisation engine can provide. - GETList suggested and confirmed account categories
/data/companies/:companyId/connections/:connectionId/assess/accounts/categories?page=1&pageSize=100&query=string&orderBy=-modifiedDateDeprecated. Lists suggested and confirmed chart of account categories for the given company and data connection. - PATCHConfirm categories for accounts
/data/companies/:companyId/connections/:connectionId/assess/accounts/categoriesDeprecated. Comfirms the categories for all or a batch of accounts for a specific connection. - GETGet suggested and/or confirmed category for a specific account
/data/companies/:companyId/connections/:connectionId/assess/accounts/:accountId/categoriesDeprecated. Get category for specific nominal account. - PATCHPatch account categories
/data/companies/:companyId/connections/:connectionId/assess/accounts/:accountId/categoriesDeprecated. Update category for a specific nominal account
API details
- Base URL
https://api.codat.io- Authentication
- An API key in the Authorization header
- Operations
- 27 operations on 23 pathsGET 23POST 2PATCH 2
9 marked deprecated - Main resources
- Reports 14Categories 5Excel reports 5Data integrity 3
- Response formats
application/jsonapplication/octet-stream- Webhooks
- 1 described
- Description format
- OpenAPI 3.1.0, API version
1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Assess API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Assess API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists data integrity details for date type” (GET /data/companies/:companyId/assess/dataTypes/:dataType/dataIntegrity/details?page=1&pageSize=100&query=string&orderBy=-modifiedDate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Assess API?
Codat's Assess API enable you to make smarter credit decisions on your small business customers. Assess enriches your customer's accounting, commerce and… It is listed under Finance & banking and has 27 endpoints.
Who publishes the Assess API?
It is listed from Codat's public API description (an OpenAPI document), not published by Codat on Swastik Codes. Anyone who controls codat.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Assess API?
Requests go to https://api.codat.io. Endpoint paths are added to this base URL.
How do I authenticate with the Assess API?
With an API key in the Authorization header.
How many endpoints does the Assess API have?
27 operations on 23 paths (23 GET, 2 POST, 2 PATCH). The largest groups are Reports, Categories, Excel reports, Data integrity.
Is forking the Assess API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.