Codat Assess API

Name: Assess API
Brand: Assess API
Availability: InStock

✓ Official Vendor SpecFinanceAccountingapiKey22 EndpointsREST

Install Jentic One Beta

Connect the Assess API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Assess API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Assess API.

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

GET STARTED

Start building with Assess API

Explore with Jentic

View OpenAPI Document

For 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.

Use for: I want to generate an enhanced profit and loss for a loan applicant, Get the MRR and customer retention metrics for a SaaS borrower, Retrieve the data integrity summary for a company's accounting connection, Calculate customer lifetime value from a company's commerce data

Not supported: 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.

Use Cases

Patterns agents use Assess API for, with concrete tasks.

★ 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.

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.

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.

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.

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

22 endpoints — 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.

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

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

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

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.

Intent-based discovery

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.

Time to first call

FAQs

Specific to using Assess API through Jentic.

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.