Get Employee Tax Parameter Summary

Retrieve a list of an employee's tax withholding parameters.

Get all tax parameters for an Employee that Zeal will use on a given date.

Returns

attribute

type

description

employeeID

string

ID of the employee

effectiveDate

datetime

Effective date of the tax parameters in this request.

jurisdictions

array

List of jurisdictions, "US" for federal, or State(2 letter abbreviation)

params

array

List of effective Tax Parameters on a given date for the employee with flags, indicating if it is user provided or default value

Show child attributes

code
type: string
description: codename of tax parameter

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

value
type: string
description: Value that the parameter is set to

valueDescription
type: string
description: Human readable description of the value set

isDefaultValue
type: boolean
description: Set to true if value is set by default

  • isUserProvidedValue* (BETA)
    type: string
    description: Set to true if value is provided by the Employee
Language
Credentials
Header
Click Try It! to start a request and see the response here!