Skip to main content
POST
Create Payment Summary Report

Authorizations

Authorization
string
header
required

Body

application/json
pay_start_date
string<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
string<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
enum<string>
required

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

Available options:
csv,
pdf
include_intl_contractors
boolean

Include international contractors in this report

Response

200

success
boolean
default:true
Example:

true

data
object