Cash flow statement

​

The entity's cash flow statement, indirect method, for each period column in the window. Sections are operating, investing and financing activity plus the computed net change (is_subtotal); rows under each section nest computed lines such as net income above the adjustments that reconcile them to cash. Positive amounts are inflows. start_date and end_date are inclusive; period_type (monthly, quarterly, yearly) chooses the columns, listed under periods and clipped to the window. Amounts are integer atoms of reporting_currency (cents for USD); a null cell means no data for that period rather than zero. The window may span at most 5 years. Built from the general ledger at request time, so every posted entry is reflected immediately.

Query Parameters

  • start_date
    Type: stringFormat: date
    required

    Inclusive start date for the report

  • end_date
    Type: stringFormat: date
    required

    Inclusive end date for the report

  • period_type
    Type: enum

    Time period grouping

Responses

  • application/json
  • 400

    The window spans more than 5 years (CAPI69).

  • 401

    Missing or invalid bearer API key (CAPI11).

  • 403

    The key lacks the customer_api:read permission (CAPI71).

  • application/json
Request Example for get/v1/reports/cash-flow
curl 'https://api.t0.ai/v1/reports/cash-flow?start_date=&end_date=&period_type=monthly' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "periods": [
    {
      "id": "string",
      "label": "string",
      "start_date": "2026-09-30",
      "end_date": "2026-09-30"
    }
  ],
  "sections": [
    {
      "key": "string",
      "label": "string",
      "balances": {
        "additionalProperty": 1
      },
      "accounts": [
        {
          "id": "string",
          "account_number": "string",
          "name": "string",
          "balances": {
            "additionalProperty": 1
          },
          "is_subtotal": false,
          "transaction_counts": {
            "additionalProperty": 1
          },
          "drilldown": {
            "account_ids": [
              "string"
            ],
            "requires_cash_line": true,
            "amount_inverted": true
          },
          "children": []
        }
      ],
      "is_subtotal": false
    }
  ],
  "reporting_currency": "USD"
}

Successful Response