CHcheckhq

List employee tax documents

Changed on

Returns a list of employee tax documents. Each document includes created_at, an ISO 8601 UTC timestamp of when the document was recorded. When multiple documents share the same filed_on date, compare created_at to tell which was recorded later.

get/documents/employee_tax_documents

Request

Query parameters

employeestring

Return tax documents for this employee ID

companystring

Return tax documents for this company ID

yearinteger

List documents for this year (must be greater than or equal to 2019)

document_typestring[]

Return documents with this document type. Repeat the parameter to match any of multiple values (for example, ?document_type=fed_w4&document_type=fed_w2).

limitinteger

Number of tax documents returned per page. The maximum value is 500.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

nextstring nullable

URL of the next page of results; null on the last page.

previousstring nullable

URL of the previous page of results; null on the first page.

Example response

{
  "next": "https://api.checkhq.com/documents/employee_tax_documents?cursor=cD0lNUIlMjIyMDI0LTA1LTA5KzIzJTNBNTIlM0ExOC42NzY3NzUlMkIwMCUzQTAwJTIyJTJDKyUyMjQwMzA5OCUyMiU1RA%3D%3D",
  "results": [
    {
      "id": "doc_hQhfyxTf2aMXDfQ82Dly",
      "employee": "emp_blSYc67D0Q4qk6lx15qR",
      "category": "employee_tax_document",
      "document_type": "ca_de4",
      "label": "California DE-4",
      "jurisdiction": "CA",
      "year": 2024,
      "filed_on": "2024-07-18",
      "created_at": "2024-07-18T23:52:18.676775Z"
    }
  ]
}

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter document_type

    • info

      added the new optional query request parameter id