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

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

employeeUUID
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_dateDateTime (ISO 8601)
Optional
The day and time the benefit started.

end_dateDateTime (ISO 8601)
Optional
The day and time the benefit ended.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

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

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/benefits

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

US
EU

Returns a list of Benefit objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
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_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
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.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
Altera Payroll
Altera Payroll
BambooHR
BambooHR
Breathe
Breathe
Gusto
Gusto
HR Partner
HR Partner
OysterHR
OysterHR
Paychex
Paychex
Paylocity
Paylocity
UKG Pro
UKG Pro
UKG Ready
UKG Ready
GET
/benefits/{id}

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

US
EU

Returns a Benefit object with the given id.


Query & Path Parameters

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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
Altera Payroll
Altera Payroll
BambooHR
BambooHR
Breathe
Breathe
Gusto
Gusto
HR Partner
HR Partner
OysterHR
OysterHR
Paychex
Paychex
Paylocity
Paylocity
UKG Pro
UKG Pro
UKG Ready
UKG Ready