> ## 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 Employee Leave Balance

> Returns per-leave-type taken, pending, statutory and entitlement figures for an employee and year.

Required scope: `time:read`. With an API key, `roleInOrgID` must be set: a key has no person of its own.

## OpenAPI

````yaml api-reference/openapi.json GET /hris/get-hris-employee-leave-balance
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/get-hris-employee-leave-balance:
    get:
      operationId: getHrisEmployeeLeaveBalance
      summary: Get Hris Employee Leave Balance
      x-toku-required-scope: time:read
      description: >-
        Returns per-leave-type taken, pending, statutory and entitlement figures
        for an employee and year.


        Required scope: `time:read`. With an API key, `roleInOrgID` must be set:
        a key has no person of its own.
      parameters:
        - name: roleInOrgID
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: year
          in: query
          required: false
          schema:
            type: integer
            minimum: 2000
            maximum: 2100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHrisEmployeeLeaveBalanceResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetHrisEmployeeLeaveBalanceResponse:
      $ref: '#/components/schemas/TimeOffEmployeeBalance'
      description: Request regeneration does not infer response shapes.
    TimeOffEmployeeBalance:
      type: object
      properties:
        roleInOrgID:
          type: string
          format: uuid
        year:
          type: integer
        countryCode:
          type:
            - string
            - 'null'
        balances:
          type: array
          items:
            $ref: '#/components/schemas/TimeOffLeaveBalance'
        vacation:
          $ref: '#/components/schemas/TimeOffVacationAllocation'
      required:
        - roleInOrgID
        - year
        - countryCode
        - balances
        - vacation
    TimeOffLeaveBalance:
      type: object
      properties:
        leaveType:
          type: string
        daysTaken:
          type: number
        pendingDays:
          type: number
        statutoryMinimumDays:
          type:
            - number
            - 'null'
        policyType:
          type:
            - string
            - 'null'
        isHalfDayAllowed:
          type: boolean
        leaveTypeKey:
          type: string
        leaveTypeKind:
          type: string
          enum:
            - builtin
            - custom
        customLeaveTypeID:
          type:
            - string
            - 'null'
          format: uuid
        displayName:
          type:
            - string
            - 'null'
        countsAsLeaveType:
          type:
            - string
            - 'null'
        entitlementPolicyType:
          type:
            - string
            - 'null'
        entitlementTotalPerYear:
          type:
            - number
            - 'null'
        entitlementSource:
          type:
            - string
            - 'null'
        accrualFrequency:
          type:
            - string
            - 'null'
        accrualEffectiveFrom:
          type:
            - string
            - 'null'
          format: date
        accruedToDate:
          type:
            - number
            - 'null'
        accruedRemainingDays:
          type:
            - number
            - 'null'
        accrualHistory:
          type: array
          items:
            $ref: '#/components/schemas/TimeOffAccrualHistory'
        openingBalanceDays:
          type: number
        openingBalanceNote:
          type:
            - string
            - 'null'
      required:
        - leaveType
        - daysTaken
        - pendingDays
        - statutoryMinimumDays
        - policyType
        - isHalfDayAllowed
        - leaveTypeKey
        - leaveTypeKind
        - customLeaveTypeID
        - displayName
        - countsAsLeaveType
        - entitlementPolicyType
        - entitlementTotalPerYear
        - entitlementSource
        - accrualFrequency
        - accrualEffectiveFrom
        - accruedToDate
        - accruedRemainingDays
        - accrualHistory
        - openingBalanceDays
        - openingBalanceNote
    TimeOffAccrualHistory:
      type: object
      properties:
        periodKey:
          type: string
        periodStart:
          type: string
          format: date
        periodEnd:
          type: string
          format: date
        days:
          type: number
        isProrated:
          type: boolean
        source:
          type: string
        postedAt:
          type: string
          format: date-time
      required:
        - periodKey
        - periodStart
        - periodEnd
        - days
        - isProrated
        - source
        - postedAt
    TimeOffVacationAllocation:
      type: object
      properties:
        year:
          type: integer
        vacationCustomLeaveTypeIDs:
          type: array
          items:
            type: string
            format: uuid
        statutory:
          oneOf:
            - $ref: '#/components/schemas/TimeOffStatutoryBucket'
            - type: 'null'
        company:
          oneOf:
            - $ref: '#/components/schemas/TimeOffCompanyBucket'
            - type: 'null'
        overBalanceDays:
          type: number
        requests:
          type: array
          items:
            $ref: '#/components/schemas/TimeOffVacationRequestAllocation'
      required:
        - year
        - vacationCustomLeaveTypeIDs
        - statutory
        - company
        - overBalanceDays
        - requests
    TimeOffStatutoryBucket:
      allOf:
        - $ref: '#/components/schemas/TimeOffVacationBucket'
        - type: object
          properties:
            source:
              type: string
              enum:
                - country_rule
                - employee_entitlement
            minimumDays:
              type:
                - number
                - 'null'
            carriedOverDays:
              type: number
            nextExpiry:
              oneOf:
                - $ref: '#/components/schemas/TimeOffGrantExpiry'
                - type: 'null'
            mandatoryUse:
              oneOf:
                - $ref: '#/components/schemas/TimeOffMandatoryUse'
                - type: 'null'
          required:
            - source
            - minimumDays
            - carriedOverDays
            - nextExpiry
            - mandatoryUse
    TimeOffVacationBucket:
      type: object
      properties:
        entitledDays:
          type:
            - number
            - 'null'
        takenDays:
          type: number
        upcomingDays:
          type: number
        pendingDays:
          type: number
        availableDays:
          type:
            - number
            - 'null'
      required:
        - entitledDays
        - takenDays
        - upcomingDays
        - pendingDays
        - availableDays
    TimeOffGrantExpiry:
      type: object
      properties:
        days:
          type: number
        'on':
          type: string
          format: date
      required:
        - days
        - 'on'
    TimeOffMandatoryUse:
      type: object
      properties:
        requiredDays:
          type: number
        usedDays:
          type: number
        useByDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - MET
            - ON_TRACK
            - AT_RISK
            - NOT_MET
      required:
        - requiredDays
        - usedDays
        - useByDate
        - status
    TimeOffCompanyBucket:
      allOf:
        - $ref: '#/components/schemas/TimeOffVacationBucket'
        - type: object
          properties:
            policy:
              type: string
            customLeaveTypeID:
              type:
                - string
                - 'null'
              format: uuid
            name:
              type: string
          required:
            - policy
            - customLeaveTypeID
            - name
    TimeOffVacationRequestAllocation:
      type: object
      properties:
        hrisTimeOffID:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - REQUESTED
            - APPROVED
            - REJECTED
            - CANCELLED
        statutoryDays:
          type: number
        companyDays:
          type: number
        overBalanceDays:
          type: number
      required:
        - hrisTimeOffID
        - status
        - statutoryDays
        - companyDays
        - overBalanceDays
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
