Employer Benefits
Get Employer Benefit By Id
Returns a Employer Benefit object with the given id.
GET
/
api
/
hris
/
v1
/
employer-benefits
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-connector-token
string
requiredPath Parameters
id
string
requiredQuery Parameters
include_raw_data
boolean
default: falseWhether 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
requiredremote_id
string | null
requiredThe third-party API ID of the matching object.
modified_at
string
requiredThis is the datetime that this object was last updated by Bindbee
plan_name
string | null
requiredThe name of the plan.
provider_name
string | null
requiredThe name of the benefit provider.
benefit_plan_type
string | null
requiredThe type of benefit plan
deduction_code
string | null
requiredThe employer benefit's deduction code.
description
string | null
requiredThe employer benefit's description.
raw_data
object | null
This is the Raw data