v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the sales report of a center

NOTE : This API is deprecated. Requesting not to use this API for any new integrations as the data cannot be reconciled to new sales accrual/sales cash reports available in the UI. This API retrieves the list of sales of the specified center during the selected date range.You must specify appropriate details for the center_id, start_date, and end_date parameters in the API request.Note : The date range that you specify cannot be more than seven days.

get/v1/sales/salesreport?center_id={center_id}&start_date={start_date}&end_date={end_date}&item_type={item_type}&status={status}

Query parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

start_datestring date required

Mandatory Start date from which the report displays the required data. Here, the start time and date refers to the starting time and date of the specified center, not of UTC. Format:YYYY-MM-DD For example, if you specify 'start_date' as 2020-08-03, this API displays the appointments that have appointment start date beginning from Aug 3, 2020.

end_datestring date required

Mandatory End date (inclusive) until which the report displays the required data. Here, the end time and date refers to the ending time and date of the specified center, not of UTC. Format:YYYY-MM-DD For example, if you specify 'end_date' as 2020-08-05, this API displays the appointments that have appointment start date until Aug 5, 2020 (inclusive).

item_typeinteger

Optional Type of the item (default value is 0): 0 - Service, 2 - Product, 3 - Membership, 4 - Package, 6 - Gift Card, and 7 - All.

statusinteger

Optional Status of the invoice (Default value is 0): 0 - Open, 1 - Closed, and 2 - All.

Response

200