Reporting

Revenue projection summary

Changed on

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

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

Query parameters

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

Time-bucket size for the projection. Defaults to month.

starts_atstring

Start of the date range to project over (YYYY-MM-DD). Defaults to one year ago. The range is snapped to the beginning of the chosen interval.

ends_atstring

End of the date range to project over (YYYY-MM-DD). Defaults to today. The range is snapped to the end of the chosen interval.

brand_idinteger

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

Headers

Api-Keystring required

Your Integration Key

Response

revenue projection summary

Changes