Get W-2 Preview Report

Returns a preview of W-2 data for all employees as of the current date for a specified year.

get/companies/{company}/reports/w2_preview

Request

Base URL
https://sandbox.checkhq.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/checkhq/apis/check-api/docs/companies/:company/reports/w2_preview/get.ts
A function with typed inputs. Its response is checked against the schema.

companystring required

Returns employee W-2 data for this company ID

yearstring

Returns employee W-2 data related to this year (defaults to current year).

include_idsboolean

Includes employee IDs in response. Applies to JSON responses only.

employeestring

Returns employee W-2 data for the specified employee ID. Applies to PDF responses only.

Acceptstring

application/json , text/csv , or application/pdf

200

object required