Time tracking

Get Org Time Tracking Settings

Returns org time-tracking config, effective per-country rules with counts, and schedule templates.

GEThttps://api.toku.com/hris/get-org-time-tracking-settings

Required scope: time:read

curl --request GET \
  --url 'https://api.toku.com/hris/get-org-time-tracking-settings' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "isTimeTrackingEnabled": true,
  "canSetBeyondCountryRule": true,
  "config": {
    "clockWidgetEnabled": true,
    "weekStartsOn": 0,
    "breakTrackingMode": "string",
    "manualEntryGraceDays": 0,
    "signoffEscalationDays": 0,
    "defaultScheduleTemplateID": "string"
  },
  "countries": [
    {
      "countryCode": "string",
      "status": "string",
      "maxDailyHours": 0,
      "maxWeeklyHours": 0,
      "minDailyRestHours": 0,
      "minWeeklyRestHours": 0,
      "breakThresholdHours": 0,
      "breakDurationMinutes": 0,
      "shortBreakPay": "string",
      "mealBreakPay": "string",
      "recordRetentionYears": 0,
      "requiresPayrollIntegration": true,
      "autopilotEligible": true,
      "standardDailyHours": 0,
      "standardWeeklyHours": 0,
      "overtimeBasis": "string",
      "submissionCadence": "string",
      "submissionDeadlineDays": 0,
      "submissionScheduleFrom": "string",
      "approvalFlow": "string",
      "countryRule": {
        "maxDailyHours": 0,
        "maxWeeklyHours": 0,
        "minDailyRestHours": 0,
        "minWeeklyRestHours": 0,
        "standardDailyHours": 0,
        "standardWeeklyHours": 0,
        "shortBreakPay": "string",
        "mealBreakPay": "string"
      },
      "override": {
        "maxDailyHours": 0,
        "maxWeeklyHours": 0,
        "minDailyRestHours": 0,
        "minWeeklyRestHours": 0,
        "standardDailyHours": 0,
        "standardWeeklyHours": 0,
        "shortBreakPay": "string",
        "mealBreakPay": "string"
      },
      "overrideNotes": "string",
      "hasOrgOverride": true,
      "employeeCount": 0,
      "trackedEmployeeCount": 0
    }
  ],
  "templates": [
    {
      "timeTrackingScheduleTemplateID": "string",
      "name": "string",
      "countryCode": "string",
      "isActive": true,
      "days": [
        {
          "dayOfWeek": 0,
          "workStart": "string",
          "workEnd": "string",
          "breakStart": "string",
          "breakEnd": "string"
        }
      ],
      "assignedEmployeeCount": 0
    }
  ]
}

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.

Response

200Successful response
isTimeTrackingEnabledbooleanrequired
canSetBeyondCountryRulebooleanrequired
configobjectrequired
Show child attributes
clockWidgetEnabledbooleanrequired
weekStartsOnnumberrequired
breakTrackingModestringrequired
manualEntryGraceDaysnumberrequired
signoffEscalationDaysnumberrequired
defaultScheduleTemplateIDstring | nullrequired
countriesobject[]required
Show child attributes
countryCodestringrequired
statusstringrequired
maxDailyHoursnumber | nullrequired
maxWeeklyHoursnumber | nullrequired
minDailyRestHoursnumber | nullrequired
minWeeklyRestHoursnumber | nullrequired
breakThresholdHoursnumber | nullrequired
breakDurationMinutesnumber | nullrequired
shortBreakPaystringrequired
mealBreakPaystringrequired
recordRetentionYearsnumber | nullrequired
requiresPayrollIntegrationbooleanrequired
autopilotEligiblebooleanrequired
standardDailyHoursnumber | nullrequired
standardWeeklyHoursnumber | nullrequired
overtimeBasisstringrequired
submissionCadencestring | nullrequired
submissionDeadlineDaysnumber | nullrequired
submissionScheduleFromstring | nullrequired
approvalFlowstringrequired
countryRuleobjectrequired
Show child attributes
maxDailyHoursnumber | nullrequired
maxWeeklyHoursnumber | nullrequired
minDailyRestHoursnumber | nullrequired
minWeeklyRestHoursnumber | nullrequired
standardDailyHoursnumber | nullrequired
standardWeeklyHoursnumber | nullrequired
shortBreakPaystringrequired
mealBreakPaystringrequired
overrideobject | nullrequired
Show child attributes
maxDailyHoursnumber | nullrequired
maxWeeklyHoursnumber | nullrequired
minDailyRestHoursnumber | nullrequired
minWeeklyRestHoursnumber | nullrequired
standardDailyHoursnumber | nullrequired
standardWeeklyHoursnumber | nullrequired
shortBreakPaystring | nullrequired
mealBreakPaystring | nullrequired
overrideNotesstring | nullrequired
hasOrgOverridebooleanrequired
employeeCountnumberrequired
trackedEmployeeCountnumberrequired
templatesobject[]required
Show child attributes
timeTrackingScheduleTemplateIDstringrequired
namestringrequired
countryCodestring | nullrequired
isActivebooleanrequired
daysobject[]required
Show child attributes
dayOfWeeknumberrequired
workStartstringrequired
workEndstringrequired
breakStartstring | null
breakEndstring | null
assignedEmployeeCountnumberrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits