Create Payment Summary Report

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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 Payment Summary Report
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

pay_start_date

date

required

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

pay_end_date

date

required

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

companyID

string

required

Zeal Company ID

media_type

string

enum

required

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

csvpdf

Allowed:

csv``pdf

include_intl_contractors

boolean

Include international contractors in this report

truefalse

`200 200`

`400 400`

Updated 7 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request POST \

--url https://api.zeal.com/reports/payment-summary \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '{"media_type":"csv"}'

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

application/json

200 - Result400 - Result

Updated 7 months ago