---
title: "Retrieves cash flow statement report"
method: GET
path: "/reports/cash-flow-statement"
tags: ["Reports"]
---

# Retrieves cash flow statement report

`GET /reports/cash-flow-statement`

Returns a cash flow statement report for the specified date range.

## Query parameters

- `from_date` string, date, required
- `to_date` string, date, required
- `subsidiary_id` string, uuid
- `breakdown_by` 'SUBSIDIARY' | 'CUSTOM_FIELD' — How to break down the report columns. If not specified, returns a single total column.
- `custom_field_id` string, uuid

## Response `200`

OK

- CashFlowStatementReport
  - `period` ReportPeriod, required
    - `from_date` string, date, required — Start date of the report period
    - `to_date` string, date, required — End date of the report period
  - `currency` string, required — Currency code following ISO-4217
  - `breakdowns` ReportBreakdown[], required — The breakdown columns for this report. When no breakdown_by is specified, this contains a single PERIOD entry representing the total.
    - `type` 'SUBSIDIARY' | 'CUSTOM_FIELD' | 'PERIOD', required — The type of breakdown
    - `name` string, required — Display name for this breakdown column
    - `id` string, uuid — The ID of the subsidiary or custom field value (if applicable)
  - `sections` NamedCashFlowSection[], required — The sections of the cash flow statement (e.g., Operating Cash Flow, Investing Cash Flow, Financing Cash Flow)
    - `name` string, required — The name of this section
    - `totals` BreakdownBalance[], required — Section totals, one per breakdown column.
      - `breakdown_id` string, uuid, required — The ID of the breakdown this balance belongs to
      - `amount` RoundedMonetaryAmount, required — A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
        - `amount` string, required — Monetary amount in decimal format, using a period (.) as the decimal separator. Must be rounded to the currency's default decimal places (e.g. '1.01' in USD represents 1 dollar and 1 cent).
        - `currency` string, required — Currency code following ISO-4217
    - `items` CashFlowItem[], required
      - `name` string, required
      - `amounts` BreakdownBalance[], required — Amounts, one per breakdown column.
        - `breakdown_id` string, uuid, required — The ID of the breakdown this balance belongs to
        - `amount` RoundedMonetaryAmount, required — A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
          - `amount` string, required — Monetary amount in decimal format, using a period (.) as the decimal separator. Must be rounded to the currency's default decimal places (e.g. '1.01' in USD represents 1 dollar and 1 cent).
          - `currency` string, required — Currency code following ISO-4217
  - `summaries` CashFlowItem[], required — Summary line items (e.g., Net Change in Cash, Opening Balance, Closing Balance, FX Effect on Cash)
    - `name` string, required
    - `amounts` BreakdownBalance[], required — Amounts, one per breakdown column.
      - `breakdown_id` string, uuid, required — The ID of the breakdown this balance belongs to
      - `amount` RoundedMonetaryAmount, required — A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
        - `amount` string, required — Monetary amount in decimal format, using a period (.) as the decimal separator. Must be rounded to the currency's default decimal places (e.g. '1.01' in USD represents 1 dollar and 1 cent).
        - `currency` string, required — Currency code following ISO-4217

## Other responses

- `default` — Error

---

[API](https://skmtc.net/rillet/apis/rillet-accounting-api.md) · [All operations](https://skmtc.net/rillet/apis/rillet-accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rillet/rillet-accounting-api/versions/a2ab794dd5f2/schema)