GET
/
v0
/
reports
/
cash-flow-totals
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/cash-flow-totals \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "ending_balance": 22175.03,
  "entries": [
    {
      "balance": 48644.91,
      "name": "Jan 2024",
      "net_cash_flow": 26469.88
    },
    {
      "balance": 60808.87,
      "name": "Feb 2024",
      "net_cash_flow": 12163.96
    },
    {
      "balance": 62972.11,
      "name": "Mar 2024",
      "net_cash_flow": 2163.24
    }
  ],
  "starting_balance": 62972.11
}

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

period
enum<string>
required

Determines how the data is segmented.

Available options:
daily,
monthly,
quarterly,
yearly
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
ending_balance
number
required

The total ending balance, in decimal dollar cents, of all cash flow ledgers for the period.

entries
object[]
required

A list of report summary totals broken down by period between the start date and end date.

starting_balance
number
required

The total starting balance, in decimal dollar cents, of all cash flow ledgers for the period.