post https://api.zeal.com/reports/worker-summary
Create a worker summary report.
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
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 messagecode : Error code as described in Error codes |