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

Authorizations

Authorization
string
headerrequired

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.

Response

200 - application/json
id
string
required
remote_id
string | null
required

The third-party API ID of the matching object.

modified_at
string
required

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

raw_data
object | null

This is the Raw data

employee
string | null
required

The employee on the plan.

plan_name
string | null
required

The name of the plan.

provider_name
string | null
required

The name of the benefit provider.

benefit_plan_type
string | null
required

The type of benefit plan

frequency
string | null
required

The frequency of the plan

employee_contribution
required

The employee's contribution.

company_contribution
required

The company's contribution.

start_date
string | null
required

The day and time the benefit started.

end_date
string | null
required

The day and time the benefit ended.

employer_benefit
string | null
required

The employer benefit plan the employee is enrolled in.

Get BenefitsGet Employer Benefits