Create Worker Summary Report

Create a worker summary report.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a Worker Summary Report containing either employees or contractors, which can be downloaded as a CSV or PDF. Payroll information will only be taken into account for reports from checks that are in a processed state.

This endpoint will return a job_id instead of the raw data itself. As the data returned from this endpoint can be large, we utilize a job queue to process this data instead of an immediate synchronous response. Once the job status is marked as complete, the report can be downloaded using the Download Report endpoint.

Returns

attributetypedescription
successbooleanResponse status
dataobjectjob_id for Worker Summary Report
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

Zeal Company ID

string
enum
required

Type of worker this report can be downloaded for. Accepted values are "employee" and "contractor".

Allowed:
string
enum
required

The type of format this report can be downloaded as. Worker Summary Report currently support "csv" and "pdf".

Allowed:
boolean

Determine whether the worker summary report returns terminated workers

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json