---
title: "Revenue projection summary"
method: GET
path: "/api/v1/reporting/revenue_projection_summary"
tags: ["Reporting"]
---

# Revenue projection summary

`GET /api/v1/reporting/revenue_projection_summary`

## Request

- Base URL: `https://api.checkcherry.com`
- URL: `https://api.checkcherry.com/api/v1/reporting/revenue_projection_summary`
- Auth: none declared. Required headers: `Api-Key`

Returns projected revenue for the business, bucketed by time interval. Each bucket reports the amount already collected, the amount still expected from confirmed bookings, the amount that has slipped past due, and the amount tied up in postponed bookings — along with the number of bookings in that interval.

Proposals are excluded. Only confirmed (non-archived) bookings whose `earliest_starts_at` falls within the bucket contribute to the totals. All monetary fields are reported in cents.

Useful for dashboards, cash-flow forecasting, and answering questions like "how much do we expect to bring in next quarter?" or "how much is past due from last month?".

**Required permission:** `reports_read`

## Query parameters

- `interval` 'year' | 'quarter' | 'month' | 'week' | 'day'
- `starts_at` string
- `ends_at` string
- `brand_id` integer

## Headers

- `Api-Key` string, required

## Response `200`

revenue projection summary

- object
  - `results` object[]: One entry per interval bucket, in chronological order.
    - `name` string: Human-readable label for the bucket (e.g. `Jan 2026`, `Q1 2026`).
    - `amount_paid_cents` integer: Total already collected from bookings in this bucket, in cents.
    - `projected_cents` integer: Outstanding balance still expected from non-postponed bookings whose `due_on` is in the future, in cents.
    - `past_due_cents` integer: Outstanding balance from non-postponed bookings whose `due_on` has passed, in cents.
    - `postponed_cents` integer: Outstanding balance from postponed bookings, in cents.
    - `total_cents` integer: Sum of `amount_paid_cents`, `projected_cents`, `past_due_cents`, and `postponed_cents`, in cents.
    - `event_count` integer: Number of bookings included in this bucket.
    - `report_path` string: Internal Check Cherry path that opens the matching report view in the web app. Not generally useful to API consumers.

## Other responses

- `422`: invalid interval

## Changes

- **2026-10-19** `84a9aabdf519`: 1 info
  - added the non-success response with the status `422`

[Operation history](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/changes/api/v1/reporting/revenue_projection_summary/get.md)

---

[API](https://skmtc.dev/checkcherry/apis/check-cherry-business-api.md) · [All operations](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/llms.txt) · [OpenAPI document](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/revisions/84a9aabdf519?raw)