Reports
Get Cash Flow Totals by Period
Get cash flow data between start date and end date partitioned by period. Requires Tier 1 subscription.
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
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>
requiredThe period that data is partitioned into
Available options:
daily
, monthly
, quarterly
, yearly
start_date
string
requiredThe start date of the cash flow report, inclusive
end_date
string
requiredThe end date of the cash flow report, inclusive
Response
200 - application/json
ending_balance
string
requiredentries
object[]
requiredstarting_balance
string
requiredcurl --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
}