hris
taxwithholding

List all taxwithholdings

Changed on

Returns a list of HrisTaxwithholdings. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/hris/{connection_id}/taxwithholding

Request

  • Base URL
    https://api.unified.to
  • 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)

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)

countrystring

ISO 3166-1 alpha-2 country code of the taxing authority (eg. US, CA)

jurisdiction_type'FEDERAL' | 'STATE' | 'LOCAL'
jurisdictionstring

region/locality code within the country (eg. CA, NY, NY-NYC); empty for FEDERAL

is_residentboolean

true for the resident (home) jurisdiction, false for a work-only jurisdiction

form'W4_2020' | 'W4_LEGACY' | 'STATE_FORM' | 'TD1' | 'OTHER'

withholding form the values come from (eg. 2020+ W-4)

filing_status'SINGLE' | 'MARRIED_JOINTLY' | 'MARRIED_SEPARATELY' | 'HEAD_OF_HOUSEHOLD' | 'QUALIFYING_SURVIVOR' | 'OTHER'
tax_codestring

jurisdiction-specific tax code (eg. UK 1257L)

allowancesnumber

withholding allowances (pre-2020 W-4 and most state forms)

claim_amountnumber

dollar exemption / claim amount (eg. Canada TD1, Illinois IL-W-4)

has_multiple_jobsboolean

W-4 step 2: multiple jobs or spouse works

dependents_amountnumber

W-4 step 3: dependents credit amount

other_income_amountnumber

W-4 step 4a: other income amount

other_deductions_amountnumber

W-4 step 4b: deductions amount

extra_withholding_amountnumber

W-4 step 4c: additional amount withheld each pay period

extra_withholding_percentnumber

additional percentage of wages withheld each pay period

override_type'NONE' | 'FIXED_AMOUNT' | 'PERCENT'

replaces the calculated withholding with a flat amount or percentage

override_amountnumber

money (FIXED_AMOUNT) or percentage (PERCENT) withheld instead of the calculated amount

is_exemptboolean

employee claims exemption from withholding in this jurisdiction

effective_atstring date-time

date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Changes