Sign in
Reports

Revenue projection report

Projects expected revenue across a date range of up to 31 days, broken down by offering and revenue centre. Useful for daily/weekly dashboards that need to look ahead at booked revenue. Money fields are integers in minor units.

For background CSV export — including delivery by email — see /shop/reports/revenue-projection/queue.

get/shop/reports/revenue-projection

Query parameters

site_idstring uuid

Restrict the projection to baskets at the given site.

revenue_date_fromstring date
Example:2026-06-01

Restrict to baskets with a revenue date on or after this date. Either this and revenue_date_to must be provided, or item_date_from and item_date_to. The total range cannot exceed 31 days.

revenue_date_tostring date
Example:2026-06-30

Restrict to baskets with a revenue date on or before this date.

item_date_fromstring date

Restrict to baskets containing items dated on or after this date.

item_date_tostring date

Restrict to baskets containing items dated on or before this date.

Response

The projection was successfully generated.

Example response

{
  "data": {
    "with_package_groups": [
      {
        "by_date": [
          {
            "date": "2026-06-15",
            "num_items": 4,
            "gross_revenue": 60000,
            "net_revenue": 50000
          }
        ]
      }
    ],
    "without_package_groups": [
      {
        "offering_id": "5e932c0901d210625e3a8766",
        "offering_name": "60 Minute Massage",
        "offering_type": "appointment",
        "by_date": [
          {
            "date": "2026-06-15",
            "num_items": 4,
            "gross_revenue": 60000,
            "net_revenue": 50000
          }
        ]
      }
    ],
    "by_revenue_centre": [
      {
        "by_date": [
          {
            "date": "2026-06-15",
            "num_items": 4,
            "gross_revenue": 60000,
            "net_revenue": 50000
          }
        ]
      }
    ]
  },
  "totals": {
    "with_package_groups": {
      "by_date": [
        {
          "date": "2026-06-15",
          "num_items": 4,
          "gross_revenue": 60000,
          "net_revenue": 50000
        }
      ]
    },
    "without_package_groups": {
      "by_date": [
        {
          "date": "2026-06-15",
          "num_items": 4,
          "gross_revenue": 60000,
          "net_revenue": 50000
        }
      ]
    },
    "by_date": [
      {
        "date": "2026-06-15",
        "num_items": 4,
        "gross_revenue": 60000,
        "net_revenue": 50000
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.