hris
deduction

List all deductions

Changed on
get/hris/{connection_id}/deduction

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/deduction
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

company_idstring

The company ID to filter by (reference to HrisCompany)

payslip_idstring

The payslip ID to filter by

benefit_idstring

The benefit ID to filter by

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

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

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(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'FIXED' | 'PERCENTAGE'
coverage_level'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'FAMILY' | 'OTHER'

Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)

frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'

Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_activeboolean
notesstring
employer_amountnumber

percentage or absolute amount (employer's portion/match)

employer_type'PERCENTAGE' | 'FIXED'
max_amountnumber

annual maximum employee amount (always money)

paycode_idstring

the hris_paycode (deduction code) this deduction uses

garnishment_type'CHILD_SUPPORT' | 'TAX_LEVY' | 'STUDENT_LOAN' | 'CREDITOR' | 'BANKRUPTCY' | 'OTHER'

set when this deduction is a court-ordered garnishment

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status