---
title: "Preview a payroll"
method: GET
path: "/payrolls/{payroll}/preview"
---

# Preview a payroll

`GET /payrolls/{payroll}/preview`

Returns a preview of an approved version of the input payroll

## Path parameters

- `payroll` string, required

## Query parameters

- `async` boolean
- `include_items` boolean
- `include_contractor_payments` boolean

## Headers

- `Accept` string

## Response `200`

200

- object
  - `id` string
  - `company` string
  - `period_start` string
  - `period_end` string
  - `approval_deadline` string
  - `approved_at` string
  - `payday` string
  - `status` string
  - `type` string
  - `pay_frequency` string
  - `funding_payment_method` string
  - `processing_period` string
  - `off_cycle_options` unknown
  - `managed` boolean
  - `totals` object
    - `employee_gross` string
    - `employee_reimbursements` string
    - `employee_taxes` string
    - `employee_benefits` string
    - `post_tax_deductions` string
    - `employee_net` string
    - `contractor_gross` string
    - `contractor_reimbursements` string
    - `contractor_net` string
    - `company_taxes` string
    - `company_benefits` string
    - `liability` string
    - `cash_requirement` string
  - `items` object[]
    - `id` string
    - `payroll` string
    - `employee` string
    - `payment_method` string
    - `net_pay` string
    - `earnings` object[]
      - `amount` string
      - `hours` integer
      - `type` string
      - `workplace` string
      - `code` unknown
      - `description` unknown
    - `reimbursements` unknown[]
      - unknown
    - `taxes` object[]
      - `tax` string
      - `description` string
      - `amount` string
      - `payer` string
    - `benefits` unknown[]
      - unknown
    - `benefit_overrides` unknown[]
      - unknown
    - `post_tax_deductions` unknown[]
      - unknown
    - `post_tax_deduction_overrides` unknown[]
      - unknown
    - `tax_overrides` unknown[]
      - unknown
    - `warnings` unknown[]
      - unknown
  - `contractor_payments` object[]
    - `contractor` string
    - `payment_method` string
    - `amount` string
    - `reimbursement_amount` string
  - `is_void` boolean
  - `metadata` object

---

[API](https://skmtc.net/checkhq/apis/check-api.md) · [All operations](https://skmtc.net/checkhq/apis/check-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/checkhq/check-api/versions/f46e28134549/schema)