Payroll runs & approvals

Get Payroll Cutoff Status

Tells the caller whether wallet editing is blocked by the payroll cutoff window.

GEThttps://api.toku.com/hris/get-payroll-cutoff-status

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/hris/get-payroll-cutoff-status' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "isBlocked": true,
  "reason": "string",
  "cutoffDate": "2026-01-01T00:00:00Z",
  "payDate": "2026-01-01T00:00:00Z"
}

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
isBlockedbooleanrequired
reasonstring
cutoffDatestring<date-time>
payDatestring<date-time>
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits