---
title: "Company Pay Period"
method: GET
path: "/companies/{companyId}/payperiods/{payperiodId}"
tags: ["Payroll"]
---

# Company Pay Period

`GET /companies/{companyId}/payperiods/{payperiodId}`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/companies/{companyId}/payperiods/{payperiodId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/payperiods/:payperiodId/get.ts> (a function with typed inputs; its response is checked against the schema)

A single pay period.

## Path parameters

- `companyId` string, required
- `payperiodId` string, required

## Response `200`

Pay Period successfully returned for given payPeriodId.

- object
  - `content` PayPeriodResource: The representational state of pay periods.
    - `payPeriodId` string: The unique identifier used to identify a pay period.
    - `intervalCode` 'ANNUAL' | 'BI_WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'SEMI_MONTHLY' | 'WEEKLY': Frequency of the payroll period.
    - `status` 'COMPLETED' | 'COMPLETED_BY_MEC' | 'ENTRY' | 'INITIAL' | 'PROCESSING' | 'REISSUED' | 'RELEASED' | 'REVERSED': The current state of the associated pay period.
    - `description` string: The description of the Pay Period.
    - `startDate` string, date-time: The start date associated with this pay period.
    - `endDate` string, date-time: The end date associated with this pay period.
    - `submitByDate` string, date-time: The date by which information for the pay run must be submitted in order to be guaranteed the information is included.
    - `checkDate` string, date-time: The date on which the checks associated with this pay period can be cashed.
    - `checkCount` integer: Number of checks that are included within the pay period.
    - `originalPayPeriodID` string: If the payperiod was created from a reversed payperiod then this is a unique identifier for the original payperiod.
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)