Benefits
The Benefit object is used to represent a benefit that an employee has enrolled in.
Merge will no longer support the 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.
Properties

idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

employeeString
Optional
The employee on the plan.

provider_nameString
Optional
The name of the benefit provider.

benefit_plan_typeStringDeprecated
Optional
The type of benefit plan

The benefit_plan_type field on the Benefit object is deprecated


employee_contributionNumber
Optional
The employee's contribution.

company_contributionNumber
Optional
The company's contribution.

start_dateString
Optional
The day and time the benefit started.

end_dateString
Optional
The day and time the benefit ended.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

employer_benefitString
Optional
The employer benefit plan the employee is enrolled in.

created_atString
Required

modified_atString
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

The Benefit object
JSON
{
"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
}

GET
/benefits

https://api.merge.dev/api/hris/v1/benefits

US
EU

Returns a list of Benefit objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

employee_idString
Optional
If provided, will return the benefits associated with the employee.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"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
}
]
}
Field support by platform
ADP Workforce Now
ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
Altera Payroll
Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

employeeString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
Breathe
Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
Gusto
Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

employer_benefitString

remote_idString
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
OysterHR
OysterHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

employeeString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString
Paychex
Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

employer_benefitString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
Paylocity
Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

employeeString

employee_contributionNumber

employer_benefitString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
Rippling
Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

remote_dataRemoteData[]
pathstring
datastring

remote_idString
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

employer_benefitString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/benefits/{id}

https://api.merge.dev/api/hris/v1/benefits/{id}

US
EU

Returns a Benefit object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"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
}
Field support by platform
ADP Workforce Now
ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
Altera Payroll
Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

employeeString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
Breathe
Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
Gusto
Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

employer_benefitString

remote_idString
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
OysterHR
OysterHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

employeeString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString
Paychex
Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

employer_benefitString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
Paylocity
Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

employeeString

employee_contributionNumber

employer_benefitString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

start_dateString
Rippling
Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

remote_dataRemoteData[]
pathstring
datastring

remote_idString
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


benefit_plan_typeString

company_contributionNumber

employeeString

employee_contributionNumber

end_dateString

provider_nameString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

employeeString

employee_contributionNumber

employer_benefitString

end_dateString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

start_dateString
Hint: Use the /linked-accounts endpoint to pull platform support information.