Retrieve completed form PDF and tax parameters

Return a completed form PDF and relevant tax parameters based on submitted employee data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
employee
object
required
employer
object
fields
object
required
string
enum
Defaults to PREVIEW
Allowed:
string
Defaults to %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

boolean

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

Headers
string

A Timezone ID. If not specified, defaults to ETC/UTC. Documented here: https://client-docs.symmetry.com/docs/spf-api-timezones

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Jump to top