GET
/
v0
/
reports
/
cash-flow-totals
Authorization
Header
Query
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/cash-flow-totals \
  --header 'Authorization: <authorization>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "ending_balance": 100,
  "entries": [
    {
      "balance": 100,
      "name": "Jan 2023",
      "net_cash_flow": 100
    }
  ],
  "starting_balance": 100
}

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

The period that data is partitioned into

Available options:
daily,
monthly,
quarterly,
yearly
start_date
string
required

The start date of the cash flow report, inclusive

end_date
string
required

The end date of the cash flow report, inclusive

Response

200 - application/json
ending_balance
string
required
entries
object[]
required
starting_balance
string
required
Get Cash Flow ReportGet Cash Flow Totals by Ledger