UKG Pro HCM API — Payroll

naftiko: 1.0.0-alpha2
info:
  label: UKG Pro HCM API — Payroll
  description: 'UKG Pro HCM API — Payroll. 3 operations. Lead operation: UKG Pro HCM List Pay Statements. Self-contained Naftiko
    capability covering one Ukg business surface.'
  tags:
  - Ukg
  - Payroll
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UKG_API_KEY: UKG_API_KEY
capability:
  consumes:
  - type: http
    namespace: pro-hcm-payroll
    baseUri: https://service.ultipro.com
    description: UKG Pro HCM API — Payroll business capability. Self-contained, no shared references.
    resources:
    - name: payroll-v1-pay-statements
      path: /payroll/v1/pay-statements
      operations:
      - name: listpaystatements
        method: GET
        description: UKG Pro HCM List Pay Statements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: query
          type: string
          description: Filter by employee ID
        - name: startDate
          in: query
          type: string
          description: Start date for pay statement range
        - name: endDate
          in: query
          type: string
          description: End date for pay statement range
    - name: personnel-v2-employees-employeeId-direct-deposits
      path: /personnel/v2/employees/{employeeId}/direct-deposits
      operations:
      - name: getemployeedirectdeposits
        method: GET
        description: UKG Pro HCM Get Employee Direct Deposits
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: path
          type: string
          description: Employee identifier
          required: true
    - name: personnel-v2-employees-employeeId-pay-rates
      path: /personnel/v2/employees/{employeeId}/pay-rates
      operations:
      - name: getemployeepayrates
        method: GET
        description: UKG Pro HCM Get Employee Pay Rates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: path
          type: string
          description: Employee identifier
          required: true
    authentication:
      type: basic
      username: '{{env.UKG_USER}}'
      password: '{{env.UKG_PASS}}'
  exposes:
  - type: rest
    namespace: pro-hcm-payroll-rest
    port: 8080
    description: REST adapter for UKG Pro HCM API — Payroll. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/payroll/v1/pay-statements
      name: payroll-v1-pay-statements
      description: REST surface for payroll-v1-pay-statements.
      operations:
      - method: GET
        name: listpaystatements
        description: UKG Pro HCM List Pay Statements
        call: pro-hcm-payroll.listpaystatements
        with:
          employeeId: rest.employeeId
          startDate: rest.startDate
          endDate: rest.endDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personnel/v2/employees/{employeeid}/direct-deposits
      name: personnel-v2-employees-employeeid-direct-deposits
      description: REST surface for personnel-v2-employees-employeeId-direct-deposits.
      operations:
      - method: GET
        name: getemployeedirectdeposits
        description: UKG Pro HCM Get Employee Direct Deposits
        call: pro-hcm-payroll.getemployeedirectdeposits
        with:
          employeeId: rest.employeeId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personnel/v2/employees/{employeeid}/pay-rates
      name: personnel-v2-employees-employeeid-pay-rates
      description: REST surface for personnel-v2-employees-employeeId-pay-rates.
      operations:
      - method: GET
        name: getemployeepayrates
        description: UKG Pro HCM Get Employee Pay Rates
        call: pro-hcm-payroll.getemployeepayrates
        with:
          employeeId: rest.employeeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pro-hcm-payroll-mcp
    port: 9090
    transport: http
    description: MCP adapter for UKG Pro HCM API — Payroll. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: ukg-pro-hcm-list-pay
      description: UKG Pro HCM List Pay Statements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-payroll.listpaystatements
      with:
        employeeId: tools.employeeId
        startDate: tools.startDate
        endDate: tools.endDate
      outputParameters:
      - type: object
        mapping: $.
    - name: ukg-pro-hcm-get-employee
      description: UKG Pro HCM Get Employee Direct Deposits
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-payroll.getemployeedirectdeposits
      with:
        employeeId: tools.employeeId
      outputParameters:
      - type: object
        mapping: $.
    - name: ukg-pro-hcm-get-employee-2
      description: UKG Pro HCM Get Employee Pay Rates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-payroll.getemployeepayrates
      with:
        employeeId: tools.employeeId
      outputParameters:
      - type: object
        mapping: $.