canonical: https://jentic.com/apis/codat.io/assess

# Codat Assess API

Codat's Assess API turns raw accounting and commerce data into ready-made financial metrics and reports purpose-built for lending, underwriting, and risk decisioning. It produces enhanced profit and loss, balance sheet, and cash flow reports along with commerce metrics such as revenue, refunds, customer retention, and lifetime value derived from a borrower's linked accounting and commerce platforms. The API also returns data integrity scores so credit teams know how trustworthy the underlying figures are. It is used by SMB lenders, capital providers, and embedded finance platforms.

## For AI agents

Generate enhanced financial reports and lending metrics - enhanced P&L, balance sheet, cash flow, MRR, customer retention, and data integrity scores - from a customer's linked accounting and commerce data.

## Scope

Does not handle ledger writes, raw bank feed connectivity, or general accounting CRUD - use for lending and credit decisioning metrics derived from already-linked accounting and commerce data only.

## Capabilities

- Generate enhanced profit and loss, balance sheet, and cash flow reports tailored for credit decisioning
- Compute commerce metrics including revenue, orders, refunds, customer lifetime value, and retention
- Calculate monthly recurring revenue (MRR) from subscription data in linked commerce platforms
- Score data integrity for accounting and banking inputs so lenders can trust the underlying numbers
- Pull enhanced invoice data with audit trails for accounts receivable financing decisions
- Retrieve loan liability schedules and transaction history from linked accounting ledgers
- Export full Assess datasets as Excel workbooks for offline credit analyst workflows

## Use cases

### SMB Lending Underwriting

Lenders use the Assess API to replace document-driven underwriting with structured, normalised financial metrics pulled from a borrower's accounting platform. The /companies/{companyId}/reports/enhancedProfitAndLoss/accounts and /reports/enhancedCashFlow/transactions endpoints surface the line-level history that credit models consume, while the data integrity endpoints flag missing or low-confidence figures before the model runs. This compresses underwriting from days to minutes.

Example prompt: Fetch the enhanced cash flow transactions and data integrity summary for company {companyId} for the last 12 months and flag any months where data integrity is below 80%.

### E-Commerce and SaaS Capital Providers

Revenue-based finance providers and SaaS capital lenders use the commerce metrics endpoints to evaluate borrower revenue quality. The /assess/commerceMetrics/revenue, /commerceMetrics/customerRetention, /commerceMetrics/lifetimeValue, and /assess/subscriptions/mrr endpoints expose the cohort-level metrics that drive advance-rate decisions, pulled directly from Shopify, Stripe, or other linked commerce sources without a finance team having to build per-platform parsers.

Example prompt: Retrieve MRR, customer retention, and lifetime value metrics for company {companyId} connection {connectionId} for the trailing 24 months.

### Credit Analyst Excel Workflow

Credit analysts who still work in Excel use the /data/companies/{companyId}/assess/excel and /assess/excel/download endpoints to pull a complete pre-built Assess workbook covering accounting metrics, commerce metrics, and data integrity in one file. This removes the per-applicant copy-paste step from financial spreading and lets analysts focus on judgement rather than data assembly.

Example prompt: Generate and download the Assess Excel workbook for company {companyId} and save it locally for the credit analyst to review.

### AI Agent Credit Memo Drafting

AI agents drafting credit memos use the Assess API through Jentic to assemble the financial section automatically. The agent searches Jentic for 'enhanced profit and loss', loads the schema, and pulls the report along with data integrity scores so the memo can flag low-confidence inputs. Jentic's credential isolation keeps the Codat API key out of the agent's context and the unified search makes it unnecessary for the agent to navigate the 22 Assess paths manually.

Example prompt: Search Jentic for 'enhanced profit and loss', load the operation, then fetch the report for company {companyId} and summarise the top three drivers of revenue change month-over-month.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /companies/{companyId}/reports/enhancedProfitAndLoss/accounts | Enhanced profit and loss report by account |
| GET | /companies/{companyId}/reports/enhancedBalanceSheet/accounts | Enhanced balance sheet report by account |
| GET | /companies/{companyId}/reports/enhancedCashFlow/transactions | Enhanced cash flow at transaction level |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue | Commerce revenue metrics from a linked connection |
| GET | /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr | Monthly recurring revenue from subscription data |
| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries | Data integrity summary for a given data type |
| GET | /data/companies/{companyId}/assess/excel/download | Download the full Assess Excel workbook |

## Key resources

- **Enhanced reports** — Profit and loss, balance sheet, and cash flow reports formatted for credit decisioning
- **Commerce metrics** — Revenue, orders, refunds, customer retention, lifetime value, and MRR from linked commerce platforms
- **Data integrity** — Status, summary, and detail endpoints scoring how complete and reliable the underlying data is
- **Loan liabilities** — Outstanding loan balances and transaction history pulled from the accounting ledger
- **Excel reports** — Pre-built downloadable workbook covering the full Assess dataset for offline analyst use

## Why Jentic

- **Setup:** Wiring Codat Assess by hand means building its Basic API-key header, targeting api.codat.io, and threading the companyId and connectionId through every enhanced report and metrics call yourself. Through Jentic you install once, import the Assess API from the API Directory, store the Codat API key once, and your agent calls it.
- **Permission scoping:** Assess puts the company id in the URL path (/companies/{companyId}/reports/... and /data/companies/{companyId}/...), so a rule can pin your agent to one company: it reads that borrower's enhanced profit and loss, balance sheet, cash flow, and commerce metrics and nothing else. You choose the operations it may call, and since Assess exposes read-only reporting here, the rule stays scoped to the metrics you actually want it to fetch.
- **Credential handling:** Your Codat API key is stored once, encrypted, by your own Jentic One instance and injected at execution time as the Basic Authorization header. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'enhanced profit and loss for a borrower' or 'monthly recurring revenue for a company', and Jentic returns the matching Assess operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Codat Accounting API** — Provides the underlying normalised accounting data that Assess transforms into lending metrics
- **Codat Banking API** — Direct bank transaction data used alongside Assess to build a complete credit picture
- **Codat Commerce API** — Provides raw commerce platform data that feeds Assess commerce metrics like MRR and retention

## FAQ

### What authentication does the Codat Assess API use?

The API uses an API key passed in the Authorization header as 'Basic <base64-encoded-key>'. The single security scheme is named auth_header in the spec. Through Jentic, the Codat API key is stored encrypted in the vault and the Authorization header is constructed inside the Jentic execution layer rather than the agent.

### Can I get monthly recurring revenue with the Codat Assess API?

Yes. Use GET /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr to retrieve MRR derived from subscription data in the linked commerce platform. Pair it with /assess/subscriptions/process to trigger the underlying calculation if it has not been run yet.

### What are the rate limits for the Codat Assess API?

Codat does not publish a fixed rate limit in the OpenAPI spec; limits are governed at the company and connection level and depend on the underlying platform. Codat returns HTTP 429 with a Retry-After header when limits are hit, and recommends exponential backoff for retries.

### How do I pull an enhanced cash flow report through Jentic?

Search Jentic for 'enhanced cash flow codat', load the GET /companies/{companyId}/reports/enhancedCashFlow/transactions operation, and execute it with the company ID. Install with pip install jentic and use the standard async search, load, and execute flow.

### How does the Codat Assess API check data quality?

The /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status, /summaries, and /details endpoints score how complete and consistent the underlying accounting or banking data is. Lenders use these scores to decide whether to trust automated metrics or request additional documentation.

### Can I export Assess data to Excel for credit analysts?

Yes. Call GET /data/companies/{companyId}/assess/excel to generate the workbook and GET /data/companies/{companyId}/assess/excel/download to retrieve it. The workbook contains accounting metrics, commerce metrics, and data integrity sheets in the format Codat ships to lender customers.

### Can I limit what my agent is allowed to do with the Codat Assess API?

Yes. Because Jentic One is self-hosted, your own rules decide which Assess operations and credentials the agent may use, and you approve each one before it can run. Since Assess carries the company id in the URL path (/companies/{companyId}/reports/... and /data/companies/{companyId}/...), a rule can pin the agent to a single borrower so it reads only that company's enhanced profit and loss, balance sheet, cash flow, and commerce metrics. Assess exposes read-only reporting here, so you can scope the agent to just the reports and data integrity summaries you want it to fetch and nothing else.