v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB

Time Clock:v1:TimeClocks:TimeClock:ManualBreaks:ManualBreakClockOut

Clock out from a manual break

End the currently open manual break for an employee. By default, if the break was started from an open shift, the shift is re-opened on the same job (mobile 'Return to job'). Set isResumeShift=false to end the break without resuming. Mandatory breaks cannot be ended before their configured minimum duration. Pass an optional timestamp to record a break that ended earlier (offline sync).

post/time-clock/v1/time-clocks/{timeClockId}/manual-breaks/clock-out

Path parameters

timeClockIdinteger required

The unique identifier of the time clock

Request body

userIdinteger required

The unique identifier of the user. Make sure the user is assigned to the specified time clock.

timezonestring

The timezone in Tz format (e.g. America/New_York). If not specified, the time clock's configured timezone is used.

timestampinteger

The break-end time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past, not in the future, and after the open break's start time. For mandatory breaks, the elapsed time used for the early-return check is measured against this value.

isResumeShiftboolean

Controls what happens after the break ends. Defaults to true (mobile 'Return to job'). When true and the break was started from an open shift, the shift is re-opened on the same job. When the break is standalone, no shift is resumed. Set to false to end the break without resuming (mobile 'End shift'). The response returns the actual outcome, which may be false even when true was requested.

Response

Successful Response

requestIdstring