Employer Benefits
The
Employer Benefit
object is used to represent a benefit plan offered by a company.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
benefit_plan_type
EnumOptional
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.name
StringOptional
The employer benefit's name - typically the carrier or network name.
description
StringOptional
The employer benefit's description.
deduction_code
StringOptional
The employer benefit's deduction code.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappings
ObjectOptional
remote_data
ArrayOptional
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_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
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](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
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_type
Enumdescription
Stringname
String![](/static/b5d5c1854759bd0665de50ccff3750f5/35742/gusto_square_image.png)
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_type
Enumdescription
Stringname
Stringremote_data
Arrayremote_id
String![Paychex](https://merge-api-production.s3.amazonaws.com/media/Paychex_Square_Logo.png)
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_type
Enumdeduction_code
Stringname
Stringremote_data
Arrayremote_id
String![Paylocity](https://merge-api-production.s3.amazonaws.com/media/Paylocity_Square_Logo_LGm1Fdn.png)
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_type
Enumdeduction_code
Stringremote_data
Array![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
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
description
Stringname
Stringremote_data
Arrayremote_id
StringGET
/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
id
UUIDRequired
include_remote_data
BooleanOptional
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](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
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_type
Enumdescription
Stringname
String![](/static/b5d5c1854759bd0665de50ccff3750f5/35742/gusto_square_image.png)
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_type
Enumdescription
Stringname
Stringremote_data
Arrayremote_id
String![Paychex](https://merge-api-production.s3.amazonaws.com/media/Paychex_Square_Logo.png)
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_type
Enumdeduction_code
Stringname
Stringremote_data
Arrayremote_id
String![Paylocity](https://merge-api-production.s3.amazonaws.com/media/Paylocity_Square_Logo_LGm1Fdn.png)
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_type
Enumdeduction_code
Stringremote_data
Array![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
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
description
Stringname
Stringremote_data
Arrayremote_id
String