Benefit data model

Company-wide benefit plans available to employees.

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
e.g. "401(k) Plan"
descriptionstring
e.g. "Company 401(k) retirement plan"
company_idstring
(reference to HrisCompany)
type enum
Valid values:
"RETIREMENT"
"HEALTH"
"DENTAL"
"VISION"
"LIFE"
tax enum
Valid values:
"PRE_TAX"
"POST_TAX"
"TAXABLE"
"NON_TAXABLE"
"TAX"
Tax describes the tax treatment of the benefit
frequency enum
Valid values:
"ONE_TIME"
"DAY"
"QUARTER"
"YEAR"
"HOUR"
Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).
is_activeboolean
employer_contribution_type enum
Valid values:
"PERCENTAGE"
"FIXED"
employer_contribution_amountnumber
percentage or money
employer_contribution_max_amountnumber
always money
coverage_level enum
Valid values:
"EMPLOYEE_ONLY"
"EMPLOYEE_SPOUSE"
"EMPLOYEE_CHILD"
"EMPLOYEE_CHILDREN"
"EMPLOYEE_FAMILY"
currencystring
Are we missing anything? Let us know
Was this page helpful?