GET
/
v0
/
reports
/
cash-flow
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/cash-flow \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "cash_flow_ledgers": [
    {
      "ledger_id": "KhxYFDUi8XZBA94uoHhzs8",
      "lines": [
        {
          "amount": -6682.7,
          "cash_flow_ledger_name": "Pluto Checking 4242",
          "datetime": "2024-01-08T00:00:00Z",
          "journal_entry_description": "Hill's*Order#1460",
          "journal_entry_id": "Sd5i3iDEUPwaZks5Eqz767",
          "line_id": "MtcXSgvyVHdm44AamH3A7p"
        }
      ],
      "name": "Supplies",
      "net_cash_flow": -6682.7,
      "total_net_cash_flow": -6682.7
    },
    {
      "ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
      "lines": [
        {
          "amount": 13451.49,
          "cash_flow_ledger_name": "Pluto Checking 4242",
          "datetime": "2024-01-05T00:00:00Z",
          "journal_entry_description": "Stripe Deposit - xPOLDZXC4334",
          "journal_entry_id": "344AYLxqH6Q8W7RyHNhfjb",
          "line_id": "FiiRY2pnADdxwnpajFdhSs"
        },
        {
          "amount": 17801.8,
          "cash_flow_ledger_name": "Pluto Checking 4242",
          "datetime": "2024-02-05T00:00:00Z",
          "journal_entry_description": "Stripe Deposit - aJFGJLKO2345",
          "journal_entry_id": "Msb2JMaa7MwG1XHSih35vv",
          "line_id": "921rijhvBPHDQPSmys14dc"
        }
      ],
      "name": "Sales Revenue",
      "net_cash_flow": 31253.29,
      "total_net_cash_flow": 31253.29
    }
  ],
  "ending_balances": [
    {
      "cash_balance": 38743.77,
      "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
      "ledger_name": "Pluto Checking 4242",
      "sort_code": "1400",
      "total_cash_balance": 38743.77
    }
  ],
  "ending_cash_balance": 38743.77,
  "starting_balances": [
    {
      "cash_balance": 14173.18,
      "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
      "ledger_name": "Pluto Checking 4242",
      "sort_code": "1400",
      "total_cash_balance": 14173.18
    }
  ],
  "starting_cash_balance": 14173.18
}

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.