Create Cash Requirements Report

Create a cash requirements report

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

attributetypedescription
successbooleanResponse status
dataobjectjob_id for Cash Requirements Report
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

Zeal Company ID

date
required

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

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)

customer_account_ids
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json