Api doc


SDK's


Api Modules

payroll.report

Run Payroll Specific Reports on schedule / time sheet data.



Supported Methods:

GET
Params
  • token (Required): valid token
  • type (Required): enum (scheduledhours, confirmedhours, timesheets)
  • start_date: date
  • end_date: date
  • location: integer
  • schedule: varchar
  • employee: varchar
  • skill: varchar
  • deduct_breaks: enum (0, 1)
  • group_results: enum (0, 1, 2)
  • show_empty: enum (0, 1)
  • split_overnight: enum (0, 1)
  • remote_site: integer
  • options: integer
  • include_unapproved_ts: integer
  • include_remote_sites: integer
  • terminal_location: integer
  • show_only_mine: enum (0, 1)
  • show_break_times: integer
  • include_notes: enum (0, 1)


Documentation

GET
Run Payroll Specific Reports on schedule / time sheet data.
Level 3 is required.

--

Parameters:

  1. "type": required //Type (enum[scheduledhours,confirmedhours,timesheets])
  2. /* scheduledhours: Scheduled hours
  3.   * confirmedhours: Confirmed hours
  4.   * timesheets: Timesheets */
  5. "start_date": accepted //Start date (date)
  6. "end_date": accepted //End date (date)
  7. "location": accepted //Location id (integer)
  8. "schedule": accepted //Schedule id (integer)
  9. "employee": accepted //Employees (varchar)
  10. /* Array of employees ids (eg. "323,657,887") */
  11. "skill": accepted //Skill id (integer)
  12. "deduct_breaks": accepted //Deduct breaks (enum[0,1])
  13. /* 0: Do not deduct breaks
  14.   * 1: Deduct breaks */
  15. "group_results": accepted //Group results (enum[1,2])
  16. /* 1: Group by employee
  17.   /* 2: Group by employee/position */
  18. "show_empty": accepted //Show empty (enum[0,1])
  19. /* 0: Do not show empty
  20.   * 1: Show empty */
  21. "split_overnight": accepted //Split overnight shifts (enum[0,1])
  22. /* 0: Do not split
  23.   * 1: Split */
  24. "remote_site": accepted //Remote site id (integer)
  25. "options": accepted //Options (integer)
  26. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"payroll.report",
  3. "method":"GET",
  4. "request":{
  5. "type":"timesheets",
  6. "employee":"258265"
  7. "start_date":"10/09/2013",
  8. "end_date":"10/15/2013"
  9. }
  10. }

Example Response:

  1. {
  2. "status":1,
  3. "data":[
  4. {
  5. "eid": "l123",
  6. "end_time": "5:00pm",
  7. "clock": "3952393",
  8. "date": {
  9. "id": 1624,
  10. "week": 41,
  11. "formatted": "Oct 9, 2013",
  12. "dayid": 4,
  13. "weekday": "Wed",
  14. "mname": "Oct",
  15. "month": 10,
  16. "timestamp": 1381269600,
  17. "year": 2013,
  18. "day": 9
  19. },
  20. "out_date": {
  21. "id": 1624,
  22. "week": 41,
  23. "formatted": "Oct 9, 2013",
  24. "dayid": 4,
  25. "weekday": "Wed",
  26. "mname": "Oct",
  27. "month": 10,
  28. "timestamp": 1381269600,
  29. "year": 2013,
  30. "day": 9
  31. },
  32. "userid": "258265",
  33. "start_time": "7:00am",
  34. "notes": "",
  35. "overnight": false,
  36. "employee": "Lisa",
  37. "hours": {
  38. "regular": 0,
  39. "cost": 165,
  40. "ratecard": {
  41. "name": "Default Card",
  42. "override_payroll": "0",
  43. "pay_code": null,
  44. "id": 11264
  45. },
  46. "position": {
  47. "name": "Kids",
  48. "id": "153311",
  49. "start": "1",
  50. "job_code": null,
  51. "visible": "1",
  52. "active": "1",
  53. "color": "1",
  54. "end": "97",
  55. "user": "258225",
  56. "ical": "41acb6085ceec40616c3a40b2a57a674",
  57. "store": "18769",
  58. "notify": "1"
  59. },
  60. "overtime": 10,
  61. "rate": "10",
  62. "special": 0,
  63. "breaks": 0,
  64. "d_overtime": 2,
  65. "total": 10,
  66. "location": {
  67. "lon": "-95.71289100000001",
  68. "name": "Springfield",
  69. "id": "46233",
  70. "country": "",
  71. "notes": "",
  72. "lat": "37.09024",
  73. "type": "1",
  74. "store": "18769",
  75. "address": "United States",
  76. "timezone_id": "314"
  77. },
  78. "base_wage": "10"
  79. }
  80. },
  81. {
  82. "eid": "l123",
  83. "end_time": "11:51am",
  84. "clock": "3952399",
  85. "date": {
  86. "id": 1624,
  87. "week": 41,
  88. "formatted": "Oct 9, 2013",
  89. "dayid": 4,
  90. "weekday": "Wed",
  91. "mname": "Oct",
  92. "month": 10,
  93. "timestamp": 1381269600,
  94. "year": 2013,
  95. "day": 9
  96. },
  97. "out_date": {
  98. "id": 1624,
  99. "week": 41,
  100. "formatted": "Oct 9, 2013",
  101. "dayid": 4,
  102. "weekday": "Wed",
  103. "mname": "Oct",
  104. "month": 10,
  105. "timestamp": 1381269600,
  106. "year": 2013,
  107. "day": 9
  108. },
  109. "userid": "258265",
  110. "start_time": "11:32am",
  111. "notes": "",
  112. "overnight": false,
  113. "employee": "Lisa",
  114. "hours": {
  115. "regular": 0,
  116. "cost": "22.5",
  117. "ratecard": {
  118. "name": "Default Card",
  119. "override_payroll": "0",
  120. "pay_code": null,
  121. "id": 11264
  122. },
  123. "position": {
  124. "name": "",
  125. "id": ""
  126. },
  127. "overtime": "0.31583333333333",
  128. "rate": "10",
  129. "special": 0,
  130. "breaks": 0,
  131. "d_overtime": "0.31583333333333",
  132. "total": "0.31583333333333",
  133. "location": {
  134. "name": "",
  135. "id": ""
  136. },
  137. "base_wage": "10"
  138. }
  139. }
  140. ],
  141. "token":"xxxxxxx"
  142. }

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