Benefits
The
Benefit object is used to represent a benefit that an employee has enrolled in.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employeeUUIDOptional
The employee on the plan.
provider_nameStringOptional
The name of the benefit provider.
benefit_plan_typeStringDeprecatedOptional
The type of benefit plan
The benefit_plan_type field on the Benefit object is deprecated
employee_contributionNumberOptional
The employee's contribution.
company_contributionNumberOptional
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_deletedBooleanRequired
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.
employer_benefitUUIDOptional
The employer benefit plan the employee is enrolled in.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/benefits
https://api.merge.dev/api/hris/v1/benefits
US
EU
APAC
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.
cursorStringOptional
The pagination cursor value.
employee_idStringOptional
If provided, will return the benefits associated with the employee.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)
Altera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringemployeeUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
company_contributionNumberemployeeUUIDemployee_contributionNumberend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)
Breathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
company_contributionNumberemployeeUUIDemployee_contributionNumberend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDprovider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
HR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
OysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringemployeeUUIDprovider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Paychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
company_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)GET
/benefits/{id}
https://api.merge.dev/api/hris/v1/benefits/{id}
US
EU
APAC
Returns a Benefit object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)Altera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringemployeeUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
company_contributionNumberemployeeUUIDemployee_contributionNumberend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)Breathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
company_contributionNumberemployeeUUIDemployee_contributionNumberend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDprovider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)OysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringemployeeUUIDprovider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
benefit_plan_typeStringcompany_contributionNumberemployeeUUIDemployee_contributionNumberend_dateDateTime (ISO 8601)provider_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
company_contributionNumberemployeeUUIDemployee_contributionNumberemployer_benefitUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)