> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ontime.hosai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Org-wide payslips browser (filters

> Org-wide payslips browser (filters: month/status/q/department)



## OpenAPI

````yaml /api-reference/openapi.json get /api/payroll/payslips
openapi: 3.1.0
info:
  title: ontime API
  description: APIs for ontime.v2
  version: 1.0.0
servers:
  - url: https://app.ontime.hosai.app
    description: Production
security:
  - apiKey: []
paths:
  /api/payroll/payslips:
    get:
      tags:
        - Payroll
      summary: Org-wide payslips browser (filters
      description: 'Org-wide payslips browser (filters: month/status/q/department)'
      operationId: getApiPayrollPayslips
      parameters:
        - in: query
          name: page
          schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - in: query
          name: pageSize
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
        - in: query
          name: month
          schema:
            type: string
            pattern: ^\d{4}-\d{2}$
        - in: query
          name: status
          schema:
            type: string
            enum:
              - Paid
              - Processing
              - Pending
        - in: query
          name: q
          schema:
            type: string
            maxLength: 80
        - in: query
          name: departmentId
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        employeeId:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        employeeName:
                          type: string
                        employeeCode:
                          type: string
                        department:
                          anyOf:
                            - type: string
                            - type: 'null'
                        period:
                          type: string
                        periodLabel:
                          type: string
                        status:
                          type: string
                          enum:
                            - Paid
                            - Processing
                            - Pending
                        gross:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        deductions:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        net:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        creditedDate:
                          anyOf:
                            - type: string
                            - type: 'null'
                      required:
                        - id
                        - employeeId
                        - employeeName
                        - employeeCode
                        - department
                        - period
                        - periodLabel
                        - status
                        - gross
                        - deductions
                        - net
                        - creditedDate
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  page:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageSize:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  months:
                    type: array
                    items:
                      type: string
                  grossTotal:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  netTotal:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                required:
                  - items
                  - total
                  - page
                  - pageSize
                  - months
                  - grossTotal
                  - netTotal
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: ont_ API key
      description: >-
        Issue keys in Settings → API. Send them as `Authorization: Bearer ont_…`
        (an `X-Api-Key: ont_…` header is also accepted). Session-cookie routes
        are used by the OnTime web apps and are shown for completeness.

````