Holiday Pay Report

GET /report/holiday_pay

This API is to get holiday pay 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
start_date string Required

The planned day to get report from
end_date string Required

The planned day to get report till
business_unit number

Id of the business unit to filter report
per_page number

Minimum value is 1 and maximum value is 100
candidate string

Id of candidate to filter report
job string

Id of job to filter report

Responses

200 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 string
  
  data array[object]
  
  Hide data attributes Show data attributes object
  
  client string
  
  business_unit_name string
  
  candidate_name string
  
  job_name string
  
  on_date string
  
  holiday_pay_percentage number
  
  holiday_pay_rate number
  
  holiday_pay_amount number
  
  holiday_pay_status string
  
  id number
  
  details array[object]
  
  Hide details attributes Show details attributes object
  
  assigned_vacancy_id number
  
  start_time string
  
  end_time string
  
  break number
  
  total_hours number
  
  staff_rate number
  
  staff_pay_amount number
  
  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

GET /report/holiday_pay

curl \
 --request GET 'https://api-console.logezy.co/v1/report/holiday_pay?start_date=string&end_date=string' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"

Response examples (200)

{
  "data": {
    "to": 4,
    "data": [
      {
        "id": 2215,
        "client": "24 Care",
        "details": [
          {
            "break": 60,
            "end_time": "08:00 PM",
            "staff_rate": "0.00",
            "start_time": "08:00 AM",
            "total_hours": "11.00",
            "staff_pay_amount": "0.00",
            "assigned_vacancy_id": 2215
          }
        ],
        "on_date": "23-12-2022",
        "job_name": "Nurse",
        "candidate_name": "Abey K",
        "holiday_pay_rate": "1.46",
        "business_unit_name": "24 Care Unit 1",
        "holiday_pay_amount": "16.06",
        "holiday_pay_status": "due",
        "holiday_pay_percentage": "12.07"
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/holiday_pay",
    "total": 4,
    "per_page": 10,
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/holiday_pay?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/holiday_pay?page=1"
  },
  "status": "success",
  "message": "Holiday pay report retrieved successfully."
}