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

# Create Custom Payroll Journal Report

`POST /reports/custom-payroll-journal`

Create a custom payroll journal report.

## Request body

- object
  - `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".
  - `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).
  - `fields` object — Optional fields and parameters for Custom Payroll Journal
    - `employee_taxes` boolean — Boolean to include employee taxes in the Custom Payroll Journal report
    - `employer_taxes` boolean — Boolean to include employer taxes in the Custom Payroll Journal report
    - `deductions` boolean — Boolean to include deductions in the Custom Payroll Journal report
    - `net_pay` boolean — Boolean to include employee's net pay
    - `earnings` boolean — Boolean to include employee's earnings
    - `disbursement` boolean — Boolean to include disbursement
    - `gross_pay` boolean — Boolean to include employee's gross pay
    - `employer_check_id` boolean — Boolean to include employer check ID
  - `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
      - `start_date` string
      - `end_date` string
      - `companyID` string
      - `media_type` string
      - `fields` object
        - `employee_taxes` boolean
        - `employer_taxes` boolean
        - `deductions` boolean
        - `net_pay` boolean
        - `earnings` boolean
        - `disbursement` boolean
        - `gross_pay` 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)