Sign in
OrganisationReports

Organisation revenue by centre report

Get a report of top offerings across all sites in an organisation.

get/shop/reports/organisation/top-offerings

Query parameters

revenue_date_fromstring date
Example:2024-03-01

Include revenues on or after this date.

revenue_date_tostring date
Example:2024-03-31

Include revenues on or before this date.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

offering_typestring[]

Include items of this type.

[
  "appointment"
]

Response

Contains the report data

Example response

{
  "data": [
    {
      "offering_type": "appointment",
      "offering_name": "60 minute massage",
      "site_name": "Palm Tree Spa",
      "num_standalone_items": 12,
      "num_package_items": 4,
      "gross_revenue": 95000,
      "net_revenue": 78400
    }
  ],
  "totals": {
    "by_offering_type": [
      {
        "offering_type": "appointment",
        "num_standalone_items": 12,
        "num_package_items": 4,
        "gross_revenue": 95000,
        "net_revenue": 78400
      }
    ]
  },
  "meta": {
    "currency": "gbp"
  }
}

Changes

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