Common ModelsBenefits

The Benefit object

The Benefit object is used to represent a benefit that an employee has enrolled in.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
employeestring or nullOptionalformat: "uuid"
The employee on the plan.
provider_namestring or nullOptional
The name of the benefit provider.
employee_contributiondouble or nullOptional
The employee's contribution.
company_contributiondouble or nullOptional
The company's contribution.
start_datedatetime or nullOptional
The day and time the benefit started.
end_datedatetime or nullOptional
The day and time the benefit ended.
employer_benefitstring or nullOptionalformat: "uuid"
The employer benefit plan the employee is enrolled in.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
benefit_plan_typestring or nullOptionalDeprecated
The type of benefit plan