Ratecard Client Rate
This API is to get client rate report. This is an authendicated API so we need to pass bearer token in request header to access the data.
Query parameters
-
region number
Id of the region to filter report
-
client number
Id of the client to filter report
-
business_unit number
Id of the business unit to filter report
-
job number
Id of job to filter report
-
job_name string
Name of the job to filter report
-
per_page number
Minimum value is 1 and maximum value is 100
GET /report/ratecard/clientrate
curl \
-X GET https://api-console.logezy.co/v1/report/ratecard/clientrate \
-H "Authorization: Bearer your-access-token" \
-H "Accept: application/json"
Response examples (200)
{
"status": "success",
"data": {
"current_page": 1,
"data": [
{
"rate_cards_id": 2124,
"business_unit_id": 58,
"job_id": 10,
"day_id": 2,
"shift_id": 234,
"custom_holiday_id": 0,
"rate_type": "hourly_rate",
"client_rate": "22.00",
"shift": "Night",
"client_name": "24 Care",
"business_unit_name": "24 Care Unit 2",
"job": "Cleaner",
"day": "Tuesday",
"holiday_date": null,
"holiday_title": null,
"holiday_status": null,
"holiday_id": null,
"id": 1,
"title": "Private Limited",
"value": "0.00"
}
],
"first_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/staffrate?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/staffrate?page=1",
"next_page_url": null,
"path": "https://api.logezydev.co.uk/v1/report/ratecard/staffrate",
"per_page": 10,
"prev_page_url": null,
"to": 4,
"total": 4
},
"message": "Staff Rate reports retrieved successfully."
}
Response examples ()
{
"status": "success",
"data": {
"current_page": 1,
"data": [
{
"rate_cards_id": 4,
"business_unit_id": 1,
"job_id": 1,
"day_id": 1,
"shift_id": 6,
"custom_holiday_id": 0,
"rate_type": "hourly_rate",
"client_rate": "12.00",
"shift": "Night",
"client_name": "AIMS",
"business_unit_name": "Tvm",
"job": "Nurse",
"day": "Monday",
"holiday_date": null,
"holiday_title": null,
"holiday_status": null,
"holiday_id": null
}
],
"first_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/clientrate?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/clientrate?page=1",
"next_page_url": null,
"path": "https://api.logezydev.co.uk/v1/report/ratecard/clientrate",
"per_page": 10,
"prev_page_url": null,
"to": 4,
"total": 4
},
"message": "Client Rate reports retrieved successfully."
}