post https://api.zeal.com/reports/deductions-summary
Create a summary report outlining deductions within a given timeframe
Generates a report summarizing deductions within a given start and end date period.
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 Deductions Summary Report |
errors | array | Contains a list of error objects which consists of:message : Error messagecode : Error code as described in Error codes |