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.

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

  • Id of the business unit to filter report

  • per_page number

    Minimum value is 1 and maximum value is 100

  • Id of candidate to filter report

  • job string

    Id of job to filter report

Responses

GET /report/holiday_pay
curl \
 -X GET https://api-console.logezy.co/v1/report/holiday_pay?start_date=string&end_date=string \
 -H "Authorization: Bearer your-access-token" \
 -H "Accept: application/json"
Response examples (200)
{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "client": "24 Care",
        "business_unit_name": "24 Care Unit 1",
        "candidate_name": "Abey K",
        "job_name": "Nurse",
        "on_date": "23-12-2022",
        "holiday_pay_percentage": "12.07",
        "holiday_pay_rate": "1.46",
        "holiday_pay_amount": "16.06",
        "holiday_pay_status": "due",
        "id": 2215,
        "details": [
          {
            "assigned_vacancy_id": 2215,
            "start_time": "08:00 AM",
            "end_time": "08:00 PM",
            "break": 60,
            "total_hours": "11.00",
            "staff_rate": "0.00",
            "staff_pay_amount": "0.00"
          }
        ]
      }
    ],
    "first_page_url": "https://api.logezydev.co.uk/v1/report/holiday_pay?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/holiday_pay?page=1",
    "next_page_url": null,
    "path": "https://api.logezydev.co.uk/v1/report/holiday_pay",
    "per_page": 10,
    "prev_page_url": null,
    "to": 4,
    "total": 4
  },
  "message": "Holiday pay report retrieved successfully."
}