Payroll Periods

get

http://{{apiurl}}/api/v1/labor/payrollperiods

Payroll Periods

The Payroll Periods endpoint provides information about configured or active payroll cycles within the NX system.

Each record defines the start and end dates for a payroll period, along with metadata describing overtime rules, timezone context, and pay period settings.

Endpoint

GET /v1/labor/payrollperiods

Description

Retrieves a list of payroll period definitions for the current venue or license.

This data is used to align timecard and labor reporting with the correct pay cycle and overtime rules.

PayrollPeriod Object

Field	Type	Description
`id`	string	Unique identifier for the payroll period.
`updatedAt`	string (ISO 8601)	Timestamp of the last update to the payroll period record.
`payrollPeriodStartDateTime`	string (YYYY-MM-DD)	Start date of the payroll period.
`payrollPeriodEndDateTime`	string (YYYY-MM-DD)	End date of the payroll period.
`meta`	object	Contains metadata that defines overtime, timezone, and scheduling rules for this payroll period.

`meta` Object

Field	Type	Description
`laborSchedulingStartDayOfWeek`	string	The day of the week on which the labor scheduling cycle begins (e.g., `"SUNDAY"`).
`payPeriodStartAt`	string (YYYY-MM-DD)	The exact date when the pay period starts.
`overtimeWeekStartDayOfWeek`	string	The day of the week when overtime tracking resets (commonly `"SUNDAY"`).
`payPeriodEndAt`	string (YYYY-MM-DD)	The exact date when the pay period ends.
`timezone`	string	The venue’s configured timezone for payroll calculations.
`overtimeDailyDoubleHours`	number	Number of hours after which double-time pay applies per day (e.g., `12`).
`overtimeDailyHours`	number	Number of hours after which overtime pay applies per day (e.g., `8`).
`overtimeWeeklyHours`	number	Number of hours after which weekly overtime applies (e.g., `40`).

Example Response

{
  "records": [
    {
      "id": "5be7bc7a-b830-49a9-a84d-0b80ad45fa7c",
      "updatedAt": "2025-11-02T15:40:32.049Z",
      "payrollPeriodStartDateTime": "2025-10-22",
      "payrollPeriodEndDateTime": "2025-11-04",
      "meta": {
        "laborSchedulingStartDayOfWeek": "SUNDAY",
        "payPeriodStartAt": "2025-10-22",
        "overtimeWeekStartDayOfWeek": "SUNDAY",
        "payPeriodEndAt": "2025-11-04",
        "timezone": "US/Pacific",
        "overtimeDailyDoubleHours": 0,
        "overtimeDailyHours": 0,
        "overtimeWeeklyHours": 40
      }
    }
  ],
  "length": 1,
  "status": "SUCCESS",
  "count": 1,
  "duration": 0.218,
  "serverRequestTimestamp": "2025-11-02T16:00:00.000Z",
  "serverResponseTimestamp": "2025-11-02T16:00:00.218Z",
  "serverClientDrift": 0
}

Notes

A Payroll Period defines both the reporting boundaries for labor data and the configuration rules for overtime calculation.
The meta object values are determined by venue-level labor settings within NX.
Integrators can use overtimeWeeklyHours and related fields to calculate expected payroll and compliance costs.