CHcheckhq

Request a tax package

Changed on
post/tax_packages

Request

Request body

companystring

ID of the company

contentsstring json

JSON object of employee_tax_statements, contractor_tax_statements, and filings IDs to include. Every list is optional. contractor_tax_statements applies only when contractor tax statements are enabled for your account; otherwise it is ignored.

statement_csv_format'standard' | 'with_ids'

Layout of the statement CSV files included in the package ZIP. standard omits a statement ID column; with_ids adds a leading Statement ID column on each employee and contractor statement CSV.

Response

201

idstring
companystring
statusstring
resultunknown
succeeded_atunknown
errorunknown
created_atstring

Example response

{
  "id": "tax_pkg_abc123",
  "company": "com_789",
  "status": "generating",
  "contents": {
    "employee_tax_statements": [
      "ets_123"
    ],
    "contractor_tax_statements": [
      "cts_123"
    ],
    "filings": [
      "com_fil_999"
    ]
  },
  "created_at": "2024-01-15T12:00:00Z"
}

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status