BIbindbee
Benefits

Get Benefit By Id

Changed on

Returns a Benefit object with the given id.

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

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

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.

include_custom_fieldsboolean

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

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

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

frequencystring 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_categorystring 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_tierstring 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"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the ANNUALLY enum value from the response property for the response status

    • info

      removed the BIWEEKLY enum value from the response property for the response status

    • info

      removed the DENTAL enum value from the response property for the response status

    • info

      removed the DISABILITY enum value from the response property for the response status

    • info

      removed the EMPLOYEE_1_DEPENDENT enum value from the response property for the response status

    • info

      removed the EMPLOYEE_1_HOUSEHOLD_MEMBER enum value from the response property for the response status

    • info

      removed the EMPLOYEE_CHILD enum value from the response property for the response status

    • info

      removed the EMPLOYEE_CHILDREN enum value from the response property for the response status

    • info

      removed the EMPLOYEE_DOMESTIC_PARTNER enum value from the response property for the response status

    • info

      removed the EMPLOYEE_FAMILY enum value from the response property for the response status

    • info

      removed the EMPLOYEE_ONLY enum value from the response property for the response status

    • info

      removed the EMPLOYEE_SPOUSE enum value from the response property for the response status

    • info

      removed the FLEXIBLE_SPENDING enum value from the response property for the response status

    • info

      removed the FOURWEEKLY enum value from the response property for the response status

    • info

      removed the HEALTH_SAVINGS enum value from the response property for the response status

    • info

      removed the HOURLY enum value from the response property for the response status

    • info

      removed the HSA_FAMILY enum value from the response property for the response status

    • info

      removed the LIFE_INSURANCE enum value from the response property for the response status

    • info

      removed the MEDICAL enum value from the response property for the response status

    • info

      removed the MONTHLY enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the PRO_RATA enum value from the response property for the response status

    • info

      removed the QUARTERLY enum value from the response property for the response status

    • info

      removed the RETIREMENT enum value from the response property for the response status

    • info

      removed the SEMIANNUALLY enum value from the response property for the response status

    • info

      removed the SEMIMONTHLY enum value from the response property for the response status

    • info

      removed the SPOUSE enum value from the response property for the response status

    • info

      removed the SUPPLEMENTAL_INSURANCE enum value from the response property for the response status

    • info

      removed the THIRTEEN-MONTHLY enum value from the response property for the response status

    • info

      removed the VISION enum value from the response property for the response status

    • info

      removed the WAIVED enum value from the response property for the response status

    • info

      removed the WEEKLY enum value from the response property for the response status

    • info

      removed the WELLNESS enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API