Sign in
Reports

Queue an export of the service charge items report

This endpoint queues an export of the service charge items report.

get/shop/reports/service-charge-items/queue

Query parameters

site_idstring uuid

Filter the list of items by site.

offering_typestring[]

Filter by the offering type.

offering_idstring[]

Filter by the offering ID.

offering_categorystring

Filter by the offering's category.

sold_by_idstring[]

Filter by the ID of the user who sold the item.

order_statusstring

Filter by the status of the order.

statusstring

Filter by the status of the item.

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.

revenue_date_fromstring date

Filter to items with an order revenue date on or after this date.

revenue_date_tostring date

Filter to items with an order revenue date on or before this date.

order_submitted_at_fromstring date-time

Filter on orders with a submitted date on or after this time.

order_submitted_at_tostring date-time

Filter on orders with a submitted date before this time.

order_labelstring[]

Filter to items in orders with these labels.

item_date_fromstring date

Filter on items which are booked in for on or after this date.

item_date_tostring date

Filter on items which are booked in for before this date.

practitioner_idstring[]

Filter to items assigned to these practitioners.

room_idstring[]

Filter to items assigned to these rooms.

zone_idstring[]

Filter to items assigned to resources in these zones.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

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