---
title: "Create Payroll Journal Report"
method: POST
path: "/reports/payroll-journal"
---

# Create Payroll Journal Report

`POST /reports/payroll-journal`

Create a payroll journal report.

## Request body

- object
  - `start_date` string, date, required — The first check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).
  - `end_date` string, date, required — The last check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).
  - `companyID` string, 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".
  - `include_migrated` boolean — Include migrated data in the report
  - `with_preview_data` boolean — Include preview data in the report (if `media_type` = `csv` only)

## Response `200`

200

- object
  - `success` boolean
  - `data` object
    - `job_id` string
    - `status` string
    - `request_body` object
      - `start_date` string
      - `end_date` string
      - `company_id` string
      - `media_type` string
      - `include_migrated` boolean
      - `has_live_key` boolean
      - `report_format` string
    - `created_at` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zeal/apis/zeal-api.md) · [All operations](https://skmtc.net/zeal/apis/zeal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeal/zeal-api/revisions/01346dceb27d/schema)