Sign in
User Overtime

Get user overtime summary

get/v1/users/{userId}/overtime/summary

Path parameters

userIdstring required

User ID

Response

User overtime balances

idstring
contractIdstring
periodTypestring
periodStartstring
periodEndstring
targetMinutesinteger
targetMinutesToDateinteger
currentDayTargetMinutesinteger
currentWeekTargetMinutesinteger
currentMonthTargetMinutesinteger
actualMinutesinteger
overtimeMinutesinteger
undertimeMinutesinteger
undertimeTrackedboolean
compensatedMinutesinteger
adjustmentMinutesinteger
remainingMinutesinteger
expiredMinutesinteger
flextimeBalanceMinutesinteger
flextimeCarryOverMinutesinteger
regularMinutesinteger
nightMinutesinteger
weekendMinutesinteger
holidayMinutesinteger
standbyMinutesinteger
standbyEffectiveMinutesinteger
standbyActivationMinutesinteger
earlyShiftMinutesinteger
lateShiftMinutesinteger
nightShiftMinutesinteger
breakDeductedMinutesinteger
breakPaidMinutesinteger
maxDailyHoursExceededDaysinteger
maxWeeklyHoursExceededboolean
overtimeTier1Minutesinteger
overtimeTier2Minutesinteger
overtimeTier3Minutesinteger
allInIncludedMinutesinteger
allInExcessMinutesinteger
grossOvertimeValuestring decimal
surchargeValuestring decimal
totalValuestring decimal
monetaryValueApplicableboolean
currencystring
statusstring
approvedBystring
approvedAtinteger
approvalNotesstring
paidOutMinutesinteger
paidOutAtinteger
timeOffTakenMinutesinteger
calculatedAtinteger
canApproveboolean
canRejectboolean
canCompensateboolean
lastUpdateinteger
createdinteger

Changes

No recorded changes to this endpoint across all 3 revisions of this API.