Calculate accruing time off hours
POST {{baseUrl}}/v1/payrolls/:payroll_id/employees/:employee_id/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
Request Body
{"regular_hours_worked"=>"<number>", "overtime_hours_worked"=>"<number>", "double_overtime_hours_worked"=>"<number>", "pto_hours_used"=>"<number>", "sick_hours_used"=>"<number>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[{"time_off_policy_uuid":"c3a15554-f124-415d-b2c4-90b430fd8eb1","hours":"3.2"},{"time_off_policy_uuid":"386fc48d-52d2-4009-87b3-368f74f6b3df","hours":"6.0"}]