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

# Employee compensation: structure + revision history

> Employee compensation: structure + revision history



## OpenAPI

````yaml /api-reference/openapi.json get /api/payroll/employees/{employeeId}/compensation
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/employees/{employeeId}/compensation:
    get:
      tags:
        - Payroll
      summary: 'Employee compensation: structure + revision history'
      description: 'Employee compensation: structure + revision history'
      operationId: getApiPayrollEmployeesByEmployeeIdCompensation
      parameters:
        - in: path
          name: employeeId
          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)$
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ctcAnnual:
                    anyOf:
                      - type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      - type: 'null'
                  monthlyCtc:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  effectiveDate:
                    anyOf:
                      - type: string
                      - type: 'null'
                  structure:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        label:
                          type: string
                        kind:
                          type: string
                          enum:
                            - earning
                            - deduction
                        monthly:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                      required:
                        - code
                        - label
                        - kind
                        - monthly
                  grossMonthly:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  deductionsMonthly:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  netMonthly:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  revisions:
                    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)$
                        effectiveDate:
                          type: string
                        ctcAnnual:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        deltaPercent:
                          anyOf:
                            - type: number
                            - type: 'null'
                        reason:
                          type: string
                        approverName:
                          type: string
                        createdAt:
                          type: string
                      required:
                        - id
                        - effectiveDate
                        - ctcAnnual
                        - deltaPercent
                        - reason
                        - approverName
                        - createdAt
                required:
                  - ctcAnnual
                  - monthlyCtc
                  - effectiveDate
                  - structure
                  - grossMonthly
                  - deductionsMonthly
                  - netMonthly
                  - revisions
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.

````