v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Cash Requirements Report

Create a cash requirements report

post/reports/cash-requirements

Request body

companyIDstring required

Zeal Company ID

check_datestring date required

Check date this report is requested for. Date should be in ISO-8601 format (YYYY-MM-DD).

media_typestring required

The type of format this report can be downloaded as. Cash Requirement reports currently only support "pdf".

customer_account_idsstring[]

Filter by customer account(s) (Early Access)

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "cd4bbf73-e141-42bd-a331-5845c994ebe1",
    "status": "pending",
    "request_body": {
      "company_id": "fc235f012bae46aa8a082f357715bcfa",
      "check_date": "2022-01-22",
      "media_type": "pdf",
      "has_live_key": true,
      "report_format": "cash_requirements"
    },
    "created_at": "2023-12-25T16:48:36.802Z"
  }
}