---
title: "Pay Period Options"
method: GET
path: "/v3/payroll/option-items/payroll-periods"
tags: ["Payroll"]
---

# Pay Period Options

`GET /v3/payroll/option-items/payroll-periods`

## Request

- Base URL: `https://api.avionte.com/bo-prod`
- URL: `https://api.avionte.com/bo-prod/v3/payroll/option-items/payroll-periods`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns a predefined list of payroll period values supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.

## Headers

- `FrontOfficeTenantId` integer, required
- `RequestOrigin` string, required
- `RequestId` string, uuid, required: The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.
- `RequestUserExternalId` string

## Response `200`

A predefined list of payroll period values with the valid billing cycles.

- PayrollPeriodOption[]
  - `payrollPeriodId` integer: The unique identifier for the payroll period option.
  - `payrollPeriodName` 'Unknown' | 'Weekly' | 'BiWeekly' | 'Monthly' | 'SemiMonthly' | 'Daily' | 'Yearly' | 'Hourly'
  - `validPayrollCycles` string[]: The list of payroll cycles that are valid for the selected payroll period option.

## Other responses

- `402`: Additional subscription required.
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api.md) - [All operations](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api/revisions/13269bc541c9?raw)