Tax object

An object representing a single tax.

Properties

Property	Type	Description
$name	string	The name of the tax.
$type	string	The type of the tax (see TaxType for a list).
$round	boolean	True if calculated result must be rounded. Note that the compute function handles rounding automatically.
$withheld	boolean	True if this tax is to be paid by the employee. False if it is an employer-paid tax.
$state_exemption_instructions	string	Specific instructions (if needed) for the $stateexemptions value passed to the compute function. These instructions are intended for the payroll administrator, to explain what the $stateexemptions field value represents when setting up the employee.
$miscellaneous_instructions	string	Specific instructions (if needed) for the $misc value passed to the compute function.
$auxiliary_instructions	string	Specific instructions (if needed) for the $aux value passed to the compute function.
$miscellaneous_tag	string	A brief label summarizing the use of $misc in this tax. Rather than prompting the end user for ‘miscellaneous’, use this label to prompt for (as an example), ‘Dependents’.
$auxiliary_tag	string	A brief label summarizing the use of $aux in this tax.
$stateexemption_tag	string	A brief label summarizing the use of $stateexemptions in this tax.
$homerule	string	Used internally by taxNamesForZip
$workrule	string	Used internally by taxNamesForZip

The actual Tax object code in tables.php omits any field which is empty or false.