APIHub
Back to Explore

Assess API

The Assess API provides enriched financial and commerce analytics for a company, exposing enhanced balance‑sheet, profit‑and‑loss, cash‑flow and invoice reports as well as detailed accounting, commerce (revenue, orders, refunds, customer‑retention, lifetime value) and subscription revenue metrics. It also offers data‑integrity status, suggested/confirmed account categories, and endpoints to generate and download Excel versions of these reports.

Finance
apiKeyHeader
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

967ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/companies/{companyId}/reports/enhancedBalanceSheet/accounts

Enhanced Balance Sheet Accounts

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
GET

/companies/{companyId}/reports/enhancedCashFlow/transactions

Get enhanced cash flow report

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
GET

/companies/{companyId}/reports/enhancedInvoices

Enhanced Invoices Report

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
GET

/companies/{companyId}/reports/enhancedProfitAndLoss/accounts

Enhanced Profit and Loss Accounts

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
GET

/data/assess/accounts/categories

List account categories

GET

/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details

Lists data integrity details for date type

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
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

  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
GET

/data/companies/{companyId}/assess/excel

Get status of Excel report

  • reportType (query, required) — The type of report you want to generate and download.
POST

/data/companies/{companyId}/assess/excel

Generate an Excel report

  • reportType (query, required) — The type of report you want to generate and download.
GET

/data/companies/{companyId}/assess/excel/download

Download generated excel report

  • reportType (query, required) — The type of report you want to generate and download.
POST

/data/companies/{companyId}/assess/excel/download

Download generated excel report

  • reportType (query, required) — The type of report you want to generate and download.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing

Get the marketing metrics from an accounting source for a given company.

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • periodUnit (query, required) — The period unit of time returned.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
  • showInputValues (query) — If set to true, then the system includes the input values within the response.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories

List suggested and confirmed account categories

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
PATCH

/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories

Confirm categories for accounts

GET

/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories

Get suggested and/or confirmed category for a specific account

PATCH

/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories

Patch account categories

GET

/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention

Get the customer retention metrics for a specific company.

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • periodUnit (query, required) — The period unit of time returned.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue

Get the lifetime value metric for a specific company.

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • periodUnit (query, required) — The period unit of time returned.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders

Get order information for a specific company

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • periodUnit (query, required) — The period unit of time returned.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds

Get the refunds information for a specific company

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • periodUnit (query, required) — The period unit of time returned.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue

Commerce Revenue Metrics

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • periodUnit (query, required) — The period unit of time returned.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/enhancedBalanceSheet

Enhanced Balance Sheet

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/enhancedProfitAndLoss

Enhanced Profit and Loss

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • includeDisplayNames (query) — Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
GET

/data/companies/{companyId}/connections/{connectionId}/assess/financialMetrics

List financial metrics

  • reportDate (query, required) — The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
  • periodLength (query, required) — The number of months per period. E.g. 2 = 2 months per period.
  • numberOfPeriods (query, required) — The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods.
  • showMetricInputs (query) — If set to true, then the system includes the input values within the response.
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

27 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X GET \
  "https://api.codat.io/companies/{companyId}/reports/enhancedBalanceSheet/accounts" \
  -H "Authorization: YOUR_API_KEY"

api.codat.io · HTTPS only