Generate Employee Tax Parameter Definitions

Retrieve all tax parameters used for withholding calculations.

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

This request retrieves a dictionary of tax parameter definition arrays indexed by the "US" for federal or a US State (2-letter abbreviation), used by Zeal for tax withholding calculations.

Returns

attributetypedescription
successbooleanResponse status
dataobjectA dictionary of tax parameter definition arrays indexed by the "US" for federal or a US State ( 2 letter abbreviation).
Show child attributes code
type: string
description: codename of tax parametereffectiveDate
type: string
The tax parameter's effective date for calculationstype
type: string
description: a string representing the type of the parameter. We currently use options, strings, numbers, dollars, and booleandefaults
type: array
description: An array of default values and their effective date for the tax parameter
  • source* (BETA)
    type: string
    description: Line/step in the jurisdiction's W4 that the parameter is sourced from

  • label* (BETA)
    type: string
    description: Human readable label for the tax parameter

errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
jurisdictions
array of strings
required

"US" for federal or a US State (2 letter abbreviation)

jurisdictions*
Responses

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