Get Benefit By Id
Returns a Benefit object with the given id.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Path Parameters
Query Parameters
Whether to include the original data Bindbee fetched from the third-party to produce these models.
Whether to include custom fields in the response.
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
The Benefit object is used to represent a benefit that an employee has enrolled in.
The type of benefit plan
The company's contribution.
The custom fields related to the model
The employee on the plan.
The employee's contribution.
The employer benefit plan the employee is enrolled in.
The day and time the benefit ended.
The frequency of the plan
This is the datetime that this object was last updated by Bindbee
The name of the plan.
The name of the benefit provider.
The third-party API ID of the matching object.
The day and time the benefit started.
This is the Raw data