GET
/
api
/
hris
/
v1
/
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 Benefit object is used to represent a benefit that an employee has enrolled in.

benefit_plan_type
string | null
required

The type of benefit plan

company_contribution
required

The company's contribution.

custom_fields
object | null
required

The custom fields related to the model

employee
any | null
required

The employee on the plan.

employee_contribution
required

The employee's contribution.

employer_benefit
any | null
required

The employer benefit plan the employee is enrolled in.

end_date
string | null
required

The day and time the benefit ended.

frequency
string | null
required

The frequency of the plan

id
string
required
modified_at
string
required

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

plan_name
string | null
required

The name of the plan.

provider_name
string | null
required

The name of the benefit provider.

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