If a roster shift exists that could match for this employee to clock on at this time given ESS settings for shift matching, returns that shift. Otherwise, the Shift result will be null. Note that if the time matches a shift exactly, the Shift result will also be null. However, if allowNotEnded is set to true, the ongoing shift will be returned.


GET https://api.nzpayroll.co.nz/api/v2/ess/{employeeId}/shift/matchingclockon

Path parameters

Parameter name Value Description Additional
employeeId string Required

Query parameters

Parameter name Value Description Additional
localTime date-time Required
allowNotEnded boolean Required


The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK