Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Benefits

Get Benefit By Id

Returns a Benefit object with the given id.

get/api/hris/v1/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

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 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

employeestring nullable required

The employee on the plan.

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

frequency'HOURLY' | 'WEEKLY' | 'BIWEEKLY' | 'QUARTERLY' | 'SEMIANNUALLY' | 'ANNUALLY' | 'THIRTEEN-MONTHLY' | 'PRO_RATA' | 'SEMIMONTHLY' | 'MONTHLY' | 'FOURWEEKLY' | '-' nullable required

The frequency of the 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.

effective_datestring nullable required

The day and time the benefit is effective from.

end_datestring nullable required

The day and time the benefit ended.

employer_benefitstring nullable required

The employer benefit plan the employee is enrolled in.

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_tier'WAIVED' | 'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'EMPLOYEE_DOMESTIC_PARTNER' | 'HSA_FAMILY' | 'SPOUSE' | 'EMPLOYEE_1_DEPENDENT' | 'EMPLOYEE_1_HOUSEHOLD_MEMBER' nullable required

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

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"
  },
  "employee": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "plan_name": "Medical PPO",
  "provider_name": "Anthem",
  "benefit_plan_type": "Medical",
  "frequency": "SEMIMONTHLY",
  "start_date": "2023-10-18T00:00:00Z",
  "effective_date": "2023-10-18T00:00:00Z",
  "end_date": "2024-10-16T00:00:00Z",
  "employer_benefit": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "benefit_plan_category": "MEDICAL",
  "coverage_tier": "EMPLOYEE_ONLY"
}