Run Payroll Specific Reports on schedule / time sheet data.
SUPPORTED METHODS:
GET
| Parameters | Type | Description |
|---|---|---|
| token (required) | Valid token | |
| type (requires) | enum[scheduledhours,confirmedhours,timesheets] | scheduledhours: Takes all (confirmed and unconfirmed) shifts into the calculation. confirmedhours: Takes only confirmed shifts into the calculation. timesheets: By default takes only confirmed time sheets into the calculation. |
| start_date (accepted) | date | Start date |
| end_date (accepted) | date | End date |
| location (accepted) | integer | Location id |
| schedule (accepted) | integer | Schedule id |
| employee (accepted) | varchar | Employees Array of employees ids (eg. "323,657,887") -99 - returns the data for deactivated and deleted employees all - returns deactivated, deleted and active employees |
| skill (accepted) | varchar | Skill id |
| deduct_breaks (accepted) | enum (0, 1) | Deduct breaks 0: Do not deduct breaks 1: Deduct breaks |
| group_results (accepted) | enum (1, 2) | Group results 1: Group by employee 2: Group by employee/position |
| show_empty (accepted) | enum (0, 1) | Show empty 0: Do not show empty 1: Show empty |
| split_overnight (accepted) | enum (0, 1) | Show empty 0: Do not show empty 1: Show empty |
| remote_site (accepted) | integer | Remote site id |
| options (accepted) | integer | |
| include_unapproved_ts (accepted) | integer | If set to 1, all time sheets (approved and unapproved) will be included into calculation. Default value: 0 |
| include_remote_sites (accepted) | integer | |
| terminal_location (accepted) | integer | Terminal location id |
| show_only_mine (accepted) | enum(0,1) | |
| show_break_times (accepted) | integer | |
| include_notes (accepted) | enum(0,1) | 0: do not notes 1: include notes |
DOCUMENTATION
GET
Run Payroll Specific Reports on schedule / time sheet data.
Level 3 is required.
--
Example Request:
{
"module":"payroll.report",
"method":"GET",
"request":{
"type":"timesheets",
"employee":"258265"
"start_date":"10/09/2013",
"end_date":"10/15/2013"
}
}
Example Response:
{
"status":1,
"data":[
{
"eid":"l123",
"end_time":"5:00pm",
"clock":"3952393",
"date":{
"id":1624,
"week":41,
"formatted":"Oct 9, 2013",
"dayid":4,
"weekday":"Wed",
"mname":"Oct",
"month":10,
"timestamp":1381269600,
"year":2013,
"day":9
},
"out_date":{
"id":1624,
"week":41,
"formatted":"Oct 9, 2013",
"dayid":4,
"weekday":"Wed",
"mname":"Oct",
"month":10,
"timestamp":1381269600,
"year":2013,
"day":9
},
"userid":"258265",
"start_time":"7:00am",
"notes":"",
"overnight":false,
"employee":"Lisa",
"hours":{
"regular":0,
"cost":165,
"ratecard":{
"name":"Default Card",
"override_payroll":"0",
"pay_code":null,
"id":11264
},
"position":{
"name":"Kids",
"id":"153311",
"start":"1",
"job_code":null,
"visible":"1",
"active":"1",
"color":"1",
"end":"97",
"user":"258225",
"ical":"41acb6085ceec40616c3a40b2a57a674",
"store":"18769",
"notify":"1"
},
"overtime":10,
"rate":"10",
"special":0,
"breaks":0,
"d_overtime":2,
"total":10,
"location":{
"lon":"-95.71289100000001",
"name":"Springfield",
"id":"46233",
"country":"",
"notes":"",
"lat":"37.09024",
"type":"1",
"store":"18769",
"address":"United States",
"timezone_id":"314"
},
"base_wage":"10"
}
},
{
"eid":"l123",
"end_time":"11:51am",
"clock":"3952399",
"date":{
"id":1624,
"week":41,
"formatted":"Oct 9, 2013",
"dayid":4,
"weekday":"Wed",
"mname":"Oct",
"month":10,
"timestamp":1381269600,
"year":2013,
"day":9
},
"out_date":{
"id":1624,
"week":41,
"formatted":"Oct 9, 2013",
"dayid":4,
"weekday":"Wed",
"mname":"Oct",
"month":10,
"timestamp":1381269600,
"year":2013,
"day":9
},
"userid":"258265",
"start_time":"11:32am",
"notes":"",
"overnight":false,
"employee":"Lisa",
"hours":{
"regular":0,
"cost":"22.5",
"ratecard":{
"name":"Default Card",
"override_payroll":"0",
"pay_code":null,
"id":11264
},
"position":{
"name":"",
"id":""
},
"overtime":"0.31583333333333",
"rate":"10",
"special":0,
"breaks":0,
"d_overtime":"0.31583333333333",
"total":"0.31583333333333",
"location":{
"name":"",
"id":""
},
"base_wage":"10"
}
}
],
"token":"xxxxxxx"
}