v1
latestOpenAPI 3.1.02026-07-243113441.2 MBCreate an employee benefit
Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment.
When the application has the employee_benefits:write:benefit_type_limited data scope, the application can only create employee benefits for benefit types that are permitted for the application.
scope: employee_benefits:write
Path parameters
The UUID of the employee
Headers
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
The UUID of the company benefit.
Whether the employee benefit is active.
The amount to be deducted, per pay period, from the employee's pay.
Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
The maximum employee deduction amount per year. A null value signifies no limit.
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.
The maximum company contribution amount per year. A null value signifies no limit.
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.
Whether the employee should use a benefit's "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50.
The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
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.
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.
The amount to be paid, per pay period, by the company.
Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.
The date the employee benefit will start. If not provided, the benefit will be effective from 1970-01-01 (unix epoch).
The date the employee benefit will expire. A null value indicates the benefit will not expire.
Response
Example response
The current version of the object. See the versioning guide for information on how to use this field.
Whether the employee benefit is active.
The amount to be deducted, per pay period, from the employee's pay.
Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
The maximum employee deduction amount per year. A null value signifies no limit.
Whether the company contribution is elective (aka matching). For "tiered" contribution types, this is always true.
The maximum company contribution amount per year. A null value signifies no limit.
Some benefits require additional information to determine their limit.
Family and Individual are applicable to HSA benefit.
Joint Filing or Single and Married and Filing Separately are applicable to Dependent Care FSA benefit.
Whether the employee should use a benefit's "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50.
Identifier for a 401(k) loan assigned by the 401(k) provider
The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
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.
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.
The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.
Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.
The date the employee benefit will start.
The date the employee benefit will expire. A null value indicates the benefit will not expire.
The UUID of the employee to which the benefit belongs.
The UUID of the company benefit.
The UUID of the employee benefit.