Employer Benefits
The Employer Benefit object is used to represent a benefit plan offered by a company.
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

benefit_plan_typeEnum
Optional
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.

nameString
Optional
The employer benefit's name - typically the carrier or network name.

descriptionString
Optional
The employer benefit's description.

deduction_codeString
Optional
The employer benefit's deduction code.

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

field_mappingsObject
Optional

remote_dataArray
Optional


GET
/employer-benefits

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

US
EU

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.

cursorString
Optional
The pagination cursor value.

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
Gusto
Paychex
Paychex
Paylocity
Paylocity
UKG Ready
UKG Ready
GET
/employer-benefits/{id}

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

US
EU

Returns an EmployerBenefit object with the given id.


Query & Path Parameters

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
Gusto
Paychex
Paychex
Paylocity
Paylocity
UKG Ready
UKG Ready