RevenueByCentre
Revenue by centre report
This endpoint provides a summary of revenue by reporting centre for the given parameters.
get/shop/reports/revenue-by-centre-v2
Query parameters
site_idstring uuid required
Filter the summary of revenue by centre by site.
revenue_date_fromstring date
Example:2024-05-01
Filter to baskets with revenues on or after this date.
revenue_date_tostring date
Example:2024-05-31
Filter to baskets with revenues on or before this date.
labelsstring[]
Filter to baskets with the given labels. This can be a comma separated list of label IDs, or 'none' to filter on baskets that don't have any labels.
Response
The revenue by centre summary was successfully retrieved
Example response
{
"data": {
"by_day": [
{
"items_paid": {
"by_revenue_centre": [
{
"revenue_centre_id": "fb",
"revenue_centre_label": "Food & Beverage",
"gross_revenue": 10000,
"net_revenue": 8000,
"num_items": 5
}
],
"num_items": 35,
"total_gross": 8000,
"total_net": 6000,
"item_average_gross": 5000,
"item_average_net": 3000
},
"items_unpaid": {
"by_revenue_centre": [
{
"revenue_centre_id": "fb",
"revenue_centre_label": "Food & Beverage",
"gross_revenue": 10000,
"net_revenue": 8000,
"num_items": 5
}
],
"num_items": 35,
"total_gross": 8000,
"total_net": 6000,
"item_average_gross": 5000,
"item_average_net": 3000
},
"totals": {
"by_revenue_centre": [
{
"revenue_centre_id": "fb",
"revenue_centre_label": "Food & Beverage",
"gross_revenue": 10000,
"net_revenue": 8000,
"num_items": 5
}
],
"num_items": 35,
"total_gross": 8000,
"total_net": 6000,
"item_average_gross": 5000,
"item_average_net": 3000
}
}
],
"totals": {
"items_paid": {
"by_revenue_centre": [
{
"revenue_centre_id": "fb",
"revenue_centre_label": "Food & Beverage",
"gross_revenue": 10000,
"net_revenue": 8000,
"num_items": 5
}
],
"num_items": 35,
"total_gross": 8000,
"total_net": 6000,
"item_average_gross": 5000,
"item_average_net": 3000
},
"items_unpaid": {
"by_revenue_centre": [
{
"revenue_centre_id": "fb",
"revenue_centre_label": "Food & Beverage",
"gross_revenue": 10000,
"net_revenue": 8000,
"num_items": 5
}
],
"num_items": 35,
"total_gross": 8000,
"total_net": 6000,
"item_average_gross": 5000,
"item_average_net": 3000
},
"totals": {
"by_revenue_centre": [
{
"revenue_centre_id": "fb",
"revenue_centre_label": "Food & Beverage",
"gross_revenue": 10000,
"net_revenue": 8000,
"num_items": 5
}
],
"num_items": 35,
"total_gross": 8000,
"total_net": 6000,
"item_average_gross": 5000,
"item_average_net": 3000
}
}
},
"meta": {
"revenue_centres": [
{
"name": "Website"
}
]
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.