openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Payroll API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Payroll
  description: Payroll processing and results
paths:
  /hcmRestApi/resources/11.13.18.05/payrollResults:
    get:
      operationId: listPayrollResults
      summary: Oracle Fusion Cloud Applications List payroll results
      description: Retrieve payroll run results including earnings, deductions, and net pay for workers.
      tags:
      - Payroll
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Payroll results retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PayrollResult'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    q:
      name: q
      in: query
      required: false
      description: Filter expression using Oracle REST query syntax
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      description: Number of items to skip
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of fields to return
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return (default 25, max 500)
      schema:
        type: integer
        default: 25
        maximum: 500
    finder:
      name: finder
      in: query
      required: false
      description: Named finder in format FinderName;param1=value1
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
  schemas:
    PayrollResult:
      type: object
      properties:
        PayrollResultId:
          type: integer
          description: Payroll result identifier
        PersonNumber:
          type: string
          description: Person number
        PersonName:
          type: string
          description: Person display name
        PayrollName:
          type: string
          description: Payroll name
        PeriodName:
          type: string
          description: Payroll period name
        PeriodStartDate:
          type: string
          format: date
          description: Period start date
        PeriodEndDate:
          type: string
          format: date
          description: Period end date
        GrossEarnings:
          type: number
          format: double
          description: Total gross earnings
        TotalDeductions:
          type: number
          format: double
          description: Total deductions
        NetPay:
          type: number
          format: double
          description: Net pay amount
        CurrencyCode:
          type: string
          description: Payment currency
        PaymentDate:
          type: string
          format: date
          description: Payment date
        PaymentMethod:
          type: string
          description: Payment method
          enum:
          - Direct Deposit
          - Check
          - Cash
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html