Skip to content

Tax calculation

To compute a specific tax, you can use the following endpoint:

where <name> is the tax name and <parameters> are the parameters are:

ParameterDescription
paydateThe check date in the format YYYY-mm-dd. Default is the current date.
payperiodsThe number of pay periods in the year. Default is 12 (monthly).
supplemental1 | Y | True if the check is supplemental pay. Default is false.
filingstatusEmployee filing status (see below)
earningsThe amount of earnings subject to the tax. Default is 0.
ytdearningsThe year-to-date earnings prior to the current pay period. Default is 0.
exemptionsThe number of federal exemptions claimed by the employee. Default is 0.
stateexemptionsThe number of state exemptions claimed by the employee. Default is 0.
ytdtaxThe year-to-date tax amount for this tax prior to the current pay period. Default is 0.
miscellaneousAdditional information needed for some tax calculations. Taxes which require miscellaneous input include a non-empty miscellaneous_instructions property. Defaults to 0.
auxiliaryAdditional information needed for some tax calculations. Taxes which require auxiliary input include a non-empty auxiliary_instructions property. Defaults to 0.
unemploymentrateEmployer’s unemployment rate, expressed as a floating point (e.g., 2.4% => 0.024). Defaults to 0.
round1 | Y | True to request rounding when it is optional. Default is false.
companyzipSet to employer ZIP code for unemployment tax purposes. Required only for FUTA calculation.

Example

As an example, to calculate NY with:

  • earnings = 1000
  • stateexemtions = 2
  • payperiods = 12 (default)

use: