CHcheckhq

[Sandbox] Simulate unpublishing an employee tax statement

Changed on

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

The statement must be in published publication status. Statements included in an employer copy aggregate or statements with a pending correction cannot be unpublished individually. Returns the employee tax statement with publication_status of draft; the associated employee document is removed.

post/employee_tax_statements/{id}/simulate/unpublish

Request

Path parameters

idstring required

ID of the employee tax statement

Response

200

idstring
employeestring
companystring
yearinteger
form'fed_w2' | 'fed_w2c' | 'vi_w2vi' | 'vi_w2vic'

Tax form type for this statement.

amendsunknown
amended_byunknown
documentunknown
filingsstring[]
filed_atunknown
published_atunknown
refreshed_atstring date-time

When the statement's data was last refreshed, in UTC.

publication_status'draft' | 'published' | 'pending_correction'
delivery_method'manual' | 'mail'
mail_recipientunknown

Example response

{
  "id": "ets_789",
  "employee": "emp_123",
  "company": "com_123",
  "year": 2025,
  "form": "fed_w2",
  "filings": [
    "com_fil_999"
  ],
  "refreshed_at": "2025-12-01T18:45:00Z",
  "publication_status": "draft",
  "delivery_method": "manual"
}

Changes