Reporting

Payment receipt summary

Changed on

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

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

Query parameters

interval'year' | 'quarter' | 'month' | 'week' | 'day'

Time-bucket size. Defaults to month.

starts_atstring

Start of the date range (YYYY-MM-DD). Defaults to one year ago. Snapped to the beginning of the chosen interval.

ends_atstring

End of the date range (YYYY-MM-DD). Defaults to today. Snapped to the end of the chosen interval.

brand_idinteger

Limit results to a single brand. Omit to include all brands on the account.

Headers

Api-Keystring required

Your Integration Key

Response

payment receipt summary

Changes