Reports
List cash flow totals by period
Retrieves a list of the cash flow data across all cash flow ledgers segmented by period.
GET
/
v0
/
reports
/
cash-flow-totals
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
teal-instance-id
string
requiredThe Teal instance ID
Query Parameters
period
enum<string>
requiredDetermines how the data is segmented.
Available options:
daily
, monthly
, quarterly
, yearly
start_date
string
requiredOnly include data after the start date (inclusive).
end_date
string
requiredOnly include data before the end date (inclusive).
tag_ids
string[] | null
Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription
Response
200 - application/json
ending_balance
number
requiredThe total ending balance, in decimal dollar cents, of all cash flow ledgers for the period.
entries
object[]
requiredA list of report summary totals broken down by period between the start date and end date.
starting_balance
number
requiredThe total starting balance, in decimal dollar cents, of all cash flow ledgers for the period.