Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Dependent Benefits

Get Dependent Benefit By Id

Returns a Dependent Benefit object with the given id.

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

employer_benefitstring nullable required

The employer benefit plan the dependent is enrolled in.

dependentstring nullable required

The dependent which belongs to this benefit.

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.

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"
  },
  "employer_benefit": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "dependent": "018abccb-c4a9-72f6-be1d-3fc7aaf2be67",
  "start_date": "2023-10-18T00:00:00Z",
  "effective_date": "2023-10-18T00:00:00Z",
  "end_date": "2024-10-16T00:00:00Z"
}