Payroll

GET /report/payroll

This API is to get payroll 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 based on region

  • client number

    Id of the client to filter report based on client

  • 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

  • filter_type string

    Filter payroll report using date approved or by using from and to date, default will be from and to date

    Values are approved_at or on_date. Default value is on_date.

  • candidate number

    Id of the candidate to filter report

  • job number

    Id of job to filter report

  • payroll_frequency string

    Payroll frequency

    Values are Weekly, Monthly, or 4 Weekly.

  • employment_type number

    Id of Employment type 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 integer
      • data array[object]
        Hide data attributes Show data attributes object
        • candidate_code string
        • candidate_name string
        • candidate_first_name string
        • candidate_last_name string
        • payment_reference string
        • job_title string
        • business_unit string
        • client_name string
        • on_date string
        • approved_at string
        • shift string
        • payroll_id number
        • start_time string
        • end_time string
        • total_hours string
        • staff_rate string
        • staff_pay_amount number
        • client_rate string
        • client_pay_amount string
        • assign_vacancy_detail_id number
        • status string
        • assign_vacancy_id number
        • employment_types_id number
        • candidate_id number
        • job_id number
      • first_page_url string
      • 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/payroll
curl \
 --request GET 'https://api-console.logezy.co/v1/report/payroll?start_date=string&end_date=string' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"
Response examples (200)
{
  "data": {
    "to": 10,
    "data": [
      {
        "shift": "Day",
        "job_id": 2,
        "status": "invoiced",
        "on_date": "23-10-2018",
        "end_time": "01:30 AM",
        "job_title": "HCA",
        "payroll_id": null,
        "staff_rate": "0.00",
        "start_time": "12:30 PM",
        "approved_at": "28-04-2022 07:50 PM",
        "client_name": "24 Care",
        "client_rate": "0.00",
        "total_hours": "12.00",
        "candidate_id": 143,
        "business_unit": "24 Care Unit 2",
        "candidate_code": "DEM1CA143",
        "candidate_name": "Abigail Igbinedion Osarumwense",
        "staff_pay_amount": "0.00",
        "assign_vacancy_id": 1441,
        "client_pay_amount": "0.00",
        "payment_reference": null,
        "candidate_last_name": "Igbinedion Osarumwense",
        "employment_types_id": 1,
        "candidate_first_name": "Abigail",
        "assign_vacancy_detail_id": 2019
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/payroll",
    "total": 1490,
    "per_page": 10,
    "last_page": 149,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/payroll?page=149",
    "next_page_url": "https://api.logezydev.co.uk/v1/report/payroll?page=2",
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/payroll?page=1"
  },
  "status": "success",
  "message": "Payroll report retrieved successfully."
}