Create Quarter to Date Report
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Creates a Quarter to Date report for specified employees returning gross pay, net pay, taxes, total employer taxes, total employee taxes, deductions for each individual check associated with the employees as well as a summary of totals for all of the above parameters for all employee checks. 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 Quarter to Date report |
| errors | array | Contains a list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
companyID
string
required
The ID of the company
employeeID
array of strings
Array of employee IDs to grab QTD data for
employeeID ADD string
quarter
string
required
The quarter to grab QTD data for (options are q1, q2, q3, and q4)
media_type
string
required
Defaults to json
The media_type of the report, currently only supporting json
``200 200
``400 400
curl --request POST
--url https://api.zeal.com/reports/qtd
--header 'accept: application/json'
--header 'content-type: application/json'
--data '
{
"media_type": "json"
}
'