API Reference

Create Payment Summary Report

post
https://api.zeal.com/reports/payment-summary

Create a payment summary report.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 Payment Summary 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 payment date this report should retrieve payments for. Date should be in ISO-8601 format (YYYY-MM-DD).

date
required

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

string
required

Zeal Company ID

string
enum
required

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

Allowed:
boolean

Include international contractors in this report

Responses

Updated 6 months ago

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

Updated 6 months ago