Oracle EBS Financial Services API — Accounts Receivable

naftiko: 1.0.0-alpha2
info:
  label: Oracle EBS Financial Services API — Accounts Receivable
  description: 'Oracle EBS Financial Services API — Accounts Receivable. 3 operations. Lead operation: Retrieve Ar Invoices.
    Self-contained Naftiko capability covering one Oracle E Business Suite business surface.'
  tags:
  - Oracle E Business Suite
  - Accounts Receivable
  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: financial-services-accounts-receivable
    baseUri: https://{instance}.oracle.com/webservices/rest
    description: Oracle EBS Financial Services API — Accounts Receivable business capability. Self-contained, no shared references.
    resources:
    - name: ar-invoices
      path: /ar/invoices
      operations:
      - name: getarinvoices
        method: GET
        description: Retrieve Ar Invoices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customerTrxId
          in: query
          type: integer
          description: Customer transaction identifier
        - name: trxNumber
          in: query
          type: string
          description: Transaction number
        - name: customerId
          in: query
          type: integer
          description: Customer identifier
        - name: trxDateFrom
          in: query
          type: string
          description: Transaction date range start (YYYY-MM-DD)
        - name: trxDateTo
          in: query
          type: string
          description: Transaction date range end (YYYY-MM-DD)
      - name: createarinvoice
        method: POST
        description: Create an Ar Invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ar-receipts
      path: /ar/receipts
      operations:
      - name: getreceipts
        method: GET
        description: Retrieve Ar Receipts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cashReceiptId
          in: query
          type: integer
          description: Cash receipt identifier
        - name: receiptNumber
          in: query
          type: string
          description: Receipt number
        - name: customerId
          in: query
          type: integer
          description: Customer identifier
    authentication:
      type: apikey
      key: accessToken
      value: '{{env.ORACLE_E_BUSINESS_SUITE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: financial-services-accounts-receivable-rest
    port: 8080
    description: REST adapter for Oracle EBS Financial Services API — Accounts Receivable. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/ar/invoices
      name: ar-invoices
      description: REST surface for ar-invoices.
      operations:
      - method: GET
        name: getarinvoices
        description: Retrieve Ar Invoices
        call: financial-services-accounts-receivable.getarinvoices
        with:
          customerTrxId: rest.customerTrxId
          trxNumber: rest.trxNumber
          customerId: rest.customerId
          trxDateFrom: rest.trxDateFrom
          trxDateTo: rest.trxDateTo
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createarinvoice
        description: Create an Ar Invoice
        call: financial-services-accounts-receivable.createarinvoice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ar/receipts
      name: ar-receipts
      description: REST surface for ar-receipts.
      operations:
      - method: GET
        name: getreceipts
        description: Retrieve Ar Receipts
        call: financial-services-accounts-receivable.getreceipts
        with:
          cashReceiptId: rest.cashReceiptId
          receiptNumber: rest.receiptNumber
          customerId: rest.customerId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: financial-services-accounts-receivable-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle EBS Financial Services API — Accounts Receivable. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: retrieve-ar-invoices
      description: Retrieve Ar Invoices
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: financial-services-accounts-receivable.getarinvoices
      with:
        customerTrxId: tools.customerTrxId
        trxNumber: tools.trxNumber
        customerId: tools.customerId
        trxDateFrom: tools.trxDateFrom
        trxDateTo: tools.trxDateTo
      outputParameters:
      - type: object
        mapping: $.
    - name: create-ar-invoice
      description: Create an Ar Invoice
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: financial-services-accounts-receivable.createarinvoice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-ar-receipts
      description: Retrieve Ar Receipts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: financial-services-accounts-receivable.getreceipts
      with:
        cashReceiptId: tools.cashReceiptId
        receiptNumber: tools.receiptNumber
        customerId: tools.customerId
      outputParameters:
      - type: object
        mapping: $.