v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBBook summary
This API retrieves the Cash Flow Analytics summary of a Book in JSON format. It provides daily balances, bank account PII, and time series for all transaction categories at the <glossary:Book> and bank account level.
It offers quicker analytics generation, more granular and accurate transaction categories (including improved revenue and expense calculations), and a more concise structure.
Async processing
This API supports asynchronous processing. To get the asynchronous result, add async=true in the query parameter to run the request as a background job and receive a job_id immediately instead of waiting for the full response inline. When async=true, the endpoint returns 202 Accepted with a job_id instead of the analytics payload.
Async mode is required for Books with more than 100,000 transactions. Books exceeding 1,000,000 transactions are rejected with 422 (error code 1100). Once submitted, poll Async job status API to retrieve the result when the job is complete.
Path parameters
The unique identifier of the <glossary:Book> that contains the bank statements you'd like to have analyzed.
Query parameters
Bank account primary key(s) to exclude from analytics calculations in the book summary. The underlying data remains in the system and is not deleted.
📘 This parameter is in beta. If you encounter any bug, please reach out to support@ocrolus.com.
Months (in YYYY-MM format) of transaction to exclude from analytics calculations in the book summary. The underlying data remains in the system and is not deleted.
📘 This parameter is in beta. If you encounter any bug, please reach out to support@ocrolus.com.
When true, runs the request as a background job and returns a job_id immediately instead of the analytics payload. Required for Books with more than 100,000 transactions. Books exceeding 1,000,000 transactions are rejected with 422 (error code 1100).
Response
Success
Example response
{
"book_pk": 18843681,
"book_name": "Jill's Coffee (v.3)",
"txn_count": 324,
"naics4_code": 7225,
"naics_description": "Restaurants and Other Eating Places",
"naics6_code": 7225,
"naics6_description": "Snack and Nonalcoholic Beverage Bars",
"naics_override": true,
"mcc_code": 7225,
"mcc_description_": "Snack and Nonalcoholic Beverage Bars",
"sic_code": 172,
"sic_description_": "GRAPES",
"loan_inquiries": {
"smb_entity_name": "ABC Corp",
"total_applications": 3,
"application_history": [
{
"created_ts": "2025-10-10T12:00:00Z"
}
],
"velocity": {
"30_day_count": 2,
"60_day_count": 2,
"90_day_count": 3,
"180_day_count": 3,
"270_day_count": 3,
"365_day_count": 3
}
},
"book_mismatch_severity": "high",
"bank_accounts": [
{
"txn_count": 244
}
]
}