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

Authorizationstringheaderrequired

Bearer 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>required

Response

200Successful response
timesheetPeriodIDstringrequired
roleInOrgIDstringrequired
employeeNamestringrequired
workEmailstring | nullrequired
departmentstring | nullrequired
countryCodestring | nullrequired
timezonestringrequired
periodTypestringrequired
periodStartstringrequired
periodEndstringrequired
statusstringrequired
complianceStatusstringrequired
totalNetMinutesnumberrequired
totalOvertimeMinutesnumberrequired
employeeSignedAtstring | nullrequired
signedByNamestring | nullrequired
adminApprovedAtstring | nullrequired
approvalNotestring | nullrequired
approvalRemediationActionstring | nullrequired
rejectionReasonstring | nullrequired
daysobject[]required
Show child attributes
timesheetEntryIDstring | nullrequired
workDatestringrequired
startTimestring | nullrequired
endTimestring | nullrequired
breakStartTimestring | nullrequired
breakEndTimestring | nullrequired
breaksobject[]required
Show child attributes
startTimestringrequired
endTimestringrequired
kindstringrequired
paidbooleanrequired
workedboolean
minutesnumberrequired
breakMinutesnumberrequired
netMinutesnumberrequired
overtimeMinutesnumberrequired
sourcestring | nullrequired
complianceStatusstringrequired
notestring | nullrequired
isHolidaybooleanrequired
isLeavebooleanrequired
findingsobject[]required
Show child attributes
ruleTypestringrequired
statusstringrequired
workDatestring | nullrequired
limitnumber | nullrequired
actualnumber | nullrequired
unitstring | nullrequired
messagestringrequired
historyobject[]required
Show child attributes
idstringrequired
atstringrequired
actorNamestringrequired
eventTypestringrequired
descriptionstring | nullrequired
workDatestring | nullrequired
timezonestring | nullrequired
viastring | nullrequired
bulkbooleanrequired
changesobject[]required
Show child attributes
fieldstringrequired
fromanyrequired
toanyrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits