GET /report/businessunit

This API is to get business unit 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

  • candidate number

    Id of the candidaste to filter report

  • job number

    Id of the job 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

  • per_page string

    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 string
      • data array[object]
        Hide data attributes Show data attributes object
        • candidate_name string
        • job_title string
        • business_unit string
        • business_unit_id string
        • on_date string
        • on_day string
        • shift string
        • start_time string
        • end_time string
        • total_hours string
        • client_rate string
        • client_pay_amount string
        • status string
        • assign_vacancy_detail_id string
        • client string
        • invoice_hours string
        • invoice_rate string
        • invoice_total_amount 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
GET /report/businessunit 
curl \
 --request GET 'https://api-console.logezy.co/v1/report/businessunit?start_date=string&end_date=string' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"
Response examples (200) 
{
  "data": {
    "to": 4,
    "data": [
      {
        "shift": "Day",
        "client": "A Care",
        "on_day": "Monday",
        "status": "invoiced",
        "on_date": "19-12-2022",
        "end_time": "08:00 PM",
        "job_title": "Nurse",
        "start_time": "08:00 AM",
        "client_rate": "31.00",
        "total_hours": "12.00",
        "invoice_rate": "31.00",
        "business_unit": "A Care Weekly - Normal Rate",
        "invoice_hours": "12.00",
        "candidate_name": "Abey K",
        "business_unit_id": 212,
        "client_pay_amount": "372.00",
        "invoice_total_amount": "372.00",
        "assign_vacancy_detail_id": 2956
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/businessunit",
    "total": 4,
    "per_page": 10,
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/businessunit?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/businessunit?page=1"
  },
  "status": "success",
  "message": "Business unit reports retrieved successfully."
}