See the Employee Tax Statements and Tax Packages guide for more details on how to use this API
The TaxPackage Object
Fields non-nullable unless specified.
| field | type | description |
|---|---|---|
id | ID | ID of the TaxPackage |
company | ID | ID of the Company |
status | generating, succeeded, failed | Enum of possible status options to represent the asynchronous generation of a tax package |
contents | {"employee_tax_statements": ["ets_123", "ets_456"]} | Object containing the requested tax packages |
created_at | nullable datetime in UTC | ISO8601 datetime when all related filings became successfully filed. |
succeeded_at | nullable datetime in UTC | ISO8601 datetime when all related filings became successfully filed. |
result | nullable {"url": downloadable_url} | Object containing the URL at which to download the PDF file. |
error | nullable {"type": "content_not_found", "message": "Human readable error message"} | Object containing types of errors and human readable error messages |
When generating:
{
"id": "tax_pkg_1MrQwrLkdIwHu7ixUov4x2b3",
"company": "com_myKIvCGb7M86G2CQbYe5",
"status": "generating",
"contents": {
"employee_tax_statements": ["ets_123", "ets_456"],
},
"created_at": "2024-11-03T19:52:15Z",
"succeeded_at": null,
"result": null,
"error": null
}
When generation succeeds:
{
"id": "tax_pkg_1MrQwrLkdIwHu7ixUov4x2b3",
"company": "com_myKIvCGb7M86G2CQbYe5",
"status": "succeeded",
"contents": {
"employee_tax_statements": ["ets_123", "ets_456"]
},
"created_at": "2024-11-03T19:52:15Z",
"succeeded_at": "2024-11-03T19:55:11Z",
"result": {
"url": "https://api.checkhq.com/tax_packages/tax_pkg_1MrQwrLkdIwHu7ixUov4x2b3/download",
"expires_at": "2024-11-03T20:55:11Z"
},
"error": null
}
When generation fails:
{
"id": "tax_pkg_1MrQwrLkdIwHu7ixUov4x2b3",
"company": "com_myKIvCGb7M86G2CQbYe5",
"status": "failed",
"contents": {
"employee_tax_statements": ["ets_123", "ets_456"]
},
"created_at": "2024-11-03T19:52:15Z",
"succeeded_at": null,
"result": null,
"error": {
"type": "generation_timeout",
"message": "Generation took longer than one hour to generate. Create a new package with fewer contents."
}
}