Create a benefit

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

employee

string

required

ID of the employee associated with the benefit.

benefit

string

required

Type of supported benefit. See types of benefits.

company_benefit

string

The company benefit to associate this employee benefit with.

period

string

The period over which a period amount is distributed. Can be "monthly" or null.

description

string

Optional description to distinguish the benefit within a plan. Maximum length of 255 characters.

company_contribution_amount

string

Amount for company to contribute per payroll

company_contribution_percent

float

Decimal percentage of gross pay for company to contribute per payroll from 0 to 100.

company_period_amount

string

Amount for company to contribute over period.

employee_contribution_amount

string

Amount for employee to contribute per payroll

employee_contribution_percent

float

Decimal percentage of gross pay for company to contribute per payroll from 0 to 100.

employee_period_amount

string

Amount for employee to contribute over period.

effective_start

date

Start date for the benefit

effective_end

date

End date for the benefit

hsa_contribution_limit

string

Contribution limit of a HSA benefit

metadata

json

Additional loosely structured information to associate with this employee benefit

201201