Common ModelsEmployer benefits

The EmployerBenefit object

The Employer Benefit object is used to represent a benefit plan offered by a company.

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
benefit_plan_typeenum or nullOptional

The type of benefit plan.

  • MEDICAL - MEDICAL
  • HEALTH_SAVINGS - HEALTH_SAVINGS
  • INSURANCE - INSURANCE
  • RETIREMENT - RETIREMENT
  • OTHER - OTHER
Allowed values:
namestring or nullOptional<=200 characters
The employer benefit's name - typically the carrier or network name.
descriptionstring or nullOptional<=2000 characters
The employer benefit's description.
deduction_codestring or nullOptional<=60 characters
The employer benefit's deduction code.
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional
remote_datalist of objects or nullOptional