> ## 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.

# deactivatePaySchedule

> The `deactivatePaySchedule` API Deactivates an existing pay schedule (cannot be undone).

### When to Use
- Changing pay frequency
- Company restructuring  
- Ending contractor arrangements

### Prerequisites
- All pending payrolls must be processed
- Cannot deactivate if active pay periods exist

### Warning
⚠️ This action is permanent. Create new pay schedule if needed.



## OpenAPI

````yaml post /payroll/deactivatePaySchedule
openapi: 3.0.1
info:
  title: Default module
  description: ''
  version: 1.0.0
servers: []
security:
  - basic: []
tags: []
paths:
  /payroll/deactivatePaySchedule:
    post:
      tags: []
      summary: deactivatePaySchedule
      description: >-
        The `deactivatePaySchedule` API Deactivates an existing pay schedule
        (cannot be undone).


        ### When to Use

        - Changing pay frequency

        - Company restructuring  

        - Ending contractor arrangements


        ### Prerequisites

        - All pending payrolls must be processed

        - Cannot deactivate if active pay periods exist


        ### Warning

        ⚠️ This action is permanent. Create new pay schedule if needed.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                paySchedule:
                  type: object
                  properties:
                    payScheduleId:
                      type: string
                      format: uuid
                  required:
                    - payScheduleId
              required:
                - method
                - paySchedule
            example:
              method: deactivatePaySchedule
              payScheduleId: 141D6357-CB56-42C9-951D-E80E10C5853A
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  PaySchedule:
                    type: object
                    properties:
                      PayScheduleID:
                        type: string
                      Status:
                        type: string
                      Message:
                        type: string
                    required:
                      - PayScheduleID
                required:
                  - PaySchedule
              examples:
                '1':
                  summary: Success
                  value:
                    PaySchedule:
                      PayScheduleID: 1F67BE13-4E3E-4578-AC25-5660DFDE9E39
                      Status: InActive
                      Message: The PaySchedule has been deactivated successfully.
                '2':
                  summary: Exception
                  value:
                    error:
                      code: 400
                      message: PayScheduleId is mandatory
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
                required:
                  - error
          headers: {}
      deprecated: false
      security:
        - basic: []
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic

````