Merge HR, Payroll, and Directory

Employer Benefits

The Employer Benefit object is used to represent a benefit plan offered by a company.

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

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 by third party webhooks.

created_atString

Required

modified_atString

Required

This is the datetime that this object was last updated by Merge

field_mappingsObject

Optional

remote_dataArray

Optional

The EmployerBenefit object

JSON


{
  "id": "025fjlc6-6000-430a-848e-aafacbadf4fele",
  "remote_id": "19202939",
  "benefit_plan_type": "MEDICAL",
  "name": "Kaiser Permanente Medical Plan",
  "description": "HDHP Silver Plan",
  "deduction_code": "COL",
  "remote_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

GET

/employer-benefits

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

Returns a list of EmployerBenefit objects.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

created_afterString

Optional

If provided, will only return objects created after this datetime.

created_beforeString

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_afterString

Optional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString

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.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "025fjlc6-6000-430a-848e-aafacbadf4fele",
      "remote_id": "19202939",
      "benefit_plan_type": "MEDICAL",
      "name": "Kaiser Permanente Medical Plan",
      "description": "HDHP Silver Plan",
      "deduction_code": "COL",
      "remote_was_deleted": true,
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeEnum

descriptionString

nameString

remote_dataArray

remote_idString

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeEnum

deduction_codeString

nameString

remote_dataArray

remote_idString

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeEnum

deduction_codeString

remote_dataArray

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

nameString

remote_dataArray

remote_idString

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/employer-benefits/{id}

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

Returns an EmployerBenefit object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

idString

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

Response

JSON


{
  "id": "025fjlc6-6000-430a-848e-aafacbadf4fele",
  "remote_id": "19202939",
  "benefit_plan_type": "MEDICAL",
  "name": "Kaiser Permanente Medical Plan",
  "description": "HDHP Silver Plan",
  "deduction_code": "COL",
  "remote_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}