Time tracking
Get Timesheet Period Detail
Returns one timesheet period with per-day entries in the employee's timezone and compliance findings.
GEThttps://api.toku.com/hris/get-timesheet-period-detail
Required scope: time:read
curl --request GET \
--url 'https://api.toku.com/hris/get-timesheet-period-detail?timesheetPeriodID=%3CtimesheetPeriodID%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"timesheetPeriodID": "string",
"roleInOrgID": "string",
"employeeName": "string",
"workEmail": "string",
"department": "string",
"countryCode": "string",
"timezone": "string",
"periodType": "string",
"periodStart": "string",
"periodEnd": "string",
"status": "string",
"complianceStatus": "string",
"totalNetMinutes": 0,
"totalOvertimeMinutes": 0,
"employeeSignedAt": "string",
"signedByName": "string",
"adminApprovedAt": "string",
"approvalNote": "string",
"approvalRemediationAction": "string",
"rejectionReason": "string",
"days": [
{
"timesheetEntryID": "string",
"workDate": "string",
"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,
"isLeave": true
}
],
"findings": [
{
"ruleType": "string",
"status": "string",
"workDate": "string",
"limit": 0,
"actual": 0,
"unit": "string",
"message": "string"
}
],
"history": [
{
"id": "string",
"at": "string",
"actorName": "string",
"eventType": "string",
"description": "string",
"workDate": "string",
"timezone": "string",
"via": "string",
"bulk": true,
"changes": [
{
"field": "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
timesheetPeriodIDstring<uuid>requiredResponse
200Successful response
timesheetPeriodIDstringrequiredroleInOrgIDstringrequiredemployeeNamestringrequiredworkEmailstring | nullrequireddepartmentstring | nullrequiredcountryCodestring | nullrequiredtimezonestringrequiredperiodTypestringrequiredperiodStartstringrequiredperiodEndstringrequiredstatusstringrequiredcomplianceStatusstringrequiredtotalNetMinutesnumberrequiredtotalOvertimeMinutesnumberrequiredemployeeSignedAtstring | nullrequiredsignedByNamestring | nullrequiredadminApprovedAtstring | nullrequiredapprovalNotestring | nullrequiredapprovalRemediationActionstring | nullrequiredrejectionReasonstring | nullrequireddaysobject[]requiredShow child attributes
timesheetEntryIDstring | nullrequiredworkDatestringrequiredstartTimestring | nullrequiredendTimestring | nullrequiredbreakStartTimestring | nullrequiredbreakEndTimestring | nullrequiredbreaksobject[]requiredShow child attributes
startTimestringrequiredendTimestringrequiredkindstringrequiredpaidbooleanrequiredworkedbooleanminutesnumberrequiredbreakMinutesnumberrequirednetMinutesnumberrequiredovertimeMinutesnumberrequiredsourcestring | nullrequiredcomplianceStatusstringrequirednotestring | nullrequiredisHolidaybooleanrequiredisLeavebooleanrequiredfindingsobject[]requiredShow child attributes
ruleTypestringrequiredstatusstringrequiredworkDatestring | nullrequiredlimitnumber | nullrequiredactualnumber | nullrequiredunitstring | nullrequiredmessagestringrequiredhistoryobject[]requiredShow child attributes
idstringrequiredatstringrequiredactorNamestringrequiredeventTypestringrequireddescriptionstring | nullrequiredworkDatestring | nullrequiredtimezonestring | nullrequiredviastring | nullrequiredbulkbooleanrequiredchangesobject[]requiredShow child attributes
fieldstringrequiredfromanyrequiredtoanyrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits