Create Worker Summary Report

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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 Skip link to Returns

attribute	type	description
success	boolean	Response status
data	object	`job_id` for Worker Summary Report
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

companyID

string

required

Zeal Company ID

worker_type

string

enum

required

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

employeecontractor

Allowed:

employee``contractor

media_type

string

enum

required

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

csvpdf

Allowed:

csv``pdf

active_workers

boolean

Determine whether the worker summary report returns terminated workers

truetruefalse

``200 200

``400 400

Updated 7 months ago

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request POST \

--url https://api.zeal.com/reports/worker-summary \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '

{

"worker_type": "employee",

"media_type": "csv"

}

'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated7 months ago