# Assess API API

> Assess API API on Apizie: 18 endpoints (Enhanced Balance Sheet Accounts, Get enhanced cash flow report, Enhanced Invoices Report, Enhanced Profit and Loss Accounts, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:codat-assess/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:codat-assess`
- Category: Finance
- Status: byok
- Source: https://www.codat.io/contact/
- Page: https://www.apizie.tech/api/finance/codat-assess
- OpenAPI: https://www.apizie.tech/api/finance/codat-assess/openapi.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…

## Endpoints

### Enhanced Balance Sheet Accounts
`GET https://www.apizie.tech/v1/finance:codat-assess/get-accounts-for-enhanced-balance-sheet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| reportDate | string | yes | 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 | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |

### Get enhanced cash flow report
`GET https://www.apizie.tech/v1/finance:codat-assess/get-enhanced-cash-flow-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |

### Enhanced Invoices Report
`GET https://www.apizie.tech/v1/finance:codat-assess/get-enhanced-invoices-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |

### Enhanced Profit and Loss Accounts
`GET https://www.apizie.tech/v1/finance:codat-assess/get-accounts-for-enhanced-profit-and-loss` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| reportDate | string | yes | 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 | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |

### Lists data integrity details for date type
`GET https://www.apizie.tech/v1/finance:codat-assess/get-data-integrity-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| dataType | string | yes | A key for a Codat data type. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### Get data integrity status
`GET https://www.apizie.tech/v1/finance:codat-assess/get-data-integrity-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| dataType | string | yes | A key for a Codat data type. |

### Get data integrity summary
`GET https://www.apizie.tech/v1/finance:codat-assess/get-data-integrity-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| dataType | string | yes | A key for a Codat data type. |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |

### Get status of Excel report
`GET https://www.apizie.tech/v1/finance:codat-assess/get-excel-report-generation-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| reportType | string | yes | The type of report you want to generate and download. |

### Generate an Excel report
`POST https://www.apizie.tech/v1/finance:codat-assess/generate-excel-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| reportType | string | yes | The type of report you want to generate and download. |

### Download generated excel report
`GET https://www.apizie.tech/v1/finance:codat-assess/get-excel-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| reportType | string | yes | The type of report you want to generate and download. |

### Get the marketing metrics from an accounting source for a given company.
`GET https://www.apizie.tech/v1/finance:codat-assess/get-accounting-marketing-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| reportDate | string | yes | 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 | integer | yes | The number of months per period. E.g. 2 = 2 months per period. |
| numberOfPeriods | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |
| periodUnit | string | yes | The period unit of time returned. |
| includeDisplayNames | boolean | no | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. |
| showInputValues | boolean | no | If set to true, then the system includes the input values within the response. |

### Get the customer retention metrics for a specific company.
`GET https://www.apizie.tech/v1/finance:codat-assess/get-commerce-customer-retention-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| reportDate | string | yes | 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 | integer | yes | The number of months per period. E.g. 2 = 2 months per period. |
| numberOfPeriods | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |
| periodUnit | string | yes | The period unit of time returned. |
| includeDisplayNames | boolean | no | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. |

### Get the lifetime value metric for a specific company.
`GET https://www.apizie.tech/v1/finance:codat-assess/get-commerce-lifetime-value-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| reportDate | string | yes | 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 | integer | yes | The number of months per period. E.g. 2 = 2 months per period. |
| numberOfPeriods | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |
| periodUnit | string | yes | The period unit of time returned. |
| includeDisplayNames | boolean | no | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. |

### Get order information for a specific company
`GET https://www.apizie.tech/v1/finance:codat-assess/get-commerce-orders-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| reportDate | string | yes | 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 | integer | yes | The number of months per period. E.g. 2 = 2 months per period. |
| numberOfPeriods | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |
| periodUnit | string | yes | The period unit of time returned. |
| includeDisplayNames | boolean | no | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. |

### Get the refunds information for a specific company
`GET https://www.apizie.tech/v1/finance:codat-assess/get-commerce-refunds-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| reportDate | string | yes | 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 | integer | yes | The number of months per period. E.g. 2 = 2 months per period. |
| numberOfPeriods | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |
| periodUnit | string | yes | The period unit of time returned. |
| includeDisplayNames | boolean | no | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. |

### Commerce Revenue Metrics
`GET https://www.apizie.tech/v1/finance:codat-assess/get-commerce-revenue-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| reportDate | string | yes | 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 | integer | yes | The number of months per period. E.g. 2 = 2 months per period. |
| numberOfPeriods | integer | yes | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to… |
| periodUnit | string | yes | The period unit of time returned. |
| includeDisplayNames | boolean | no | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. |

### Get key metrics for subscription revenue
`GET https://www.apizie.tech/v1/finance:codat-assess/get-recurring-revenue-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |

### Request production of key subscription revenue metrics
`GET https://www.apizie.tech/v1/finance:codat-assess/request-recurring-revenue-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |

## Example
```
curl "https://www.apizie.tech/v1/finance:codat-assess/get-accounts-for-enhanced-balance-sheet" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Assess API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/finance:codat-assess/get-accounts-for-enhanced-balance-sheet with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Assess API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Assess API itself also needs your own key from codat.io.

### Can AI agents use the Assess API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:codat-assess.

### What is the status of the Assess API API?
Needs your own provider key (bring your own key)