Create a taxwithholding

Updated:

POST/hris/{connection_id}/taxwithholding

Creates a HrisTaxwithholding. Provide the unified HrisTaxwithholding fields in the request body; they are mapped to the provider's API. Returns the created HrisTaxwithholding.

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 tax withholding settings for one jurisdiction (eg. W-4)

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-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 enum
Valid values:
"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 enum
Valid values:
"W4_2020"
"W4_LEGACY"
"STATE_FORM"
"TD1"
"OTHER"
withholding form the values come from (eg. 2020+ W-4)
filing_status enum
Valid values:
"SINGLE"
"MARRIED_JOINTLY"
"MARRIED_SEPARATELY"
"HEAD_OF_HOUSEHOLD"
"QUALIFYING_SURVIVOR"
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 enum
Valid values:
"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_atdate-time
date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNoemployee ID (reference to HrisEmployee)
company_idstringNo(reference to HrisCompany)
countrystringNoISO 3166-1 alpha-2 country code of the taxing authority (eg. US, CA)
jurisdiction_typeenumNoValues: FEDERAL, STATE, LOCAL
jurisdictionstringNoregion/locality code within the country (eg. CA, NY, NY-NYC); empty for FEDERAL
is_residentbooleanNotrue for the resident (home) jurisdiction, false for a work-only jurisdiction
formenumNowithholding form the values come from (eg. 2020+ W-4) Values: W4_2020, W4_LEGACY, STATE_FORM, TD1, OTHER
filing_statusenumNoValues: SINGLE, MARRIED_JOINTLY, MARRIED_SEPARATELY, HEAD_OF_HOUSEHOLD, QUALIFYING_SURVIVOR, OTHER
tax_codestringNojurisdiction-specific tax code (eg. UK 1257L)
allowancesnumberNowithholding allowances (pre-2020 W-4 and most state forms)
claim_amountnumberNodollar exemption / claim amount (eg. Canada TD1, Illinois IL-W-4)
has_multiple_jobsbooleanNoW-4 step 2: multiple jobs or spouse works
dependents_amountnumberNoW-4 step 3: dependents credit amount
other_income_amountnumberNoW-4 step 4a: other income amount
other_deductions_amountnumberNoW-4 step 4b: deductions amount
extra_withholding_amountnumberNoW-4 step 4c: additional amount withheld each pay period
extra_withholding_percentnumberNoadditional percentage of wages withheld each pay period
override_typeenumNoreplaces the calculated withholding with a flat amount or percentage Values: NONE, FIXED_AMOUNT, PERCENT
override_amountnumberNomoney (FIXED_AMOUNT) or percentage (PERCENT) withheld instead of the calculated amount
is_exemptbooleanNoemployee claims exemption from withholding in this jurisdiction
effective_atstring (date-time)Nodate these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataHrisMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding',
  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?