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:
| Parameter | Description |
|---|---|
paydate |
The check date in the format YYYY-mm-dd. Default is the current date. |
payperiods |
The number of pay periods in the year. Default is 12 (monthly). |
supplemental |
1 | Y | True if the check is supplemental pay. Default is false. |
filingstatus |
Employee filing status (see below) |
earnings |
The amount of earnings subject to the tax. Default is 0. |
ytdearnings |
The year-to-date earnings prior to the current pay period. Default is 0. |
exemptions |
The number of federal exemptions claimed by the employee. Default is 0. |
stateexemptions |
The number of state exemptions claimed by the employee. Default is 0. |
ytdtax |
The year-to-date tax amount for this tax prior to the current pay period. Default is 0. |
miscellaneous |
Additional information needed for some tax calculations. Taxes which require miscellaneous input include a non-empty miscellaneous_instructions property. Defaults to 0. |
auxiliary |
Additional information needed for some tax calculations. Taxes which require auxiliary input include a non-empty auxiliary_instructions property. Defaults to 0. |
unemploymentrate |
Employer’s unemployment rate, expressed as a floating point (e.g., 2.4% => 0.024). Defaults to 0. |
round |
1 | Y | True to request rounding when it is optional. Default is false. |
companyzip |
Set to employer ZIP code for unemployment tax purposes. Required only for FUTA calculation. |
Example
Section titled “Example”As an example, to calculate NY with:
- earnings = 1000
- stateexemtions = 2
- payperiods = 12 (default)
use: