URL Expired

The URL for this request expired after 30 days.

Preview an employee check and its corresponding data including a breakdown of taxes and deductions withheld. In addition to the companyID and employeeID, Zeal requires a reportingPeriodID that describes the reporting period that this check belongs to.

See here for more information about Reporting Periods.

Creating a check also requires a Shift Object that takes in an array of various earning components such as hourly shift data, overtime, reimbursement, or various other supported earning components.

Returns

Returns response status and a JSON breakdown of total as well as individual calculated employer & employee taxes, net/gross pay, and deductions for a specific check.

Parameters

• 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
  date
  required
  Check date for this employee

• approval_required
  boolean
  Defaults to false
  Determine if approval is required for the check, defaults to false

• deductions
  object
  Adds a Deduction on the particular Employee Check, using a Deduction Template, for a Company

• shifts
  array of objects
  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 for more information.

• flsa_ot_recommendation
  boolean
  Defaults to false

Example Request

curl --request POST \

--url https://api.zeal.com/preview/checkData \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '\n{\n  "approval_required": false,\n  "flsa_ot_recommendation": false\n}\n'

Response Codes