Deduction data model

Employee-specific deduction/benefit enrolment.

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)
user_idstring
employee ID (reference to HrisEmployee)
company_idstring
(reference to HrisCompany)
benefit_idstring
amountnumber
percentage or absolute amount (employee's portion)
type enum
Valid values:
"FIXED"
"PERCENTAGE"
coverage_level enum
Valid values:
"EMPLOYEE_ONLY"
"EMPLOYEE_SPOUSE"
"EMPLOYEE_CHILD"
"EMPLOYEE_CHILDREN"
"EMPLOYEE_FAMILY"
Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
frequency enum
Valid values:
"ONE_TIME"
"DAY"
"QUARTER"
"YEAR"
"HOUR"
Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)
start_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_activeboolean
notesstring
Are we missing anything? Let us know
Was this page helpful?