v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Payment Summary Report

Create a payment summary report.

post/reports/payment-summary

Request body

pay_start_datestring date required

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

pay_end_datestring date required

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

companyIDstring required

Zeal Company ID

media_type'csv' | 'pdf' required

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

include_intl_contractorsboolean

Include international contractors in this report

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "76f8a4e0-f2a0-4dc0-9a1c-215e083de5eb",
    "status": "pending",
    "request_body": {
      "start_date": "2022-01-01",
      "end_date": "2022-03-28",
      "company_id": "fc235f012bae46aa8a082f357715bcfa",
      "media_type": "pdf",
      "has_live_key": true,
      "report_format": "payment_summary"
    },
    "created_at": "2023-12-25T18:52:43.138Z"
  }
}