OrganisationReports
Organisation revenue by centre report
Get a report of revenue by centre for all sites in an organisation.
get/shop/reports/organisation/revenue-by-centre
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.
item_date_fromstring date
Example:2024-03-01
Include items taking place on or after this date.
item_date_tostring date
Example:2024-03-31
Include items taking place on or before this date.
labelsstring[]
Filter to baskets with the given labels.
site_idstring[]
Include data for the given site ID(s).
Response
Contains the report data
Example response
{
"data": [
{
"by_date": [
{
"gross_revenue": 95000,
"net_revenue": 78400,
"item_average_gross": 14500,
"item_average_net": 11500,
"by_revenue_centre": [
{
"revenue_centre_key": "spa",
"revenue_centre_name": "Spa treatments",
"gross_revenue": 120000,
"net_revenue": 95000,
"num_items": 3
}
]
}
],
"totals": {
"gross_revenue": 95000,
"net_revenue": 78400,
"item_average_gross": 14500,
"item_average_net": 11500,
"by_revenue_centre": [
{
"revenue_centre_key": "spa",
"revenue_centre_name": "Spa treatments",
"gross_revenue": 120000,
"net_revenue": 95000,
"num_items": 3
}
]
}
}
],
"totals": {
"gross_revenue": 95000,
"net_revenue": 78400,
"item_average_gross": 14500,
"item_average_net": 11500,
"by_revenue_centre": [
{
"revenue_centre_key": "spa",
"revenue_centre_name": "Spa treatments",
"gross_revenue": 120000,
"net_revenue": 95000,
"num_items": 3
}
],
"by_date": [
{
"gross_revenue": 95000,
"net_revenue": 78400,
"item_average_gross": 14500,
"item_average_net": 11500,
"by_revenue_centre": [
{
"revenue_centre_key": "spa",
"revenue_centre_name": "Spa treatments",
"gross_revenue": 120000,
"net_revenue": 95000,
"num_items": 3
}
]
}
]
},
"meta": {
"currency": "gbp",
"revenue_centres": [
{
"name": "Website"
}
]
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.