---
title: "Retrieves ARR waterfall report"
method: GET
path: "/reports/arr-waterfall"
tags: ["Reports"]
---

# Retrieves ARR waterfall report

`GET /reports/arr-waterfall`

Returns the ARR waterfall dataset for the requested month with optional breakdown dimensions, subsidiary filters, and pagination cursors for large tenants.
Finance teams use this to explain beginning ARR, new business, expansion, contraction, and churn between periods.

## Query parameters

- `month` string, yearMonth, required
- `status` 'ACTIVE' | 'COMMITTED', required
- `breakdown` 'ARR' | 'MRR', required
- `subsidiary_id` string, uuid
- `limit` integer
- `cursor` string — If defined, a cursor to retrieve the next page.

## Response `200`

OK

- RevenueWaterfall
  - `customers` CustomerRevenue[], required
    - `id` string, uuid, required
    - `name` string, required
    - `total` Revenue
      - `year_month` string, yearMonth, required — Year and month for the requested report for this revenue total
      - `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
  - `pagination` Pagination
    - `next_cursor` string — If defined, a cursor to retrieve the next page.

## 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)