v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the collections 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 collection report available in the UI. This API retrieves the list of collections 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/Centers/{center_id}/collections_report?start_date={start_date}&end_date={end_date}

Path parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

Query parameters

start_datestring date required

Mandatory Format:YYYY-MM-DD Retrieve collections of the center starting from this date. Here, the start time and date refers to the starting time and date of the specified center, not of UTC. For example, if you specify 'start_date' as 2020-08-03, this API will list out all the appointments for which payments have been added beginning from Aug 3, 2020.

end_datestring date required

Mandatory Format:YYYY-MM-DD Retrieve collections of the center until this date (inclusive). Here, the end time and date refers to the ending time and date of the specified center, not of UTC. For example, if you specify 'end_date' as 2020-08-05, this API will list out all the appointments for which payments have been added until Aug 5, 2020 (inclusive).

include_transactionsboolean

Optional Indicates whether transactions are to be retrieved as part of the center's collections. Default value: false.

include_employee_tipsboolean

Optional Indicates whether employee tips are to be retrieved as part of the center's collections. Default value: false.

Response

200