Get Dependent Benefit By Id
Returns a Dependent Benefit object with the given id.
Authorizations
Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.
The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.
Path Parameters
Query Parameters
Whether to include the original data Bindbee fetched from the third-party to produce these models.
false
Whether to include custom fields in the response.
false
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.
"manager[first_name,last_name]"
Response
Successful Response
The Hris Dependent Benefit object is used to represent a benefit that an dependent has enrolled in.
"018b18ef-c487-703c-afd9-0ca478ccd9d6"
The third-party API ID of the matching object.
"123321"
This is the datetime that this object was last updated by Bindbee
"2021-10-16T00:00:00Z"
The custom fields related to the model
The employer benefit plan the dependent is enrolled in.
"018b18ef-c488-7d40-9131-91bbc47c1007"
The dependent which belongs to this benefit.
"018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
The day and time the benefit started.
"2023-10-18T00:00:00Z"
The day and time the benefit is effective from.
"2023-10-18T00:00:00Z"
The day and time the benefit ended.
"2024-10-16T00:00:00Z"
The name of the plan.
"Medical PPO"
The name of the benefit provider.
"Anthem"
The type of benefit plan
"Medical"
The category of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.
"MEDICAL"
This is the Raw data