Oracle E-Business Suite Payroll API

openapi: 3.1.0
info:
  title: Oracle EBS e-Commerce Gateway Accounts Payable Payroll API
  description: RESTful APIs for Oracle E-Business Suite e-Commerce Gateway providing EDI (Electronic Data Interchange) transaction support. Enables exchange of standard ASC X12 and EDIFACT documents with trading partners through flat ASCII file integration with third-party EDI translators. Supports inbound and outbound document processing for purchase orders, invoices, ship notices, and other business documents.
  version: 12.2.0
  contact:
    name: Oracle Support
    email: support@oracle.com
    url: https://support.oracle.com
  license:
    name: Oracle Proprietary
    url: https://www.oracle.com/legal/terms/
  x-logo:
    url: https://www.oracle.com/a/ocom/img/oracle-logo.svg
servers:
- url: https://{instance}.oracle.com/webservices/rest
  description: Oracle EBS ISG REST endpoint
  variables:
    instance:
      default: ebs-host
      description: The Oracle EBS instance hostname
tags:
- name: Payroll
  description: Payroll processing and run results
paths:
  /pay/payrolls:
    get:
      operationId: getPayrolls
      summary: Retrieve Payroll Definitions
      description: Retrieves payroll definitions from Oracle Payroll. Maps to the PAY_ALL_PAYROLLS_F table.
      tags:
      - Payroll
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: payrollId
        in: query
        description: Payroll identifier
        schema:
          type: integer
        example: '500123'
      - name: payrollName
        in: query
        description: Payroll name
        schema:
          type: string
        example: example_value
      - name: businessGroupId
        in: query
        description: Business group identifier
        schema:
          type: integer
        example: '500123'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of payroll definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payroll'
                  totalCount:
                    type: integer
                  hasMore:
                    type: boolean
              examples:
                Getpayrolls200Example:
                  summary: Default getPayrolls 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - payrollId: '500123'
                      payrollName: example_value
                      periodType: Calendar Month
                      numberOfYears: 10
                      firstPeriodEndDate: '2026-01-15'
                      effectiveStartDate: '2026-01-15'
                      effectiveEndDate: '2026-01-15'
                      businessGroupId: '500123'
                    totalCount: 10
                    hasMore: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /pay/payrollRuns:
    get:
      operationId: getPayrollRuns
      summary: Retrieve Payroll Run Results
      description: Retrieves payroll run and action results. Maps to the PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and PAY_RUN_RESULTS tables.
      tags:
      - Payroll
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: payrollActionId
        in: query
        description: Payroll action identifier
        schema:
          type: integer
        example: '500123'
      - name: payrollId
        in: query
        description: Payroll identifier
        schema:
          type: integer
        example: '500123'
      - name: effectiveDate
        in: query
        description: Effective date (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-01-15'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of payroll runs
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PayrollRun'
                  totalCount:
                    type: integer
                  hasMore:
                    type: boolean
              examples:
                Getpayrollruns200Example:
                  summary: Default getPayrollRuns 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - payrollActionId: '500123'
                      payrollId: '500123'
                      actionType: example_value
                      actionStatus: C
                      effectiveDate: '2026-01-15'
                      dateEarned: '2026-01-15'
                      periodOfServiceId: '500123'
                      businessGroupId: '500123'
                    totalCount: 10
                    hasMore: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            detail:
              type: string
          example: example_value
    Payroll:
      type: object
      properties:
        payrollId:
          type: integer
          description: Payroll identifier
          example: '500123'
        payrollName:
          type: string
          description: Payroll name
          example: example_value
        periodType:
          type: string
          description: Payroll period type
          enum:
          - Calendar Month
          - Semi-Month
          - Bi-Week
          - Week
          - Lunar Month
          example: Calendar Month
        numberOfYears:
          type: integer
          description: Number of years defined
          example: 10
        firstPeriodEndDate:
          type: string
          format: date
          example: '2026-01-15'
        effectiveStartDate:
          type: string
          format: date
          example: '2026-01-15'
        effectiveEndDate:
          type: string
          format: date
          example: '2026-01-15'
        businessGroupId:
          type: integer
          example: '500123'
    PayrollRun:
      type: object
      properties:
        payrollActionId:
          type: integer
          description: Payroll action identifier
          example: '500123'
        payrollId:
          type: integer
          description: Payroll identifier
          example: '500123'
        actionType:
          type: string
          description: Action type (R=Run, Q=QuickPay, etc.)
          example: example_value
        actionStatus:
          type: string
          description: Action status
          enum:
          - C
          - E
          - M
          - P
          - U
          example: C
        effectiveDate:
          type: string
          format: date
          example: '2026-01-15'
        dateEarned:
          type: string
          format: date
          example: '2026-01-15'
        periodOfServiceId:
          type: integer
          example: '500123'
        businessGroupId:
          type: integer
          example: '500123'
  responses:
    Unauthorized:
      description: Authentication required or token expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    Offset:
      name: offset
      in: query
      description: Number of records to skip for pagination
      schema:
        type: integer
        default: 0
    Limit:
      name: limit
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        default: 25
        maximum: 500
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with Oracle EBS username and password
    tokenAuth:
      type: apiKey
      in: cookie
      name: accessToken
      description: Token-based authentication using the ISG login access token