Retrieve a benefit
GET/hris/{connection_id}/benefit/{id}
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Benefit
Returns
Company-wide benefit plans available to employees.
idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
e.g. "401(k) Plan"
descriptionstring
e.g. "Company 401(k) retirement plan"
company_idstring
(reference to HrisCompany)
tax enum
Valid values:
"PRE_TAX"
"POST_TAX"
"TAXABLE"
"NON_TAXABLE"
"TAX"
Tax describes the tax treatment of the benefit
frequency enum
Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).
is_activeboolean
employer_contribution_type enum
Valid values:
"PERCENTAGE"
"FIXED"
employer_contribution_amountnumber
percentage or money
employer_contribution_max_amountnumber
always money
coverage_level enum
currencystring
const options = {
method: 'GET',
url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/benefit/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know