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. [Read more...](https://www.codat.io/assess/) [See our OpenAPI spec](https://github.com/codatio/oas)
Assess API is a finance API from codat.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 27 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Finance
- Base URL
https://api.codat.io- Version
- 1.0
- Endpoints
- 27
- OpenAPI
- Specification ↗
- Spec updated
- 2023-04-18
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.codat.io/companies/COMPANYID/reports/enhancedBalanceSheet/accounts" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://api.codat.io/companies/COMPANYID/reports/enhancedBalanceSheet/accounts", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.codat.io/companies/COMPANYID/reports/enhancedBalanceSheet/accounts",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /companies/{companyId}/reports/enhancedBalanceSheet/accounts | Enhanced Balance Sheet Accounts |
| GET | /companies/{companyId}/reports/enhancedCashFlow/transactions | Get enhanced cash flow report |
| GET | /companies/{companyId}/reports/enhancedInvoices | Enhanced Invoices Report |
| GET | /companies/{companyId}/reports/enhancedProfitAndLoss/accounts | Enhanced Profit and Loss Accounts |
| GET | /data/assess/accounts/categoriesdeprecated | List account categories |
| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details | Lists data integrity details for date type |
| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status | Get data integrity status |
| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries | Get data integrity summary |
| GET | /data/companies/{companyId}/assess/excel | Get status of Excel report |
| POST | /data/companies/{companyId}/assess/excel | Generate an Excel report |
| GET | /data/companies/{companyId}/assess/excel/download | Download generated excel report |
| POST | /data/companies/{companyId}/assess/excel/downloaddeprecated | Download generated excel report |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing | Get the marketing metrics from an accounting source for a given company. |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/categoriesdeprecated | List suggested and confirmed account categories |
| PATCH | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/categoriesdeprecated | Confirm categories for accounts |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categoriesdeprecated | Get suggested and/or confirmed category for a specific account |
| PATCH | /data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categoriesdeprecated | Patch account categories |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention | Get the customer retention metrics for a specific company. |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue | Get the lifetime value metric for a specific company. |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders | Get order information for a specific company |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds | Get the refunds information for a specific company |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue | Commerce Revenue Metrics |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/enhancedBalanceSheetdeprecated | Enhanced Balance Sheet |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/enhancedProfitAndLossdeprecated | Enhanced Profit and Loss |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/financialMetricsdeprecated | List financial metrics |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr | Get key metrics for subscription revenue |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/process | Request production of key subscription revenue metrics |
Questions
Does the Assess API API need an API key?
Yes. The Assess API API uses API key authentication; the documentation explains how to get credentials.
Does the Assess API API support HTTPS?
Yes, the Assess API API is served over HTTPS.
How many endpoints does the Assess API API have?
Its OpenAPI description lists 27 endpoints in version 1.0. All of them are shown on this page.
What are alternatives to the Assess API API?
Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.
Similar finance APIs
Compare alternatives →Stripe
FinancePayment processing, subscriptions, and financial management
SEC EDGAR Data
FinanceAPI to access annual reports of public US companies
Plaid
FinanceConnect with user's bank accounts and access transaction data
Fed Treasury
FinanceU.S. Department of the Treasury Data
Razorpay IFSC
FinanceIndian Financial Systems Code (Bank Branch Codes)
Klarna
FinanceKlarna payment and shopping service
Listed from APIs.guru (CC0).