GET /report/ratecard/clientrate

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.

Headers

  • Authorization string Required
  • Accept string

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

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • status string
    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • current_page integer
      • data array[object]
        Hide data attributes Show data attributes object
        • rate_cards_id number
        • business_unit_id number
        • job_id number
        • day_id number
        • shift_id number
        • custom_holiday_id number
        • rate_type string
        • client_rate string
        • shift string
        • client_name string
        • business_unit_name string
        • job string
        • day string
        • holiday_date string
        • holiday_title string
        • holiday_status string
        • holiday_id number
        • id number
        • title string
        • value string
      • first_page_url string
      • from integer
      • last_page integer
      • last_page_url string
      • next_page_url string
      • path string
      • per_page integer
      • prev_page_url string
      • to integer
      • total integer
    • message string
  • application/json
    Hide response attributes Show response attributes object
    • status string
    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • current_page number
      • data array[object]
        Hide data attributes Show data attributes object
        • rate_cards_id number
        • business_unit_id number
        • job_id number
        • day_id number
        • shift_id number
        • custom_holiday_id number
        • rate_type string
        • client_rate string
        • shift string
        • client_name string
        • business_unit_name string
        • job string
        • day string
        • holiday_date string
        • holiday_title string
        • holiday_status string
        • holiday_id number
      • first_page_url string
      • from integer
      • last_page integer
      • last_page_url string
      • next_page_url string
      • path string
      • per_page string
      • prev_page_url string
      • to integer
      • total integer
    • message string
GET /report/ratecard/clientrate 
curl \
 --request GET 'https://api-console.logezy.co/v1/report/ratecard/clientrate' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"
Response examples (200) 
{
  "data": {
    "to": 4,
    "data": [
      {
        "id": 1,
        "day": "Tuesday",
        "job": "Cleaner",
        "shift": "Night",
        "title": "Private Limited",
        "value": "0.00",
        "day_id": 2,
        "job_id": 10,
        "shift_id": 234,
        "rate_type": "hourly_rate",
        "holiday_id": null,
        "client_name": "24 Care",
        "client_rate": "22.00",
        "holiday_date": null,
        "holiday_title": null,
        "rate_cards_id": 2124,
        "holiday_status": null,
        "business_unit_id": 58,
        "custom_holiday_id": 0,
        "business_unit_name": "24 Care Unit 2"
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/ratecard/staffrate",
    "total": 4,
    "per_page": 10,
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/staffrate?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/staffrate?page=1"
  },
  "status": "success",
  "message": "Staff Rate reports retrieved successfully."
}
Response examples () 
{
  "data": {
    "to": 4,
    "data": [
      {
        "day": "Monday",
        "job": "Nurse",
        "shift": "Night",
        "day_id": 1,
        "job_id": 1,
        "shift_id": 6,
        "rate_type": "hourly_rate",
        "holiday_id": null,
        "client_name": "AIMS",
        "client_rate": "12.00",
        "holiday_date": null,
        "holiday_title": null,
        "rate_cards_id": 4,
        "holiday_status": null,
        "business_unit_id": 1,
        "custom_holiday_id": 0,
        "business_unit_name": "Tvm"
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/ratecard/clientrate",
    "total": 4,
    "per_page": 10,
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/clientrate?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/ratecard/clientrate?page=1"
  },
  "status": "success",
  "message": "Client Rate reports retrieved successfully."
}