Create an employee benefit

post

https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

scope: employee_benefits:write

Path Params

employee_id

string

required

The UUID of the employee

Body Params

company_benefit_uuid

string

required

The UUID of the company benefit.

active

boolean

Defaults to true

Whether the employee benefit is active.

employee_deduction

string

Defaults to 0.00

The amount to be deducted, per pay period, from the employee's pay.

deduct_as_percentage

boolean

Defaults to false

Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.

employee_deduction_annual_maximum

string | null

The maximum employee deduction amount per year. A null value signifies no limit.

contribution

object

An object representing the company contribution type and value.

elective

boolean

Defaults to false

Whether the company contribution is elective (aka "matching"). For tiered, elective_amount, and elective_percentage contribution types this is ignored and assumed to be true.

company_contribution_annual_maximum

string | null

The maximum company contribution amount per year. A null value signifies no limit.

limit_option

string | null

enum

Some benefits require additional information to determine
their limit.

Family or Individual: Applicable to HSA benefit.

Joint Filing or Single or Married and Filing Separately: Applicable to Dependent Care FSA benefit.

Allowed:

catch_up

boolean

Defaults to false

Whether the employee should use a benefit’s "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50.

coverage_amount

string | null

The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.

coverage_salary_multiplier

string

Defaults to 0.00

The coverage amount as a multiple of the employee’s salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.

deduction_reduces_taxable_income

string | null

enum

Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.

Allowed:

company_contribution

string

Defaults to 0.00

deprecated

The amount to be paid, per pay period, by the company.

contribute_as_percentage

boolean

Defaults to false

deprecated

Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.

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

201Example response

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.