Create Custom Payroll Journal Report

post https://api.zeal.com/reports/custom-payroll-journal

Create a custom payroll journal report.

Creates a Customized Payroll Journal Report with different fields, 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

attribute	type	description
success	boolean	Response status
data	object	`job_id` for Custom Payroll Journal Report
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.zeal.com/reports/custom-payroll-journal \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"media_type":"csv"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Returns

200200

400400