Reporting Period Object

A Reporting Period represents a date range that corresponds to a single pay cycle for a company. Every employee check you create must reference a reportingPeriodID, which tells Zeal which pay cycle the payment belongs to. Zeal generates reporting periods automatically based on the company’s configured pay schedule, so you typically look them up rather than create them. You can fetch the full list of reporting periods for a company, look up a specific period by its reportingPeriodID, or retrieve the upcoming regular payroll period and check date in a single call.

Reporting Period Schema

string

The unique identifier for this reporting period. Pass this value as reportingPeriodID when creating an employee check.

string

The pay schedule associated with this period (e.g., weekly, biweekly, semimonthly, monthly).

string

The first day of the pay period in YYYY-MM-DD format.

string

The last day of the pay period in YYYY-MM-DD format.

See Get Reporting Period by ID, Get All Reporting Periods, and Get Upcoming Regular Payroll for the full request/response detail on each field.

Using `reportingPeriodID` in Employee Checks

Once you have a reportingPeriodID, include it as a required field when calling POST /employeeCheck to create a new employee check. The reporting period anchors the check to the correct pay cycle so Zeal can apply the right tax tables, deadlines, and filing periods.

{
  "companyID": "{companyID}",
  "employeeID": "{employeeID}",
  "reportingPeriodID": "5eb317a40d1158d5ddcb6895",
  "check_date": "2024-02-19",
  "shifts": [
    {
      "time": "2024-02-01T09:00:00Z",
      "hourly": {
        "hours": 80
      }
    }
  ]
}

Introduction

Webhooks

Zeal Components

Companies

Company Onboarding

Reserve Accounts

Customer Accounts (Early Access)

Taxable Locations

Work Locations

Employees

Employee Deduction Templates

Employee Onboarding

Bank Accounts

Custom Attributes

Paperwork API

Employee Checks

Contractors

Contractor Onboarding

Contractor Payment Deductions

Payment Items

Contractor Payments

Paycards

Instant Pay

Employer Checks

Preview

Embedded HR

Reports

Documents

Reporting Period Object

Reporting Period Schema

Using `reportingPeriodID` in Employee Checks

​Reporting Period Schema

​Using reportingPeriodID in Employee Checks

Reporting Period Schema

Using `reportingPeriodID` in Employee Checks