Create Cash Requirements Report

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Creates a Cash Requirements Report, which can be downloaded as a PDF. Payroll information will only be taken into account for reports from checks that are in a processed state.

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

attribute	type	description
success	boolean	Response status
data	object	`job_id` for Cash Requirements Report
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

Parameters

Parameter	Type	Description
companyID	string	required - Zeal Company ID
check_date	date	required - Check date this report is requested for. Date should be in ISO-8601 format (YYYY-MM-DD).
media_type	string	required - Defaults to pdf, the type of format this report can be downloaded as. Cash Requirement reports currently only support "pdf".
customer_account_ids	array of strings	Filter by customer account(s) (Early Access)

HTTP Status Codes

``200 200

``400 400

Example API Request

curl --request POST \
     --url https://api.zeal.com/reports/cash-requirements \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"media_type":"pdf"}'

Response Example

{
  "success": true,
  "data": {
    "job_id": "XXXXXXXXXX"
  },
  "errors": []
}