Generate Employee Tax Parameter Definitions

Retrieve all tax parameters used for withholding calculations.

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

attribute

type

description

success

boolean

Response status

data

object

A 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 parameter

effectiveDate
type: string
The tax parameter's effective date for calculations

type
type: string
description: a string representing the type of the parameter. We currently use options, strings, numbers, dollars, and boolean

defaults
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

errors

array

Contains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

Language
Credentials
Header
Click Try It! to start a request and see the response here!