GET
/
api
/
hris
/
v1
/
dependent-benefits
/
{id}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default:
false

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

include_custom_fields
boolean
default:
false

Whether to include custom fields in the response.

expand
string

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.

Response

200 - application/json

The Hris Dependent Benefit object is used to represent a benefit that an dependent has enrolled in.

custom_fields
object | null
required

The custom fields related to the model

dependent
any | null
required

The dependent which belongs to this benefit.

employer_benefit
any | null
required

The employer benefit plan the dependent is enrolled in.

end_date
string | null
required

The day and time the benefit ended.

id
string
required
modified_at
string
required

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

remote_id
string | null
required

The third-party API ID of the matching object.

start_date
string | null
required

The day and time the benefit started.

raw_data
object | null

This is the Raw data