Employer Benefit
object is used to represent a benefit plan offered by a company.id
Stringremote_id
Stringbenefit_plan_type
EnumMEDICAL
, HEALTH_SAVINGS
, INSURANCE
, RETIREMENT
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned.name
Stringdescription
Stringdeduction_code
Stringremote_was_deleted
Booleancreated_at
Stringmodified_at
Stringfield_mappings
Objectremote_data
Array{"id": "025fjlc6-6000-430a-848e-aafacbadf4fele","remote_id": "19202939","benefit_plan_type": "MEDICAL","name": "Kaiser Permanente Medical Plan","description": "HDHP Silver Plan","deduction_code": "COL","remote_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}
https://api.merge.dev/api/hris/v1/employer-benefits
Returns a list of EmployerBenefit
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "025fjlc6-6000-430a-848e-aafacbadf4fele","remote_id": "19202939","benefit_plan_type": "MEDICAL","name": "Kaiser Permanente Medical Plan","description": "HDHP Silver Plan","deduction_code": "COL","remote_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Enumdescription
Stringname
Stringremote_data
Arrayremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Enumdeduction_code
Stringname
Stringremote_data
Arrayremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Enumdeduction_code
Stringremote_data
Array
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringname
Stringremote_data
Arrayremote_id
Stringhttps://api.merge.dev/api/hris/v1/employer-benefits/{id}
Returns an EmployerBenefit
object with the given id
.
Authorization
StringX-Account-Token
Stringid
Stringinclude_remote_data
Boolean{"id": "025fjlc6-6000-430a-848e-aafacbadf4fele","remote_id": "19202939","benefit_plan_type": "MEDICAL","name": "Kaiser Permanente Medical Plan","description": "HDHP Silver Plan","deduction_code": "COL","remote_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Enumdescription
Stringname
Stringremote_data
Arrayremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Enumdeduction_code
Stringname
Stringremote_data
Arrayremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Enumdeduction_code
Stringremote_data
Array
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringname
Stringremote_data
Arrayremote_id
String