Time tracking
Get My Timesheet
Returns the caller's timesheet period for a date with per-day entries, holidays, leave and findings.
GEThttps://api.toku.com/hris/get-my-timesheet
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/hris/get-my-timesheet' \
--header 'Authorization: Bearer <token>'200 response
{
"tracking": {
"mode": "string",
"periodType": "string",
"timezone": "string",
"countryStatus": "string",
"manualEntryGraceDays": 0,
"approvalFlow": "string",
"weekStartsOn": 0,
"breakPay": {
"shortBreakPay": "string",
"mealBreakPay": "string"
}
},
"period": {
"timesheetPeriodID": "string",
"periodStart": "string",
"periodEnd": "string",
"dueOn": "string",
"status": "string",
"complianceStatus": "string",
"totalNetMinutes": 0,
"totalOvertimeMinutes": 0,
"employeeSignedAt": "string",
"signedByName": "string",
"rejectionReason": "string",
"canSignOff": true,
"signableFrom": "string"
},
"days": [
{
"timesheetEntryID": "string",
"workDate": "string",
"isoWeekday": 0,
"startTime": "string",
"endTime": "string",
"breakStartTime": "string",
"breakEndTime": "string",
"breaks": [
{
"startTime": "string",
"endTime": "string",
"kind": "string",
"paid": true,
"worked": true,
"minutes": 0
}
],
"breakMinutes": 0,
"netMinutes": 0,
"overtimeMinutes": 0,
"source": "string",
"complianceStatus": "string",
"note": "string",
"isHoliday": true,
"holidayName": "string",
"isLeave": true,
"isMissing": true,
"isEditable": true,
"breakPay": {
"shortBreakPay": "string",
"mealBreakPay": "string"
},
"clock": {
"startAt": "string",
"endAt": "string",
"timezone": "string",
"updatedAt": "string"
}
}
],
"findings": [
{
"ruleType": "string",
"status": "string",
"workDate": "string",
"message": "string"
}
]
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Query parameters
onDatestringAllowed: matches ^\d{4}-\d{2}-\d{2}$
Response
200Successful response
trackingobject | nullrequiredShow child attributes
modestringrequiredperiodTypestringrequiredtimezonestringrequiredcountryStatusstringrequiredmanualEntryGraceDaysnumberrequiredapprovalFlowstringrequiredweekStartsOnnumberrequiredbreakPayobjectrequiredShow child attributes
shortBreakPaystringrequiredmealBreakPaystringrequiredperiodobjectrequiredShow child attributes
timesheetPeriodIDstring | nullrequiredperiodStartstringrequiredperiodEndstringrequireddueOnstring | nullrequiredstatusstringrequiredcomplianceStatusstringrequiredtotalNetMinutesnumberrequiredtotalOvertimeMinutesnumberrequiredemployeeSignedAtstring | nullrequiredsignedByNamestring | nullrequiredrejectionReasonstring | nullrequiredcanSignOffbooleanrequiredsignableFromstring | nullrequireddaysobject[]requiredShow child attributes
timesheetEntryIDstring | nullrequiredworkDatestringrequiredisoWeekdaynumberrequiredstartTimestring | nullrequiredendTimestring | nullrequiredbreakStartTimestring | nullrequiredbreakEndTimestring | nullrequiredbreaksobject[]requiredShow child attributes
startTimestringrequiredendTimestringrequiredkindstringrequiredpaidbooleanrequiredworkedbooleanminutesnumberrequiredbreakMinutesnumberrequirednetMinutesnumberrequiredovertimeMinutesnumberrequiredsourcestring | nullrequiredcomplianceStatusstringrequirednotestring | nullrequiredisHolidaybooleanrequiredholidayNamestring | nullrequiredisLeavebooleanrequiredisMissingbooleanrequiredisEditablebooleanrequiredbreakPayobjectShow child attributes
shortBreakPaystringrequiredmealBreakPaystringrequiredclockobject | nullShow child attributes
startAtstringrequiredendAtstringrequiredtimezonestringrequiredupdatedAtstringrequiredfindingsobject[]requiredShow child attributes
ruleTypestringrequiredstatusstringrequiredworkDatestring | nullrequiredmessagestringrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits