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

# initiatePayroll

> 
Starts payroll calculation and processing for a specific pay period.

### Pre-Execution Checklist
✅ Deductions/bonuses added  
✅ Bank account verified  
✅ Tax settings current  
✅ Employee information updated  

### Process Flow
1. **Validation:** Checks all requirements
2. **Calculation:** Computes wages, taxes, deductions
3. **Review:** Generates preview for approval
4. **Processing:** Executes payments
5. **Confirmation:** Sends notifications

### Response Status Values
- **"Success"** - The payPeriod has been initiated successfully.
- **"Failed"** - Failed to process the PayPeriod.



## OpenAPI

````yaml post /payroll#initiatePayroll
openapi: 3.0.1
info:
  title: Default module
  description: ''
  version: 1.0.0
servers: []
security:
  - basic: []
tags: []
paths:
  /payroll#initiatePayroll:
    post:
      tags: []
      summary: initiatePayroll
      description: |-

        Starts payroll calculation and processing for a specific pay period.

        ### Pre-Execution Checklist
        ✅ Deductions/bonuses added  
        ✅ Bank account verified  
        ✅ Tax settings current  
        ✅ Employee information updated  

        ### Process Flow
        1. **Validation:** Checks all requirements
        2. **Calculation:** Computes wages, taxes, deductions
        3. **Review:** Generates preview for approval
        4. **Processing:** Executes payments
        5. **Confirmation:** Sends notifications

        ### Response Status Values
        - **"Success"** - The payPeriod has been initiated successfully.
        - **"Failed"** - Failed to process the PayPeriod.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                companyId:
                  type: string
                  format: uuid
                payPeriodId:
                  type: string
                  format: uuid
              required:
                - method
                - companyId
                - payPeriodId
            example:
              method: initiatePayroll
              companyId: 8D728FCE-2993-42E0-8797-832C930506E1
              payPeriodId: F4C96CCA-24D4-4DF4-B624-1544989F7D21
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payPeriod:
                    type: object
                    properties:
                      payPeriodId:
                        type: string
                      status:
                        type: string
                      message:
                        type: string
                    required:
                      - payPeriodId
                      - status
                    x--orders:
                      - PayPeriodId
                      - Status
                      - Message
                required:
                  - payPeriod
                x--orders:
                  - PayPeriod
              example:
                payPeriod:
                  payPeriodId: 3b51b98b-2915-4854-b87c-f7952ef086ec
                  status: New
                  message: The PayPeriod has been initiated successfully.
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                      required:
                        - code
                required:
                  - error
              example:
                error:
                  code: 400
                  message: payPeriodId is mandatory and cannot be empty.
          headers: {}
      deprecated: false
      security:
        - basic: []
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic

````