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

# Get Hris Payslips For Org

> Lists org payslips with search, period and department filters, sorting, pagination and a monthly dashboard summary.

Required scope: `compensation:read`

## OpenAPI

````yaml api-reference/openapi.json POST /hris/get-hris-payslips-for-org
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/get-hris-payslips-for-org:
    post:
      operationId: getHrisPayslipsForOrg
      summary: Get Hris Payslips For Org
      x-toku-required-scope: compensation:read
      description: >-
        Lists org payslips with search, period and department filters, sorting,
        pagination and a monthly dashboard summary.


        Required scope: `compensation:read`
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetHrisPayslipsForOrgRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHrisPayslipsForOrgResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetHrisPayslipsForOrgRequest:
      type: object
      properties:
        summaryOnly:
          type: boolean
        search:
          type: string
          maxLength: 100
          description: >-
            NOTE(ck): a .transform() rule is not mirrored here; TGA still
            enforces it
        periodKey:
          type: string
          pattern: ^\d{4}-(0[1-9]|1[0-2])$
        department:
          type: string
          description: >-
            NOTE(ck): a .transform() rule is not mirrored here; TGA still
            enforces it

            Filters to one department. Blank is the same as omitted.
        sortBy:
          type: string
          enum:
            - employee
            - payslipDate
            - grossAmount
            - netAmount
            - digitalAssetGross
            - digitalAssetNet
        sortDirection:
          type: string
          enum:
            - asc
            - desc
        limit:
          type: integer
          minimum: 1
          maximum: 20000
          default: 10
        offset:
          type: integer
          minimum: 0
          default: 0
    GetHrisPayslipsForOrgResponse:
      type: object
      properties:
        totalCount:
          type: number
        hasDigitalAssetPayslips:
          type: boolean
        payslips:
          type: array
          items:
            type: object
            properties:
              hrisPayslipID:
                type: string
              roleInOrgID:
                type: string
              payslipDate:
                type: string
              payPeriodLabel:
                type: string
              grossAmount:
                type: string
              employeeWithholdingAmount:
                type: string
              deductionsAmount:
                type: string
              netAmount:
                type: string
              digitalAssetGross:
                type:
                  - string
                  - 'null'
              digitalAssetNet:
                type:
                  - string
                  - 'null'
              tokenWithholdingAmount:
                type:
                  - string
                  - 'null'
              payslipKind:
                type: string
              tokenCurrency:
                type:
                  - object
                  - 'null'
                properties:
                  currencyID:
                    type: string
                  currencyCode:
                    type: string
                  name:
                    type: string
                required:
                  - currencyID
                  - currencyCode
                  - name
              status:
                const: PROCESSED
              createdAt:
                type: string
              employee:
                type: object
                properties:
                  roleInOrgID:
                    type: string
                  fullName:
                    type: string
                  email:
                    type:
                      - string
                      - 'null'
                  department:
                    type:
                      - string
                      - 'null'
                required:
                  - roleInOrgID
                  - fullName
                  - email
                  - department
              currency:
                type: object
                properties:
                  currencyID:
                    type: string
                  currencyCode:
                    type: string
                  name:
                    type: string
                required:
                  - currencyID
                  - currencyCode
                  - name
              file:
                type:
                  - object
                  - 'null'
                properties:
                  fileID:
                    type: string
                  fileName:
                    type: string
                  mimeType:
                    type: string
                  fileSizeInBytes:
                    type:
                      - number
                      - 'null'
                required:
                  - fileID
                  - fileName
                  - mimeType
                  - fileSizeInBytes
            required:
              - hrisPayslipID
              - roleInOrgID
              - payslipDate
              - payPeriodLabel
              - grossAmount
              - employeeWithholdingAmount
              - deductionsAmount
              - netAmount
              - digitalAssetGross
              - digitalAssetNet
              - tokenWithholdingAmount
              - payslipKind
              - tokenCurrency
              - status
              - createdAt
              - employee
              - currency
              - file
        dashboardSummary:
          type: object
          properties:
            monthLabel:
              type: string
            totalsByCurrency:
              type: array
              items:
                type: object
                properties:
                  currencyID:
                    type: string
                  currencyCode:
                    type: string
                  currencyName:
                    type: string
                  totalGrossAmount:
                    type: string
                  totalNetAmount:
                    type: string
                required:
                  - currencyID
                  - currencyCode
                  - currencyName
                  - totalGrossAmount
                  - totalNetAmount
            employeesPaidCount:
              type: number
            pendingCount:
              type: number
          required:
            - monthLabel
            - totalsByCurrency
            - employeesPaidCount
            - pendingCount
      required:
        - totalCount
        - hasDigitalAssetPayslips
        - payslips
        - dashboardSummary
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
