> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rollfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# getPayPeriod

> 
The `getPayPeriod` API retrieves pay period information for a company based on worker type.

### What it does:

- Returns pay period details including dates, deadlines, and payroll amounts

### Notes:

- Requires `companyId` and `workerType` (W2 or 1099) parameters
- Used before initiating payroll processing with `initiatePayroll`



## OpenAPI

````yaml get /reports/getPayPeriod
openapi: 3.0.1
info:
  title: Default module
  description: ''
  version: 1.0.0
servers: []
security:
  - basic: []
tags: []
paths:
  /reports/getPayPeriod:
    get:
      tags: []
      summary: getPayPeriod
      description: >-

        The `getPayPeriod` API retrieves pay period information for a company
        based on worker type.


        ### What it does:


        - Returns pay period details including dates, deadlines, and payroll
        amounts


        ### Notes:


        - Requires `companyId` and `workerType` (W2 or 1099) parameters

        - Used before initiating payroll processing with `initiatePayroll`
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                companyId:
                  type: string
                  format: uuid
                workerType:
                  type: string
                  enum:
                    - W2
                    - 1099-NEC
              required:
                - method
                - companyId
                - workerType
            example:
              method: getPayPeriod
              companyId: C2019899-9EEF-49F7-9B51-70744AFAFE61
              workerType: W2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payPeriodId:
                    type: string
                  payPeriod:
                    type: string
                  payBeginDate:
                    type: string
                  payEndDate:
                    type: string
                  payDate:
                    type: string
                  deadLineToRunPayroll:
                    type: string
                  payPeriodStatus:
                    type: string
                    enum:
                      - new
                      - submitted
                      - cancelled
                      - inProcess
                      - processed
                      - failed
                      - returned
                      - skipped
                  payrollAmount:
                    type: number
                required:
                  - payPeriodId
                  - payPeriod
                  - payBeginDate
                  - payEndDate
                  - payDate
                  - deadLineToRunPayroll
                  - payPeriodStatus
                  - payrollAmount
              example:
                payPeriodId: 9BF440AF-9BE8-49B7-8F5E-0673E35CB5B3
                payPeriod: 10/01/2025 - 10/31/2025
                payBeginDate: '2025-10-01'
                payEndDate: '2025-10-31'
                payDate: '2025-10-31'
                deadLineToRunPayroll: '2025-10-29'
                payPeriodStatus: submitted
                payrollAmount: 2763663.09
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
              example:
                error:
                  code: 400
                  message: Invalid WorkerType
          headers: {}
      deprecated: false
      security:
        - basic: []
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic

````