[Sandbox] Simulate publishing a contractor tax statement

The Contractor Tax Statements API is currently in limited preview, and is not yet generally available.

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

The statement must be in draft publication status and must have statement data. Physical mail is not sent. By default, publishing runs asynchronously and the statement moves to published; poll the resource or listen for contractor_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 contractor tax statement. Requires an API key with the contractor:write or contractor:admin scope.

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.

The Contractor Tax Statements API is currently in limited preview, and is not yet generally available.

Simulates publishing a draft contractor tax statement to the contractor. Physical mail is not sent. By default, publishing runs asynchronously and the statement moves to published; poll the resource or listen for contractor_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 contractor 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