Benefit
object is used to represent a benefit that an employee has enrolled in.benefit_plan_type
field on the Benefit
common model after 8/1/2023. This means we will not add any improvements or support any bug fixes related to this field on this common model. We strongly recommend using the Employer Benefit
common model to access thebenefit_plan_type
field. If you have any questions, please contact us.id
Stringremote_id
Stringemployee
Stringprovider_name
Stringbenefit_plan_type
StringDeprecatedThe benefit_plan_type
field on the Benefit
object is deprecated
employee_contribution
Numbercompany_contribution
Numberstart_date
Stringend_date
Stringremote_was_deleted
Booleanemployer_benefit
Stringcreated_at
Stringmodified_at
Stringfield_mappings
Objectremote_data
RemoteData[]{"id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name": "Blue Shield of California","employee_contribution": 23.65,"company_contribution": 150,"start_date": "2020-11-15 00:59:25.309761+00:00","end_date": "2021-10-15 00:23:25.309761+00:00","remote_was_deleted": true,"employer_benefit": "025fjlc6-6000-430a-848e-aafacbadf4fe","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}
https://api.merge.dev/api/hris/v1/benefits
Returns a list of Benefit
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name": "Blue Shield of California","employee_contribution": 23.65,"company_contribution": 150,"start_date": "2020-11-15 00:59:25.309761+00:00","end_date": "2021-10-15 00:23:25.309761+00:00","remote_was_deleted": true,"employer_benefit": "025fjlc6-6000-430a-848e-aafacbadf4fe","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
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberemployer_benefit
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberemployer_benefit
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringemployee_contribution
Numberemployer_benefit
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberemployer_benefit
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
Stringhttps://api.merge.dev/api/hris/v1/benefits/{id}
Returns a Benefit
object with the given id
.
Authorization
StringX-Account-Token
Stringexpand
Stringid
Stringinclude_remote_data
Boolean{"id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name": "Blue Shield of California","employee_contribution": 23.65,"company_contribution": 150,"start_date": "2020-11-15 00:59:25.309761+00:00","end_date": "2021-10-15 00:23:25.309761+00:00","remote_was_deleted": true,"employer_benefit": "025fjlc6-6000-430a-848e-aafacbadf4fe","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
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberemployer_benefit
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberemployer_benefit
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringemployee_contribution
Numberemployer_benefit
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberend_date
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberemployer_benefit
Stringend_date
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
String