GuidesReferenceChangelogAPI Upgrades
Reference

Create a benefit

post
https://sandbox.checkhq.com/benefits

Creates a benefit.

Body Params
string
required

ID of the employee associated with the benefit.

string
required

Type of supported benefit. See types of benefits.

string

The company benefit to associate this employee benefit with.

string

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

string

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

string

Amount for company to contribute per payroll

float

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

string

Amount for company to contribute over period.

string

Amount for employee to contribute per payroll

float

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

string

Amount for employee to contribute over period.

date

Start date for the benefit

date

End date for the benefit

string

Contribution limit of a HSA benefit

json

Additional loosely structured information to associate with this employee benefit

Response

Updated 6 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here!
Updated 6 months ago