---
title: "Booked-on summary"
method: GET
path: "/api/v1/reporting/booked_on_summary"
tags: ["Reporting"]
---

# Booked-on summary

`GET /api/v1/reporting/booked_on_summary`

## Request

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

Returns revenue totals bucketed by **when a booking was sold** (the `booked_at` date), rather than when the event runs. Each bucket reports the amount already collected, the amount still expected from non-postponed bookings (split into projected vs. past due), the amount tied up in postponed bookings, and the count of bookings.

This is the right endpoint for sales-pipeline questions like "how much did we sell last month?" or "what was our best booking week?". For event-date-based projections, use `revenue_projection_summary` instead.

Proposals are excluded. Only confirmed (non-archived) bookings with a `due_on` set are considered. All monetary fields are reported in cents.

**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`

booked-on 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 sold 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 sold 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

---

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