---
title: "Create Cash Requirements Report"
method: POST
path: "/reports/cash-requirements"
---

# Create Cash Requirements Report

`POST /reports/cash-requirements`

## Request

- Base URL: `https://api.zeal.com`
- URL: `https://api.zeal.com/reports/cash-requirements`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/zeal/apis/zeal-api/docs/reports/cash-requirements/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a cash requirements report

## Request body

- object
  - `companyID` string, required: Zeal Company ID
  - `check_date` string, date, required: Check date this report is requested for. Date should be in ISO-8601 format (YYYY-MM-DD).
  - `media_type` string, required: The type of format this report can be downloaded as. Cash Requirement reports currently only support "pdf".
  - `customer_account_ids` string[]: Filter by customer account(s) (Early Access)

## Response `200`

200

- object
  - `success` boolean
  - `data` object
    - `job_id` string
    - `status` string
    - `request_body` object
      - `company_id` string
      - `check_date` string
      - `media_type` string
      - `has_live_key` boolean
      - `report_format` string
    - `created_at` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/zeal/apis/zeal-api.md) - [All operations](https://skmtc.dev/zeal/apis/zeal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeal/apis/zeal-api/revisions/01346dceb27d?raw)