GET
/
v0
/
reports
/
cash-flow
Authorization
Header
Query
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/cash-flow \
  --header 'Authorization: <authorization>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "cash_flow_ledgers": [
    {
      "children": [],
      "debit_amount": -1032.23,
      "ledger_id": "Jg8XPxz23f2XtHKPFsocrX",
      "lines": [],
      "name": "Credit Card 3821",
      "parent_id": "UUbwp3vRvbPUd2dwHaqWgU",
      "total_debit_amount": -1032.23
    }
  ],
  "ending_balances": [
    {
      "children": [],
      "debit_balance": 3822.83,
      "ledger_id": "FwLHD46VLJXx87oStFW7uz",
      "ledger_name": "Savings Account 3822",
      "parent_id": "UUbwp3vRvbPUd2dwHaqWgU",
      "sort_code": "5300",
      "total_debit_balance": 3822.83
    }
  ],
  "ending_debit_balance": 28182.42,
  "starting_balances": [
    {
      "children": [],
      "debit_balance": 3822.83,
      "ledger_id": "FwLHD46VLJXx87oStFW7uz",
      "ledger_name": "Savings Account 3822",
      "parent_id": "UUbwp3vRvbPUd2dwHaqWgU",
      "sort_code": "5300",
      "total_debit_balance": 3822.83
    }
  ],
  "starting_debit_balance": 23282.12
}

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

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
cash_flow_ledgers
object[]
required
ending_balances
object[]
required
ending_debit_balance
string
required
starting_balances
object[]
required
starting_debit_balance
string
required
Get Ledger StatementGet Cash Flow Totals by Period