Create Paystub Report

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Creates a Paystub report spanning a start and end date for a specified company. 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 Skip link to Returns

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

companyID

string

required

ID of the Company

start_date

date

required

Start date of the dates that span the Paystub Report. Date should be in ISO-8601 format (YYYY-MM-DD).

end_date

date

required

End date of the dates that span the Paystub Report (will default to today's date if left blank). Date should be in ISO-8601 format (YYYY-MM-DD).

media_type

string

required

Defaults to pdf

The media type of the report, only PDF is supported

``200 200

``400 400

Updated 7 months ago

ShellNodeRubyPHPPython


xxxxxxxxxx

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

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

application/json

200 - Result400 - Result

Updated7 months ago