Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Timezone
string

A Timezone ID. If not specified, defaults to ETC/UTC. Documented here: Timezones

Body

application/json
formId
string
required

Form IDs - Use the /getAllFormIds endpoint to get all withholding form IDs available

employee
object
required
fields
object
required
formVersion
string
employer
object
signForm
enum<string>
default:PREVIEW
Available options:
PREVIEW,
SIGN,
SIGN_EXTERNALLY
signatureFormat
string
default:%name% %dateTime%

Use the following variables to set a format: %name% (full name), %firstName, %middleInitial%, %lastName%, %date%, and %dateTime%

federalValues
object

Object representation of the Federal W4 (W4101) tax parameters. This object will also accept the tax parameters directly, ex: filingStatus or FED.filingStatus

hasFederalLockInLetter
boolean

Indicates that the employee has a Federal lock in letter. SPF US only.

Response

OK

form
string

Form IDs - Use the /getAllFormIds endpoint to get all withholding form IDs available

notice
object
formVersion
string
formType
enum<string>
Available options:
CANADA_RESIDENT,
RESIDENT,
NON_RESIDENT,
RESIDENT_OUT_OF_STATE,
EXEMPT,
MILITARY,
EIC,
LOCAL,
PENSION,
EXEMPT_STUDENT,
EXEMPT_NATIVE_AMERICAN,
NONRESIDENT_EMPLOYER,
RESIDENT_ALLOWANCE_ADJ,
NON_RESIDENT_FORT_CAMPBELL,
EXEMPT_TAX_CREDIT,
RESIDENT_PITTSBURGH,
NON_RESIDENT_PITTSBURGH,
TAX_ADJ,
EXEMPT_MILITARY_SPOUSE
name
string
title
string
locality
string

States and territories

taxParameters
object[]
pdf
string