Api doc


SDK's


Api Modules

reports.timesheets



Supported Methods:

GET
Params
  • token (Required): valid token
  • start_date (Required): date
  • end_date (Required): date
  • type (Required): enum (timesheets_summary, timesheets_attendance, timesheets_late_summary)
  • deductbreaks: integer
  • location: integer
  • schedule: varchar
  • employee: varchar
  • skill: varchar
  • remote_site: integer
  • approval_status: integer


Documentation

GET
Retrieves a list of timesheet reports.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "start_date": required //Start date (date)
  2. "end_date": required //End date (date)
  3. "location": accepted //Location id (integer)
  4. "schedule": accepted //Schedule id (integer)
  5. "employee": accepted //Employees (varchar)
  6. /* Array of employees ids (eg. "234,563,770") */
  7. "skill": accepted //Skill id (integer)
  8. "type": required //Type (enum[timesheets_summary,timesheets_attendance])
  9. /* timesheets_summary: Timesheets summary
  10.   * timesheets_attendance: Timesheets attendance */
  11. "deductbreaks": accepted //Deduct breaks (integer)
  12. /* null or 0 : Do not deduct breaks
  13.   * 1: Deduct breaks */
  14. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"GET",
  3. "module":"reports.schedule",
  4. "request":{
  5. "start_date":"1",
  6. "end_date":"15",
  7. "location":"342",
  8. "schedule":"1584",
  9. "employee":"954",
  10. "skill":"24",
  11. "type":"timesheets_summary"
  12. }
  13. }

Example Response:

  1. {
  2. "status":"1",
  3. "data":{
  4. "id":"1376",
  5. "name":"John Smith",
  6. "shifts":"0",
  7. "hours_scheduled":"0",
  8. "hours_clocked":"0",
  9. "late":"0",
  10. "absent":"0",
  11. "karma":"0",
  12. "percent":"0"
  13. },
  14. "token":"xxxxxxxx"
  15. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close