Create a time off policy

post

https://api.gusto-demo.com/v1/companies/{company_uuid}/time_off_policies

scope: time_off_policies:write

Path Params

company_uuid

string

required

The UUID of the company

Body Params

Requires a policy name, a policy_type, and an accrual_method

name

string

required

Name of the time off policy

policy_type

string

required

Type of the time off policy. Currently only "vacation" and "sick" are supported

accrual_method

string

enum

required

Accrual method of the time off policy

accrual_rate

string

The rate at which the time off hours will accrue for an employee on the policy. Represented as a float, e.g. "40.0".

accrual_rate_unit

string

The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".

paid_out_on_termination

boolean

Boolean representing if an employee's accrued time off hours will be paid out on termination

accrual_waiting_period_days

integer

Number of days before an employee on the policy will begin accruing time off hours. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0.

carryover_limit_hours

string

The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.

max_accrual_hours_per_year

string

The max number of hours an employee can accrue in a year. If accrual_method is unlimited, then max_accrual_hours_per_year must be blank.

max_hours

string

The max number of hours an employee can accrue. If accrual_method is unlimited, then max_hours must be blank.

Headers

X-Gusto-API-Version

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

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.