v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBCash flow features
This API retrieves pre-engineered analytics on a series of bank statements within a <glossary:Book> with an object structure that’s suitable for modeling applications.
📘 Note *Min_days_to_include: Minimum number of days required for the most recent calendar month to be included in monthly cash flow calculations. The default value is 0. If the value is set to 32, only fully completed months are included.
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 you'd like to analyze. All bank statements in this Book will be analyzed, and other documents will be ignored.
Query parameters
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