Set Employee Tax Parameters

Set an employee's tax withholding parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

After getting the tax parameter definitions from Zeal, you can store effectively dated tax parameters for an employee. Zeal will only use valid tax parameters set here or the defaults (outlined in the definitions endpoint).

Returns

attributetypedescription
employeeIDstringID of the Employee being updated
federalParametersarrayList of Tax Parameter
Show child attributes code
type: string
description: codename of tax parametervalue
type: string
description: Value for the given tax parameterjurisdiction
type: string
description: "US" for federaleffectiveDate
type: string
description: effective date of the tax parameter
stateParametersarrayList of Tax Parameter
Show child attributes code
type: string
description: codename of tax parametervalue
type: string
description: Value for the given tax parameterjurisdiction
type: string
description: example "CA" for stateeffectiveDate
type: string
description: effective date of the tax parameter
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of the Employee being updated

string
required

ID of the company that the employee belongs to

federalParameters
array of objects
required

An array of Tax Parameter entries

federalParameters*
stateParameters
array of objects

An array of state Tax Parameter entries

stateParameters
date

Effective Date of the tax parameters in this request. Only accepts YYYY-MM-DD date format. This effective date will apply to any net new changed parameters unless the date is explicitly declared in the individual parameter object. Note: Will default to the time of the request

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json