Create Deduction Summary Report

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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 message `code`: Error code as described in Error codes

Parameters

companyID
string
required
ID of the company.
media_type
string
required
Defaults to csv
The type of format this report can be downloaded as. Deduction Summary currently only supports "csv".
start_date
date
required
The start check date this report should retrieve deductions for. Date should be in ISO-8601 format (YYYY-MM-DD).
end_date
date
required
The end check date this report should retrieve deductions for. Date should be in ISO-8601 format (YYYY-MM-DD).
customer_account_ids
array of strings
Filter by customer account(s) (Early Access)

Example Request

curl --request POST \
     --url https://api.zeal.com/reports/deductions-summary \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"media_type":"csv"}'

Example Responses

200
Result
400
Result