GET
/
v0
/
reports
/
cash-flow

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The Teal instance ID

Query Parameters

start_date
string
required

Only include data after the start date (inclusive).

end_date
string
required

Only include data before the end date (inclusive).

tag_ids
string

Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription

Response

200 - application/json
cash_flow_ledgers
object[]
required

A list of Cash Flow Ledger objects indicating which ledgers were impacted by cash movements in the given period.

ending_balances
object[]
required

A list of Cash Balance objects at the end of the period for ledgers reporting cash flow.

ending_cash_balance
number
required

The total debit balance, in decimal dollar cents, of all cash flow ledgers at the end of the period.

starting_balances
object[]
required

A list of Cash Balance objects at the end of the period for ledgers reporting cash flow.

starting_cash_balance
number
required

The total debit balance, in decimal dollar cents, of all cash flow ledgers at the beginning of the period.