GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
These docs are for v2024-03-01. Click to read the latest docs for v2026-06-15.

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

Path Params
string
required

The UUID of the payroll

string
required

The UUID of the employee

Body Params
number

regular hours worked in this pay period

number

overtime hours worked in this pay period

number

double overtime hours worked in this pay period

number

paid time off hours used in this pay period

number

sick hours used in this pay period

Headers
string
enum
Defaults to 2024-03-01

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

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json