Employer Benefits
The
Employer Benefit object is used to represent a benefit plan offered by a company.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.
benefit_plan_typeEnumOptional
The type of benefit plan. Possible values include:
MEDICAL, HEALTH_SAVINGS, INSURANCE, RETIREMENT, OTHER. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.nameStringOptional
The employer benefit's name - typically the carrier or network name.
descriptionStringOptional
The employer benefit's description.
deduction_codeStringOptional
The employer benefit's deduction code.
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.
field_mappingsObjectOptional
remote_dataArrayOptional
GET
/employer-benefits
Betahttps://api.merge.dev/api/hris/v1/employer-benefits
US
EU
APAC
Returns a list of EmployerBenefit 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.
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_typeEnumdescriptionStringnameString
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_typeEnumdeduction_codeStringdescriptionStringnameStringremote_dataArrayremote_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_typeEnumdeduction_codeStringnameStringremote_dataArrayremote_idString
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_typeEnumdeduction_codeStringremote_dataArray
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
descriptionStringnameStringremote_dataArrayremote_idStringGET
/employer-benefits/{id}
Betahttps://api.merge.dev/api/hris/v1/employer-benefits/{id}
US
EU
APAC
Returns an EmployerBenefit object with the given id.
Query & Path Parameters
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_typeEnumdescriptionStringnameStringGusto
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_typeEnumdeduction_codeStringdescriptionStringnameStringremote_dataArrayremote_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_typeEnumdeduction_codeStringnameStringremote_dataArrayremote_idStringPaylocity
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_typeEnumdeduction_codeStringremote_dataArrayUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringnameStringremote_dataArrayremote_idString