Retrieve a deduction
GET/hris/{connection_id}/deduction/{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 Deduction
Returns
Employee-specific deduction/benefit enrolment.
idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstring
employee ID (reference to HrisEmployee)
company_idstring
(reference to HrisCompany)
benefit_idstring
amountnumber
percentage or absolute amount (employee's portion)
type enum
Valid values:
"FIXED"
"PERCENTAGE"
coverage_level enum
Valid values:
Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
frequency enum
Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)
start_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_activeboolean
notesstring
const options = {
method: 'GET',
url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know