Oracle EBS Human Resources API — Payroll

naftiko: 1.0.0-alpha2
info:
  label: Oracle EBS Human Resources API — Payroll
  description: 'Oracle EBS Human Resources API — Payroll. 2 operations. Lead operation: Retrieve Payroll Run Results. Self-contained
    Naftiko capability covering one Oracle E Business Suite business surface.'
  tags:
  - Oracle E Business Suite
  - Payroll
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_E_BUSINESS_SUITE_API_KEY: ORACLE_E_BUSINESS_SUITE_API_KEY
capability:
  consumes:
  - type: http
    namespace: human-resources-payroll
    baseUri: https://{instance}.oracle.com/webservices/rest
    description: Oracle EBS Human Resources API — Payroll business capability. Self-contained, no shared references.
    resources:
    - name: pay-payrollRuns
      path: /pay/payrollRuns
      operations:
      - name: getpayrollruns
        method: GET
        description: Retrieve Payroll Run Results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payrollActionId
          in: query
          type: integer
          description: Payroll action identifier
        - name: payrollId
          in: query
          type: integer
          description: Payroll identifier
        - name: effectiveDate
          in: query
          type: string
          description: Effective date (YYYY-MM-DD)
    - name: pay-payrolls
      path: /pay/payrolls
      operations:
      - name: getpayrolls
        method: GET
        description: Retrieve Payroll Definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payrollId
          in: query
          type: integer
          description: Payroll identifier
        - name: payrollName
          in: query
          type: string
          description: Payroll name
        - name: businessGroupId
          in: query
          type: integer
          description: Business group identifier
    authentication:
      type: apikey
      key: accessToken
      value: '{{env.ORACLE_E_BUSINESS_SUITE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: human-resources-payroll-rest
    port: 8080
    description: REST adapter for Oracle EBS Human Resources API — Payroll. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/pay/payrollruns
      name: pay-payrollruns
      description: REST surface for pay-payrollRuns.
      operations:
      - method: GET
        name: getpayrollruns
        description: Retrieve Payroll Run Results
        call: human-resources-payroll.getpayrollruns
        with:
          payrollActionId: rest.payrollActionId
          payrollId: rest.payrollId
          effectiveDate: rest.effectiveDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pay/payrolls
      name: pay-payrolls
      description: REST surface for pay-payrolls.
      operations:
      - method: GET
        name: getpayrolls
        description: Retrieve Payroll Definitions
        call: human-resources-payroll.getpayrolls
        with:
          payrollId: rest.payrollId
          payrollName: rest.payrollName
          businessGroupId: rest.businessGroupId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: human-resources-payroll-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle EBS Human Resources API — Payroll. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieve-payroll-run-results
      description: Retrieve Payroll Run Results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: human-resources-payroll.getpayrollruns
      with:
        payrollActionId: tools.payrollActionId
        payrollId: tools.payrollId
        effectiveDate: tools.effectiveDate
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-payroll-definitions
      description: Retrieve Payroll Definitions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: human-resources-payroll.getpayrolls
      with:
        payrollId: tools.payrollId
        payrollName: tools.payrollName
        businessGroupId: tools.businessGroupId
      outputParameters:
      - type: object
        mapping: $.