Create a deduction

POST/hris/{connection_id}/deduction

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

Payload

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:
"EMPLOYEE_ONLY"
"EMPLOYEE_SPOUSE"
"EMPLOYEE_CHILD"
"EMPLOYEE_CHILDREN"
"EMPLOYEE_FAMILY"
Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
frequency enum
Valid values:
"ONE_TIME"
"DAY"
"QUARTER"
"YEAR"
"HOUR"
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

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:
"EMPLOYEE_ONLY"
"EMPLOYEE_SPOUSE"
"EMPLOYEE_CHILD"
"EMPLOYEE_CHILDREN"
"EMPLOYEE_FAMILY"
Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
frequency enum
Valid values:
"ONE_TIME"
"DAY"
"QUARTER"
"YEAR"
"HOUR"
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: 'POST',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?