---
title: "Preview Check Data"
method: POST
path: "/preview/checkData"
---

# Preview Check Data

`POST /preview/checkData`

## Request body

- object
  - `companyID` string, required — The ID of the Company
  - `employeeID` string, required — The ID of the employee
  - `reportingPeriodID` string, required — ID of the reporting period
  - `check_date` string, date, required — Check date for this employee
  - `approval_required` boolean — Determine if approval is required for the check, defaults to false
  - `metadata` object — Custom object you can attach to the employee check object. This is useful for storing additional information about the object in a custom, structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. [Metadata](https://docs.zeal.com/reference/metadata)
  - `deductions` object — Adds a Deduction on the particular Employee Check, using a Deduction Template, for a Company
    - `employer_contribution` object — Employer contribution for the deduction
      - `value` number, float — Value of Employer contribution
      - `contribution_type` string — Type of contribution (Accepts: dollars, percentage)
    - `employee_contribution` object — Employee contribution for the deduction
      - `override_type` string — Override type (Accepts: final, overridable, needs_input)
      - `contribution_type` string — Type of contribution (Accepts: dollars, percentage)
      - `value` number, float — The Value of the employee contribution
    - `deductionTemplateID` string, required — ID of the deduction template
  - `shifts` object[], required — Array of shift objects. The set of shifts attached to this employee check describe the work done and the earnings owed to this employee. You can only create shifts by creating an employee check (through this endpoint). However, you can edit and delete shifts that are still pending. Also supports various earning components as objects. See [Shift Object](https://docs.zeal.com/reference/shift-object) for more information.
    - `time` string, date-time, required — ISO-8601 indicating when the shift was completed
    - `hourly` object
      - `hours` number, float, required — Number of regular hours worked in this shift
      - `wage` number, float — Wage for this employee. If not provided, Zeal uses employee's default_wage
      - `custom_name` string — Custom name to be attached to an earning component
  - `flsa_ot_recommendation` boolean

## Response `200`

200

- object
  - `success` boolean
  - `data` object
    - `success` boolean
    - `result` object
      - `checks` object[]
        - `gross_pay` string
        - `net_pay` string
        - `employer_taxes` string
        - `employee_taxes` string
        - `employee_deductions` string
        - `employer_deductions` string
        - `taxes` object[]
          - `name` string
          - `codename` string
          - `amount` string
          - `paidBy` string
        - `deductions` object[]
          - `deduction_type` string
          - `employee_calculated_contribution` string
          - `employer_calculated_contribution` string
      - `total_employer_taxes` string
      - `total_employee_taxes` string
      - `total_employee_deductions` string
      - `total_employer_deductions` 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)