Sign in
Employer Benefits

Get Employer Benefit By Id

Returns a Employer Benefit object with the given id.

get/api/hris/v1/employer-benefits/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

expandstring nullable

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

plan_namestring nullable required

The name of the plan.

provider_namestring nullable required

The name of the benefit provider.

benefit_plan_typestring nullable required

The type of benefit plan

deduction_codestring nullable required

The employer benefit's deduction code.

descriptionstring nullable required

The employer benefit's description.

benefit_plan_category'MEDICAL' | 'VISION' | 'DENTAL' | 'HEALTH_SAVINGS' | 'FLEXIBLE_SPENDING' | 'LIFE_INSURANCE' | 'DISABILITY' | 'SUPPLEMENTAL_INSURANCE' | 'RETIREMENT' | 'WELLNESS' | 'OTHER' nullable required

The category of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.

coverage_tiersstring[] nullable required

The coverage tiers for the benefit plan. If the value is not one of the defined enum values, the original value passed through will be returned.

start_datestring nullable required

The day and time the benefit started.

end_datestring nullable required

The day and time the benefit ended.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "plan_name": "Medical PPO",
  "provider_name": "Anthem",
  "benefit_plan_type": "Medical",
  "deduction_code": "MEDPPO",
  "description": "Preferred Provider Organization (PPO) plan with medical coverage.",
  "benefit_plan_category": "MEDICAL",
  "start_date": "2023-10-18T00:00:00Z",
  "end_date": "2024-10-16T00:00:00Z",
  "payroll_codes": [
    "018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
  ]
}

Changes

Changed in 3 of the 11 revisions of this API.8

  • a606b0cf18c92See the full diff
    • ○

      query request parameter expand list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the query request parameter expand, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6f24c7fcb3f82See the full diff
    • ○

      added the new optional query request parameter expand

      new-optional-request-parameter

    • ○

      added the optional property payroll_codes to the response with the 200 status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb3486b88e554See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added