Properties

To get information about a specific tax, you can use the following endpoint:

where <name> is the name of the tax and <parameters> is an optional query string.

The following parameters are available:

Parameter	Description
paydate	The check date in the format YYYY-mm-dd. Default is the current date.
field	The specific field to return. Default is all fields.

Field names are:

Field	Description	Type
name	tax name	string
title	tax title	string
taxtype	tax type - F, S, L, O, or P (see Tax names)	string
published	Date tax published by Caliber Technology–may be empty	string
effective_date	Date tax goes became effective–may be empty	string
withheld	True if withheld from employee pay	boolean
rounding_required	True if tax calculation must be rounded	boolean
rounding_optional	True if tax calculation can be rounded	boolean
has_tax	True if tax exists	boolean
nonresident	True if tax only applies to nonresidents	boolean
exemptions_instructions	Description of value required in the exemptions field, suitable as help text for a user-facing form	string
stateexemptions_instructions	Description of value required in the stateexemptions field, suitable as help text for a user-facing form	string
stateexemptions_tag	Brief description of the stateexemptions field, suitable as a label on a user-facing form	string
miscellaneous_instructions	Description of value required in the miscellaneous field, suitable as help text for a user-facing form	string
miscellaneous_tag	Brief description of the miscellaneous field, suitable as a label on a user-facing form	string
auxiliary_instructions	Description of value required in the auxiliary field, suitable as help text for a user-facing form	string
auxiliary_tag	Brief description of the auxiliary field, suitable as a label on a user-facing form	string
psd	Tax identifier required for OH and PA W-2 reporting	integer

Examples

For example, to list all properities for the ‘CA’ tax:

To retrieve the effective date for the “AL Fairfield” tax: