This API provides categorizations for each transaction in the requested Book. It's the building block for all the Cash Flow Analytics products. It contains a comprehensive list of categories, accurate Transaction tagging, and improved revenue, expense, and transfer logic.
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.
Date range
Use begin_date and end_date to return only transactions in a period. Both parameters are optional. Dates are inclusive and use YYYY-MM-DD. begin_date can't be after end_date. The parameters filter the response and don't change the Book. Without them, the response is unchanged.
With a date range, total, offset and limit apply to the in-range transactions. mismatched_transactions and bank_checks list only items in the range.
An inverted range or an invalid date returns 400.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||