v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Custom Payroll Journal Report

Create a custom payroll journal report.

post/reports/custom-payroll-journal

Request body

companyIDstring required

Zeal Company ID

media_type'csv' | 'pdf' required

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

start_datestring date required

The first check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).

end_datestring date required

The last check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).

customer_account_idsstring[]

Filter by customer account(s) (Early Access)

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "7282b13f-254f-4eb9-bt88-24f429be6aa0",
    "status": "pending",
    "request_body": {
      "start_date": "03-22-2022",
      "end_date": "04-10-2022",
      "companyID": "24b5b29f07924840b119c34c1358940c",
      "media_type": "pdf",
      "has_live_key": true,
      "report_format": "custom_payroll_journal"
    },
    "created_at": "2023-12-18T22:15:08.977Z"
  }
}