Create Payroll Journal Report

Create a payroll journal report.

Log in to see full request history

Creates a Payroll Journal Report for a date range, 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

attributetypedescription
successbooleanResponse status
dataobjectjob_id for Payroll Journal Report
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
date
required

The first check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).

date
required

The last check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).

string
required

Zeal Company ID

string
required

The type of format this report can be downloaded as. Payroll Journals currently support "csv" and "pdf".

boolean

Include migrated data in the report

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json