Skip to content

Tax object

An object representing a single tax.

Properties

PropertyTypeDescription
$namestringThe name of the tax.
$typestringThe type of the tax (see TaxType for a list).
$roundbooleanTrue if calculated result must be rounded. Note that the compute function handles rounding automatically.
$withheldbooleanTrue if this tax is to be paid by the employee. False if it is an employer-paid tax.
$state_exemption_instructionsstringSpecific 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_instructionsstringSpecific instructions (if needed) for the $misc value passed to the compute function.
$auxiliary_instructionsstringSpecific instructions (if needed) for the $aux value passed to the compute function.
$miscellaneous_tagstringA 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_tagstringA brief label summarizing the use of $aux in this tax.
$stateexemption_tagstringA brief label summarizing the use of $stateexemptions in this tax.
$homerulestringUsed internally by taxNamesForZip
$workrulestringUsed internally by taxNamesForZip

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