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

# Current employee's pay home: YTD totals + payslips

> Current employee's pay home: YTD totals + payslips



## OpenAPI

````yaml /api-reference/openapi.json get /api/pay/me
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/pay/me:
    get:
      tags:
        - Pay
      summary: 'Current employee''s pay home: YTD totals + payslips'
      description: 'Current employee''s pay home: YTD totals + payslips'
      operationId: getApiPayMe
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  fyYear:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  fyLabel:
                    type: string
                  ytd:
                    type: object
                    properties:
                      net:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      gross:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      tax:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      ot:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - net
                      - gross
                      - tax
                      - ot
                  latest:
                    anyOf:
                      - 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)$
                          period:
                            type: string
                          periodLabel:
                            type: string
                          status:
                            type: string
                            enum:
                              - Paid
                              - Processing
                              - Pending
                          gross:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          totalDeductions:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          net:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          creditedDate:
                            anyOf:
                              - type: string
                              - type: 'null'
                          bankName:
                            anyOf:
                              - type: string
                              - type: 'null'
                          bankAccountLast4:
                            anyOf:
                              - type: string
                              - type: 'null'
                        required:
                          - id
                          - employeeId
                          - period
                          - periodLabel
                          - status
                          - gross
                          - totalDeductions
                          - net
                          - creditedDate
                          - bankName
                          - bankAccountLast4
                      - type: 'null'
                  earlier:
                    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)$
                        period:
                          type: string
                        periodLabel:
                          type: string
                        status:
                          type: string
                          enum:
                            - Paid
                            - Processing
                            - Pending
                        gross:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        totalDeductions:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        net:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        creditedDate:
                          anyOf:
                            - type: string
                            - type: 'null'
                        bankName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        bankAccountLast4:
                          anyOf:
                            - type: string
                            - type: 'null'
                      required:
                        - id
                        - employeeId
                        - period
                        - periodLabel
                        - status
                        - gross
                        - totalDeductions
                        - net
                        - creditedDate
                        - bankName
                        - bankAccountLast4
                required:
                  - fyYear
                  - fyLabel
                  - ytd
                  - latest
                  - earlier
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.

````