GET
/
api
/
hris
/
v1
/
employer-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

The Employer Benefit object is used to represent a benefit plan offered by a company.

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

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

deduction_code
string | null
required

The employer benefit's deduction code.

description
string | null
required

The employer benefit's description.

raw_data
object | null

This is the Raw data