openapi: 3.1.0
info:
  title: Oracle EBS e-Commerce Gateway Accounts Payable 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: Accounts Payable
  description: Accounts Payable invoice and payment operations
paths:
  /ap/invoices:
    get:
      operationId: getApInvoices
      summary: Retrieve Ap Invoices
      description: Retrieves Accounts Payable invoices. Maps to the AP_INVOICES_ALL and AP_INVOICE_LINES_ALL tables through the AP_INVOICES_PKG PL/SQL API.
      tags:
      - Accounts Payable
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: invoiceId
        in: query
        description: Invoice identifier
        schema:
          type: integer
        example: '500123'
      - name: invoiceNum
        in: query
        description: Invoice number
        schema:
          type: string
        example: example_value
      - name: vendorId
        in: query
        description: Supplier/vendor identifier
        schema:
          type: integer
        example: '500123'
      - name: invoiceDateFrom
        in: query
        description: Invoice date range start (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-01-15'
      - name: invoiceDateTo
        in: query
        description: Invoice date range end (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-01-15'
      - name: invoiceStatus
        in: query
        description: Invoice approval status
        schema:
          type: string
          enum:
          - APPROVED
          - NEEDS_REAPPROVAL
          - NEVER_APPROVED
          - CANCELLED
        example: APPROVED
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of AP invoices
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApInvoice'
                  totalCount:
                    type: integer
                  hasMore:
                    type: boolean
              examples:
                Getapinvoices200Example:
                  summary: Default getApInvoices 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - invoiceId: '500123'
                      invoiceNum: example_value
                      invoiceDate: '2026-01-15'
                      vendorId: '500123'
                      vendorName: example_value
                      vendorSiteId: '500123'
                      invoiceAmount: 42.5
                      invoiceCurrencyCode: example_value
                      paymentCurrencyCode: example_value
                      exchangeRate: 42.5
                      exchangeRateType: example_value
                      exchangeDate: '2026-01-15'
                      termsId: '500123'
                      description: A sample description.
                      invoiceType: STANDARD
                      source: example_value
                      paymentStatusFlag: Y
                      approvalStatus: APPROVED
                      amountPaid: '500123'
                      lines:
                      - {}
                      orgId: '500123'
                      createdBy: 10
                      creationDate: '2026-01-15T10:30:00Z'
                      lastUpdatedBy: 10
                      lastUpdateDate: '2026-01-15T10:30:00Z'
                    totalCount: 10
                    hasMore: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createApInvoice
      summary: Create an Ap Invoice
      description: Creates a new Accounts Payable invoice. Uses the AP_INVOICES_INTERFACE and AP_INVOICE_LINES_INTERFACE tables, then initiates the Payables Open Interface Import program.
      tags:
      - Accounts Payable
      security:
      - tokenAuth: []
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApInvoiceCreate'
            examples:
              CreateapinvoiceRequestExample:
                summary: Default createApInvoice request
                x-microcks-default: true
                value:
                  invoiceNum: example_value
                  vendorId: '500123'
                  vendorSiteId: '500123'
                  invoiceAmount: 42.5
                  invoiceCurrencyCode: example_value
                  invoiceDate: '2026-01-15'
                  invoiceType: STANDARD
                  description: A sample description.
                  termsId: '500123'
                  source: example_value
                  lines:
                  - lineNumber: 10
                    lineType: example_value
                    amount: 42.5
                    description: A sample description.
                    distCodeCombinationId: '500123'
      responses:
        '201':
          description: Invoice created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApInvoice'
              examples:
                Createapinvoice201Example:
                  summary: Default createApInvoice 201 response
                  x-microcks-default: true
                  value:
                    invoiceId: '500123'
                    invoiceNum: example_value
                    invoiceDate: '2026-01-15'
                    vendorId: '500123'
                    vendorName: example_value
                    vendorSiteId: '500123'
                    invoiceAmount: 42.5
                    invoiceCurrencyCode: example_value
                    paymentCurrencyCode: example_value
                    exchangeRate: 42.5
                    exchangeRateType: example_value
                    exchangeDate: '2026-01-15'
                    termsId: '500123'
                    description: A sample description.
                    invoiceType: STANDARD
                    source: example_value
                    paymentStatusFlag: Y
                    approvalStatus: APPROVED
                    amountPaid: '500123'
                    lines:
                    - lineNumber: 10
                      lineType: ITEM
                      amount: 42.5
                      description: A sample description.
                      accountingDate: '2026-01-15'
                      distCodeCombinationId: '500123'
                      itemDescription: example_value
                      quantity: 42.5
                      unitPrice: 42.5
                    orgId: '500123'
                    createdBy: 10
                    creationDate: '2026-01-15T10:30:00Z'
                    lastUpdatedBy: 10
                    lastUpdateDate: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ap/invoices/{invoiceId}:
    get:
      operationId: getApInvoiceById
      summary: Retrieve a Specific Ap Invoice
      description: Retrieves an Accounts Payable invoice by its identifier.
      tags:
      - Accounts Payable
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: invoiceId
        in: path
        required: true
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: Invoice details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApInvoice'
              examples:
                Getapinvoicebyid200Example:
                  summary: Default getApInvoiceById 200 response
                  x-microcks-default: true
                  value:
                    invoiceId: '500123'
                    invoiceNum: example_value
                    invoiceDate: '2026-01-15'
                    vendorId: '500123'
                    vendorName: example_value
                    vendorSiteId: '500123'
                    invoiceAmount: 42.5
                    invoiceCurrencyCode: example_value
                    paymentCurrencyCode: example_value
                    exchangeRate: 42.5
                    exchangeRateType: example_value
                    exchangeDate: '2026-01-15'
                    termsId: '500123'
                    description: A sample description.
                    invoiceType: STANDARD
                    source: example_value
                    paymentStatusFlag: Y
                    approvalStatus: APPROVED
                    amountPaid: '500123'
                    lines:
                    - lineNumber: 10
                      lineType: ITEM
                      amount: 42.5
                      description: A sample description.
                      accountingDate: '2026-01-15'
                      distCodeCombinationId: '500123'
                      itemDescription: example_value
                      quantity: 42.5
                      unitPrice: 42.5
                    orgId: '500123'
                    createdBy: 10
                    creationDate: '2026-01-15T10:30:00Z'
                    lastUpdatedBy: 10
                    lastUpdateDate: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ap/payments:
    get:
      operationId: getPayments
      summary: Retrieve Ap Payments
      description: Retrieves Accounts Payable payment records. Maps to the AP_CHECKS_ALL and AP_INVOICE_PAYMENTS_ALL tables.
      tags:
      - Accounts Payable
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: checkId
        in: query
        description: Payment check identifier
        schema:
          type: integer
        example: '500123'
      - name: vendorId
        in: query
        description: Supplier/vendor identifier
        schema:
          type: integer
        example: '500123'
      - name: paymentDateFrom
        in: query
        description: Payment date range start (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-01-15'
      - name: paymentDateTo
        in: query
        description: Payment date range end (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 payments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApPayment'
                  totalCount:
                    type: integer
                  hasMore:
                    type: boolean
              examples:
                Getpayments200Example:
                  summary: Default getPayments 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - checkId: '500123'
                      checkNumber: 10
                      amount: 42.5
                      currencyCode: example_value
                      checkDate: '2026-01-15'
                      vendorId: '500123'
                      vendorName: example_value
                      bankAccountId: '500123'
                      paymentMethodCode: example_value
                      status: example_value
                      orgId: '500123'
                    totalCount: 10
                    hasMore: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ApPayment:
      type: object
      properties:
        checkId:
          type: integer
          description: Payment check identifier
          example: '500123'
        checkNumber:
          type: integer
          description: Check number
          example: 10
        amount:
          type: number
          format: double
          description: Payment amount
          example: 42.5
        currencyCode:
          type: string
          description: Payment currency code
          example: example_value
        checkDate:
          type: string
          format: date
          description: Check date
          example: '2026-01-15'
        vendorId:
          type: integer
          description: Vendor identifier
          example: '500123'
        vendorName:
          type: string
          description: Vendor name
          example: example_value
        bankAccountId:
          type: integer
          description: Bank account identifier
          example: '500123'
        paymentMethodCode:
          type: string
          description: Payment method
          example: example_value
        status:
          type: string
          description: Payment status
          example: example_value
        orgId:
          type: integer
          example: '500123'
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            detail:
              type: string
          example: example_value
    ApInvoice:
      type: object
      properties:
        invoiceId:
          type: integer
          description: Invoice unique identifier
          example: '500123'
        invoiceNum:
          type: string
          description: Invoice number
          example: example_value
        invoiceDate:
          type: string
          format: date
          description: Invoice date
          example: '2026-01-15'
        vendorId:
          type: integer
          description: Supplier/vendor identifier
          example: '500123'
        vendorName:
          type: string
          description: Supplier/vendor name
          example: example_value
        vendorSiteId:
          type: integer
          description: Vendor site identifier
          example: '500123'
        invoiceAmount:
          type: number
          format: double
          description: Total invoice amount
          example: 42.5
        invoiceCurrencyCode:
          type: string
          description: Invoice currency code (ISO 4217)
          example: USD
        paymentCurrencyCode:
          type: string
          description: Payment currency code
          example: example_value
        exchangeRate:
          type: number
          format: double
          description: Currency exchange rate
          example: 42.5
        exchangeRateType:
          type: string
          description: Exchange rate type
          example: example_value
        exchangeDate:
          type: string
          format: date
          description: Exchange rate date
          example: '2026-01-15'
        termsId:
          type: integer
          description: Payment terms identifier
          example: '500123'
        description:
          type: string
          description: Invoice description
          example: A sample description.
        invoiceType:
          type: string
          description: Invoice type lookup code
          enum:
          - STANDARD
          - CREDIT
          - DEBIT
          - PREPAYMENT
          - MIXED
          example: STANDARD
        source:
          type: string
          description: Invoice source
          example: example_value
        paymentStatusFlag:
          type: string
          description: Payment status
          enum:
          - Y
          - N
          - P
          example: Y
        approvalStatus:
          type: string
          description: Approval status
          enum:
          - APPROVED
          - NEEDS_REAPPROVAL
          - NEVER_APPROVED
          - CANCELLED
          example: APPROVED
        amountPaid:
          type: number
          format: double
          description: Amount paid
          example: '500123'
        lines:
          type: array
          items:
            $ref: '#/components/schemas/ApInvoiceLine'
          example: []
        orgId:
          type: integer
          description: Operating unit identifier
          example: '500123'
        createdBy:
          type: integer
          example: 10
        creationDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        lastUpdatedBy:
          type: integer
          example: 10
        lastUpdateDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    ApInvoiceLine:
      type: object
      properties:
        lineNumber:
          type: integer
          description: Invoice line number
          example: 10
        lineType:
          type: string
          description: Line type lookup code
          enum:
          - ITEM
          - TAX
          - FREIGHT
          - MISCELLANEOUS
          example: ITEM
        amount:
          type: number
          format: double
          description: Line amount
          example: 42.5
        description:
          type: string
          description: Line description
          example: A sample description.
        accountingDate:
          type: string
          format: date
          example: '2026-01-15'
        distCodeCombinationId:
          type: integer
          description: Distribution account code combination ID
          example: '500123'
        itemDescription:
          type: string
          example: example_value
        quantity:
          type: number
          format: double
          example: 42.5
        unitPrice:
          type: number
          format: double
          example: 42.5
    ApInvoiceCreate:
      type: object
      required:
      - invoiceNum
      - vendorId
      - vendorSiteId
      - invoiceAmount
      - invoiceCurrencyCode
      - invoiceDate
      properties:
        invoiceNum:
          type: string
          example: example_value
        vendorId:
          type: integer
          example: '500123'
        vendorSiteId:
          type: integer
          example: '500123'
        invoiceAmount:
          type: number
          format: double
          example: 42.5
        invoiceCurrencyCode:
          type: string
          example: example_value
        invoiceDate:
          type: string
          format: date
          example: '2026-01-15'
        invoiceType:
          type: string
          enum:
          - STANDARD
          - CREDIT
          - DEBIT
          - PREPAYMENT
          example: STANDARD
        description:
          type: string
          example: A sample description.
        termsId:
          type: integer
          example: '500123'
        source:
          type: string
          example: example_value
        lines:
          type: array
          items:
            type: object
            properties:
              lineNumber:
                type: integer
              lineType:
                type: string
              amount:
                type: number
                format: double
              description:
                type: string
              distCodeCombinationId:
                type: integer
          example: []
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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