---
title: "Payment receipt summary"
method: GET
path: "/api/v1/reporting/payment_receipt_summary"
tags: ["Reporting"]
---

# Payment receipt summary

`GET /api/v1/reporting/payment_receipt_summary`

## Request

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

Returns the total payments actually collected, bucketed by time interval. Each bucket reports the amount received and the number of distinct payment records that landed in the bucket.

Payments are bucketed by `paid_at` (when the money was actually received), not by the event date. Refunds and zero-amount records are excluded. Payments tied to archived or recurring template events are excluded. All monetary fields are reported in cents.

Pairs well with `revenue_projection_summary`: this endpoint answers "how much came in?", the projection endpoint answers "how much do we still expect?".

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

payment receipt 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 amount collected in this bucket, in cents.
    - `payment_count` integer: Number of payment records that fell 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/payment_receipt_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)