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

# getPayrollHistoryBasedOnDateRange

> 
The `getPayrollHistoryBasedOnDateRange` API retrieves payroll history for all pay periods within a specified date range.

### What it does:

- Returns pay period details and payroll line items for all employees within the specified date range
- Provides comprehensive payroll data including wages, taxes, deductions, and net pay across multiple pay periods
- Requests can encompass multiple pay periods and partial pay periods - start dates and end dates for requests are not limited



## OpenAPI

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

        The `getPayrollHistoryBasedOnDateRange` API retrieves payroll history
        for all pay periods within a specified date range.


        ### What it does:


        - Returns pay period details and payroll line items for all employees
        within the specified date range

        - Provides comprehensive payroll data including wages, taxes,
        deductions, and net pay across multiple pay periods

        - Requests can encompass multiple pay periods and partial pay periods -
        start dates and end dates for requests are not limited
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                  title: getPayrollHistoryBasedOnDateRange
                  example: getPayrollHistoryBasedOnDateRange
                companyId:
                  type: string
                  format: uuid
                startDate:
                  type: string
                  maxLength: 10
                endDate:
                  type: string
                  maxLength: 10
              required:
                - method
                - companyId
                - startDate
                - endDate
            example:
              method: getPayrollHistoryBasedOnDateRange
              companyId: 32cef965-3a70-4ee0-b943-ad2fb876a839
              startDate: '2023-01-01'
              endDate: '2023-12-31'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payPeriod:
                    type: array
                    items:
                      type: object
                      properties:
                        payPeriodId:
                          type: string
                        payPeriod:
                          type: string
                        deadLineToRunPayroll:
                          type: string
                        total:
                          type: integer
                        employeeTaxSum:
                          type: number
                        employerTaxSum:
                          type: number
                        isProcessed:
                          type: boolean
                        payDate:
                          type: string
                        payEndDate:
                          type: string
                        payBeginDate:
                          type: string
                        workerType:
                          type: object
                          properties:
                            workerType:
                              type: string
                          required:
                            - workerType
                        payrollLineItems:
                          type: array
                          items:
                            type: object
                            properties:
                              userId:
                                type: string
                                format: uuid
                              baseTotal:
                                type: integer
                              numberOfLeaveDays:
                                type: integer
                              lop:
                                type: integer
                              retroAmount:
                                type: integer
                              grossTotal:
                                type: integer
                              netTotal:
                                type: number
                              userName:
                                type: object
                                properties:
                                  employee:
                                    type: string
                                required:
                                  - employee
                              employeeTax:
                                type: object
                                properties:
                                  employeeTax:
                                    type: number
                                required:
                                  - employeeTax
                              Deductions:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    vertexDeductionIdentifier:
                                      type: object
                                      properties:
                                        deductionDescription:
                                          type: string
                                      required:
                                        - deductionDescription
                                    amount:
                                      type: integer
                                  required:
                                    - vertexDeductionIdentifier
                                    - amount
                              payDetails:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    payPercentage:
                                      type: integer
                                    amount:
                                      type: integer
                                    employeePayAccount:
                                      type: object
                                      properties:
                                        accountName:
                                          type: string
                                          nullable: true
                                      required:
                                        - accountName
                                  required:
                                    - payPercentage
                                    - amount
                                    - employeePayAccount
                              OverTimes:
                                type: array
                                items:
                                  type: string
                              AdditionalCompensations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    payrollLineItemAdditionalCompensation_VertexCompensationIdentifier:
                                      type: object
                                      properties:
                                        compensationDescription:
                                          type: string
                                      required:
                                        - compensationDescription
                                    amount:
                                      type: integer
                                  required:
                                    - >-
                                      payrollLineItemAdditionalCompensation_VertexCompensationIdentifier
                                    - amount
                            required:
                              - userId
                              - baseTotal
                              - numberOfLeaveDays
                              - lop
                              - retroAmount
                              - grossTotal
                              - netTotal
                              - userName
                              - employeeTax
                              - Deductions
                              - payDetails
                              - OverTimes
                              - AdditionalCompensations
                required:
                  - payPeriod
              example:
                payPeriod:
                  - payPeriodId: EFAB1DAB-5646-4DF5-8EA2-C4D42C37811E
                    payPeriod: 11/16/2023 - 11/30/2023
                    deadLineToRunPayroll: '2023-11-28'
                    total: 2910
                    employeeTaxSum: 574.18
                    employerTaxSum: 493.73
                    isProcessed: true
                    payDate: '2023-11-30'
                    payEndDate: '2023-11-30'
                    payBeginDate: '2023-11-16'
                    workerType:
                      workerType: W2
                    payrollLineItems:
                      - userId: 50070F09-2923-499A-850B-F12ED4C2FD69
                        baseTotal: 960
                        numberOfLeaveDays: 0
                        lop: 0
                        retroAmount: 0
                        grossTotal: 940
                        netTotal: 810.01
                        userName:
                          employee: Ron  Wood
                        employeeTax:
                          employeeTax: 129.99
                        Deductions:
                          - vertexDeductionIdentifier:
                              deductionDescription: Qualified Parking Sup
                            amount: 120
                        payDetails:
                          - payPercentage: 0
                            amount: 0
                            employeePayAccount:
                              accountName: savings ... 1111
                          - payPercentage: 100
                            amount: 810.01
                            employeePayAccount:
                              accountName: null
                        OverTimes: []
                        AdditionalCompensations:
                          - payrollLineItemAdditionalCompensation_VertexCompensationIdentifier:
                              compensationDescription: Cash
                            amount: 100
                      - userId: 9E3CBA77-9035-471F-AA1E-F77A13AFE5C2
                        baseTotal: 2000
                        numberOfLeaveDays: 0
                        lop: 0
                        retroAmount: 0
                        grossTotal: 1970
                        netTotal: 1540.26
                        userName:
                          employee: Mark sazav Steve
                        employeeTax:
                          employeeTax: 429.74
                        Deductions:
                          - vertexDeductionIdentifier:
                              deductionDescription: Qualified Parking Sup
                            amount: 150
                        payDetails:
                          - payPercentage: 100
                            amount: 1540.26
                            employeePayAccount:
                              accountName: checking ... 0000
                        OverTimes: []
                        AdditionalCompensations:
                          - payrollLineItemAdditionalCompensation_VertexCompensationIdentifier:
                              compensationDescription: Cash
                            amount: 120
          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 CompanyId
          headers: {}
      deprecated: false
      security:
        - basic: []
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic

````