post https://api.zeal.com/reports/ytd
Create a year-to-date report.
Creates a Year-to-date report for specified employees returning gross pay, net pay, taxes, total employer taxes, total employee taxes, deductions for each 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 Year to Date report |
errors | array | Contains a list of error objects which consists of:message : Error messagecode : Error code as described in Error codes |