> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview Check Data

> Preview calculated pay, tax, and deduction data for a single employee check before it is created.



## OpenAPI

````yaml openapi/zeal-api.json post /preview/checkData
openapi: 3.1.0
info:
  title: zeal-api
  version: '1.0'
servers:
  - url: https://api.zeal.com
security:
  - sec0: []
paths:
  /preview/checkData:
    post:
      summary: Preview Check Data
      operationId: preview-check-data
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - companyID
                - employeeID
                - reportingPeriodID
                - check_date
                - shifts
              properties:
                companyID:
                  type: string
                  description: The ID of the Company
                employeeID:
                  type: string
                  description: The ID of the employee
                reportingPeriodID:
                  type: string
                  description: ID of the reporting period
                check_date:
                  type: string
                  description: Check date for this employee
                  format: date
                approval_required:
                  type: boolean
                  description: >-
                    Determine if approval is required for the check, defaults to
                    false
                  default: false
                metadata:
                  type: object
                  description: >-
                    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](ref:metadata)
                  properties: {}
                deductions:
                  type: object
                  description: >-
                    Adds a Deduction on the particular Employee Check, using a
                    Deduction Template, for a Company
                  required:
                    - deductionTemplateID
                  properties:
                    employer_contribution:
                      type: object
                      description: Employer contribution for the deduction
                      properties:
                        value:
                          type: number
                          description: Value of Employer contribution
                          format: float
                        contribution_type:
                          type: string
                          description: 'Type of contribution (Accepts: dollars, percentage)'
                    employee_contribution:
                      type: object
                      description: Employee contribution for the deduction
                      properties:
                        override_type:
                          type: string
                          description: >-
                            Override type (Accepts: final, overridable,
                            needs_input)
                        contribution_type:
                          type: string
                          description: 'Type of contribution (Accepts: dollars, percentage)'
                        value:
                          type: number
                          description: The Value of the employee contribution
                          format: float
                    deductionTemplateID:
                      type: string
                      description: ID of the deduction template
                shifts:
                  type: array
                  description: >-
                    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](ref:shift-object) for more information.
                  items:
                    properties:
                      time:
                        type: string
                        description: ISO-8601 indicating when the shift was completed
                        format: date-time
                      hourly:
                        type: object
                        required:
                          - hours
                        properties:
                          hours:
                            type: number
                            description: Number of regular hours worked in this shift
                            default: 0
                            format: float
                          wage:
                            type: number
                            description: >-
                              Wage for this employee. If not provided, Zeal uses
                              employee's default_wage
                            default: 0
                            format: float
                          custom_name:
                            type: string
                            description: Custom name to be attached to an earning component
                    required:
                      - time
                    type: object
                flsa_ot_recommendation:
                  type: boolean
                  default: false
            examples:
              Request Example:
                value:
                  companyID: 232414e556443cvc34558vv
                  employeeID: 3412eee0494585vvrt39485
                  reportingPeriodID: 5b3948753ere93484c
                  check_date: '2023-12-24'
                  shifts:
                    - time: '2023-11-15'
                      flat:
                        hours: 80
                        amount: 1125
                    - time: '2023-11-15'
                      flat:
                        hours: 80
                        amount: 375
                    - time: '2023-11-15'
                      flat:
                        hours: 80
                        amount: 500
                  deductions:
                    - deductionTemplateID: 5b35348948753ere93484c
                      employee_contribution:
                        value: 100
                        contribution_type: dollars
                      employer_contribution:
                        override_type: ''
                        value: 8
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    success: true
                    data:
                      success: true
                      result:
                        checks:
                          - gross_pay: '2000.00'
                            net_pay: '1452.98'
                            employer_taxes: '368.31'
                            employee_taxes: '447.02'
                            employee_deductions: '100.00'
                            employer_deductions: '8.00'
                            taxes:
                              - name: Federal Income Tax
                                codename: FIT
                                amount: '149.58'
                                paidBy: EMPLOYEE_WITHHOLDING
                              - name: Social Security
                                codename: FICA_SocialSecurity_EE
                                amount: '124.00'
                                paidBy: EMPLOYEE_WITHHOLDING
                              - name: Social Security
                                codename: FICA_SocialSecurity_ER
                                amount: '124.00'
                                paidBy: EMPLOYER_LIABILITY
                              - name: Medicare
                                codename: FICA_Medicare_EE
                                amount: '29.00'
                                paidBy: EMPLOYEE_WITHHOLDING
                              - name: Medicare
                                codename: FICA_Medicare_ER
                                amount: '29.00'
                                paidBy: EMPLOYER_LIABILITY
                              - name: Medicare Additional
                                codename: FICA_MedicareAdditional_EE
                                amount: '0.00'
                                paidBy: EMPLOYEE_WITHHOLDING
                              - name: Federal Unemployment Tax
                                codename: FUTA
                                amount: '12.00'
                                paidBy: EMPLOYER_LIABILITY
                              - name: State Unemployment Tax
                                codename: SUTA_NY
                                amount: '196.51'
                                paidBy: EMPLOYER_LIABILITY
                              - name: State Income Tax
                                codename: SIT_NY
                                amount: '80.69'
                                paidBy: EMPLOYEE_WITHHOLDING
                              - name: New York - New York City Income Tax
                                codename: LIT_NY_NYC
                                amount: '63.75'
                                paidBy: EMPLOYEE_WITHHOLDING
                              - name: >-
                                  New York - Metropolitan Commuter
                                  Transportation Mobility Tax
                                codename: FEE_NY_MCTMT
                                amount: '6.80'
                                paidBy: EMPLOYER_LIABILITY
                            deductions:
                              - deduction_type: 401k
                                employee_calculated_contribution: '100.00'
                                employer_calculated_contribution: '8.00'
                            accruals:
                              - policyID: 35b143b7c5b53634aa29655
                                policyType: sick_leave
                                policyCode: test-sick-leave-policy
                                policyName: Test Sick Leave Policy
                                accrued: 1.33
                                usage: 3
                                balance: 49.11
                        total_employer_taxes: '368.31'
                        total_employee_taxes: '447.02'
                        total_employee_deductions: '100.00'
                        total_employer_deductions: '8.00'
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                        default: true
                      result:
                        type: object
                        properties:
                          checks:
                            type: array
                            items:
                              type: object
                              properties:
                                gross_pay:
                                  type: string
                                  example: '2000.00'
                                net_pay:
                                  type: string
                                  example: '1452.98'
                                employer_taxes:
                                  type: string
                                  example: '368.31'
                                employee_taxes:
                                  type: string
                                  example: '447.02'
                                employee_deductions:
                                  type: string
                                  example: '100.00'
                                employer_deductions:
                                  type: string
                                  example: '8.00'
                                taxes:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: Federal Income Tax
                                      codename:
                                        type: string
                                        example: FIT
                                      amount:
                                        type: string
                                        example: '149.58'
                                      paidBy:
                                        type: string
                                        example: EMPLOYEE_WITHHOLDING
                                deductions:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      deduction_type:
                                        type: string
                                        example: 401k
                                      employee_calculated_contribution:
                                        type: string
                                        example: '100.00'
                                      employer_calculated_contribution:
                                        type: string
                                        example: '8.00'
                          total_employer_taxes:
                            type: string
                            example: '368.31'
                          total_employee_taxes:
                            type: string
                            example: '447.02'
                          total_employee_deductions:
                            type: string
                            example: '100.00'
                          total_employer_deductions:
                            type: string
                            example: '8.00'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value:
                    success: false
                    errors:
                      - message: Reporting Period with this ID does not exist
                        status: 400
                        code: 10
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                    default: true
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Reporting Period with this ID does not exist
                        status:
                          type: integer
                          example: 400
                          default: 0
                        code:
                          type: integer
                          example: 10
                          default: 0
      deprecated: false
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer

````