Client Reports

GET /report/client

This API is to get client 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 string

Id of the region to filter report
client string

Id of the client to filter report
start_date string

The planned day to get report from
end_date string

The planned day to get report till
candidate number

ID of the candidate to filter report
job number

ID of the job to filter report
per_page number

Minimum value is 1 and maximum value is 100

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_name string
  
  job_title 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
  
  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/client

curl \
 --request GET 'https://api-console.logezy.co/v1/report/client' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"

Response examples (200)

{
  "data": {
    "to": 4,
    "data": [
      {
        "shift": "Day",
        "client": "A Care",
        "on_day": "Wednesday",
        "status": "invoiced",
        "on_date": "21-12-2022",
        "end_time": "08:00 PM",
        "job_title": "Nurse",
        "start_time": "08:00 AM",
        "client_rate": "100.00",
        "total_hours": "12.00",
        "invoice_rate": "100.00",
        "invoice_hours": "12.00",
        "candidate_name": "Abey K",
        "client_pay_amount": "1200.00",
        "invoice_total_amount": "1200.00"
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/client",
    "total": 4,
    "per_page": 10,
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/client?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/client?page=1"
  },
  "status": "success",
  "message": "Client reports retrieved successfully."
}