[Sandbox] Simulate publishing an employee tax statement

Simulate publishing a draft employee tax statement to the employee in sandbox. Sandbox-only: in production this endpoint returns a 404.

The statement must be in draft publication status and must have statement data (refresh the company's filings if needed). Physical mail is not sent. By default, publishing runs asynchronously and the statement moves to published; poll the resource or listen for employee_tax_statement.updated webhooks as publishing completes. Set notify_only to true to send only the publish notification and leave the statement in draft. Returns the employee tax statement.

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

Only supported in Sandbox. In production this endpoint returns a 404.

Simulates publishing a draft employee tax statement to the employee. Physical mail is not sent. By default, publishing runs asynchronously and the statement moves to published; poll the resource or listen for employee_tax_statement.updated webhooks as publishing completes.

Optional request body: set notify_only to true to send only the publish notification and leave the statement in draft publication status (defaults to false).

Path Params
string
required

ID of the employee tax statement

Body Params
boolean
Defaults to false

When true, sends only the publish notification and leaves the tax statement in draft publication status.

Responses

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