Benefits

The Benefit object is used to represent a Benefit for an employee.

The Benefit object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

employeeString
Optional
The employee on the plan.

provider_nameString
Optional
The name of the benefit provider.

benefit_plan_typeEnum
Optional
The type of benefit plan Possible values include: MEDICAL, DENTAL, VISION, HSA, FSA_MEDICAL, FSA_DEPENDENT_CARE, SIMPLE_IRA, _401K, ROTH_401K, OTHER_NON_TAXABLE, COMMUTER_TRANSIT, COMMUTER_PARKING, _401K_LOAN_PAYMENT, SHORT_DISABILITY, LONG_DISABILITY, LIFE, SEP_IRA, SARSEP, CUSTOM_TAXABLE, _403B, ROTH_403B, STUDENT_LOAN, or - in cases where there is no clear mapping - the original value passed through.

employee_contributionNumber
Optional
The employee's contribution.

company_contributionNumber
Optional
The company's contribution.

remote_dataRemoteData[]
Optional

The Benefit object

{
  "id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "provider_name": "Blue Shield of California",
  "benefit_plan_type": "MEDICAL",
  "employee_contribution": 23.65,
  "company_contribution": 150,
  "remote_data": [
    {
      "path": "/benefits",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/benefits

Returns a list of Benefit objects.


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.

employee_idString
Optional
If provided, will only return time off for this employee.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

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, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232",
      "remote_id": "19202938",
      "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
      "provider_name": "Blue Shield of California",
      "benefit_plan_type": "MEDICAL",
      "employee_contribution": 23.65,
      "company_contribution": 150,
      "remote_data": [
        {
          "path": "/benefits",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

benefit_plan_typeEnum

employeeString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

employeeString

benefit_plan_typeEnum

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

benefit_plan_typeEnum

provider_nameString

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employeeString

benefit_plan_typeEnum

provider_nameString

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

employeeString

benefit_plan_typeEnum

remote_idString
POST

/benefits

BETA

Creates a Benefit object with the given values.


Query & Path Parameters


run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


remote_idString
Optional
The third-party API ID of the matching object.

employeeString
Optional
The employee on the plan. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee table.

provider_nameString
Optional
The name of the benefit provider.

benefit_plan_typeEnum
Optional
The type of benefit plan Must pass in one of the following choices: MEDICAL, DENTAL, VISION, HSA, FSA_MEDICAL, FSA_DEPENDENT_CARE, SIMPLE_IRA, _401K, ROTH_401K, OTHER_NON_TAXABLE, COMMUTER_TRANSIT, COMMUTER_PARKING, _401K_LOAN_PAYMENT, SHORT_DISABILITY, LONG_DISABILITY, LIFE, SEP_IRA, SARSEP, CUSTOM_TAXABLE, _403B, ROTH_403B, STUDENT_LOAN.

employee_contributionNumber
Optional
The employee's contribution.

company_contributionNumber
Optional
The company's contribution.

Response

{
  "id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "provider_name": "Blue Shield of California",
  "benefit_plan_type": "MEDICAL",
  "employee_contribution": 23.65,
  "company_contribution": 150,
  "remote_data": [
    {
      "path": "/benefits",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
GET

/benefits/{id}

Returns a Benefit object with the given id.


Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

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

Response

{
  "id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "provider_name": "Blue Shield of California",
  "benefit_plan_type": "MEDICAL",
  "employee_contribution": 23.65,
  "company_contribution": 150,
  "remote_data": [
    {
      "path": "/benefits",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

benefit_plan_typeEnum

employeeString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

employeeString

benefit_plan_typeEnum

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

benefit_plan_typeEnum

provider_nameString

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employeeString

benefit_plan_typeEnum

provider_nameString

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


company_contributionNumber

remote_dataRemoteData[]

employee_contributionNumber

employeeString

benefit_plan_typeEnum

remote_idString