Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Time Off Policies

Calculate accruing time off hours

Returns a list of accruing time off for each time off policy associated with the employee.

Factors affecting the accrued hours:

  • the time off policy accrual method (whether they get pay per hour worked, per hour paid, with / without overtime, accumulate time off based on pay period / calendar year / anniversary)
  • how many hours of work during this pay period
  • how many hours of PTO / sick hours taken during this pay period (for per hour paid policies only)
  • company pay schedule frequency (for per pay period)

If none of the parameters is passed in, the accrued time off hour will be 0.

scope: payrolls:read

post/v1/payrolls/{payroll_id}/employees/{employee_id}/calculate_accruing_time_off_hours

Path parameters

payroll_idstring required

The UUID of the payroll

employee_idstring required

The UUID of the employee

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

regular_hours_workedstring float nullable

Regular hours worked in this pay period

overtime_hours_workedstring float nullable

Overtime hours worked in this pay period

double_overtime_hours_workedstring float nullable

Double overtime hours worked in this pay period

pto_hours_usedstring float nullable

Paid time off hours used in this pay period

sick_hours_usedstring float nullable

Sick hours used in this pay period

Response

Successful