Book summary

Retrieve 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 Book and bank account level.

This endpoint offers the following benefits:

  • Quicker analytics generation
  • More granular and accurate transaction categories (including improved revenue and expense calculations)
  • More concise structure

To learn more about the summary attributes of cash flow analytics obtained from a Book, expand the RESPONSES section below.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the Book that contains the bank statements you'd like to have analyzed.

Query Params
string

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 [email protected].

string

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 [email protected].

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json