Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Front Desk Configuration Accounts Receivables…

11 actions 11 updates phrasing extends openapi/oracle-hospitality-accountsreceivablesconfig-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Oracle Hospitality's API. It is a proposal applied on top of the contract, not a document Oracle Hospitality publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/accountTypes'].put
$.paths['/accountTypes'].post
$.paths['/accountTypes'].delete
$.paths['/flaggedReasons'].get
$.paths['/flaggedReasons'].put
$.paths['/flaggedReasons'].post
$.paths['/flaggedReasons'].delete
$.paths['/hotels/{hotelId}/ARAccountTypes'].get
$.paths['/services/accountsReceivables/status'].get
$.paths['/upsert/accountTypes'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OPERA Cloud Front Desk Configuration Accounts Receivables…
  version: 1.0.0
extends: openapi/oracle-hospitality-accountsreceivablesconfig-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/accountTypes'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify existing AR account types
      effect: write
      questions:
      - How do I edit the description of an accounts receivable account type I already set up?
      - Can I change several existing AR account types in one request?
      instructions:
      - text: Update the existing AR account types with {accountTypes}.
        slots:
          accountTypes: requestBody.accountTypes
      - text: Change the settings on our current accounts receivable account types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new AR account types
      effect: write
      questions:
      - How do I add a brand-new accounts receivable account type for a property?
      - What's needed to define new AR account types for direct billing?
      instructions:
      - text: Create new AR account types {accountTypes}.
        slots:
          accountTypes: requestBody.accountTypes
      - text: Add a new accounts receivable account type for corporate direct bill.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountTypes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove AR account types from a hotel
      effect: destructive
      questions:
      - How do I delete accounts receivable account types that a hotel no longer uses?
      - Can I remove specific AR account types for one property only?
      instructions:
      - text: Delete AR account types {accountTypes} at hotel {hotelId}.
        slots:
          accountTypes: query.accountTypes
          hotelId: query.hotelId
      - text: Remove the unused accounts receivable account types from hotel {hotelId}.
        slots:
          hotelId: query.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flaggedReasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List AR flagged reasons
      effect: read
      questions:
      - Which reasons can an AR account be flagged for?
      - Can I search flagged reason codes by wildcard or description across properties?
      instructions:
      - text: List the AR flagged reasons for properties {propertyCodes}.
        slots:
          propertyCodes: query.propertyCodes
      - text: Find flagged reasons whose code matches {reasonWildCard}.
        slots:
          reasonWildCard: query.reasonWildCard
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flaggedReasons'].put
  update:
    x-apievangelist-phrasing:
      intent: Change existing AR flagged reasons
      effect: write
      questions:
      - How do I reword an accounts receivable flagged reason that already exists?
      - Can I update several existing AR flag reasons at once?
      instructions:
      - text: Update the existing AR flagged reasons with {aRFlaggedReasons}.
        slots:
          aRFlaggedReasons: requestBody.aRFlaggedReasons
      - text: Edit the description of our current AR flagged reason codes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flaggedReasons'].post
  update:
    x-apievangelist-phrasing:
      intent: Create AR flagged reasons
      effect: write
      questions:
      - How do I add a new reason code for flagging an AR account?
      - What does it take to set up new flagged reasons in accounts receivable?
      instructions:
      - text: Create the new AR flagged reasons {aRFlaggedReasons}.
        slots:
          aRFlaggedReasons: requestBody.aRFlaggedReasons
      - text: Add a new flagged reason for AR accounts with disputed balances.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flaggedReasons'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove AR flagged reasons
      effect: destructive
      questions:
      - How do I delete AR flagged reason codes we no longer use?
      - Can I remove flagged reasons for several hotels in one call?
      instructions:
      - text: Delete flagged reason codes {codes} for hotels {hotelIds}.
        slots:
          codes: query.codes
          hotelIds: query.hotelIds
      - text: Remove the AR flagged reasons configured at hotels {hotelIds}.
        slots:
          hotelIds: query.hotelIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/ARAccountTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a hotel's AR account types
      effect: read
      questions:
      - Which accounts receivable account types are set up at my hotel?
      - Can I look up an AR account type by its description?
      instructions:
      - text: List the AR account types at hotel {hotelId}.
        slots:
          hotelId: path.hotelId
      - text: Find AR account type {accountType} at hotel {hotelId}.
        slots:
          accountType: query.accountType
          hotelId: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/accountsReceivables/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the accounts receivables service status
      effect: read
      questions:
      - Is the accounts receivables configuration service up right now?
      - How can I health-check the AR service before sending config changes?
      instructions:
      - text: Ping the accounts receivables service and report its status.
      - text: Ping accounts receivables with input {operaPingInput}.
        slots:
          operaPingInput: query.operaPingInput
      method: generated
      generated: '2026-09-26'
- target: $.paths['/upsert/accountTypes'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update AR account types in one call
      effect: write
      questions:
      - Is there a way to upsert AR account types so I don't need to know whether they already exist?
      - Can I sync a full set of accounts receivable account types, creating missing ones and updating the rest?
      instructions:
      - text: Upsert AR account types {accountTypes}, creating any that are missing.
        slots:
          accountTypes: requestBody.accountTypes
      - text: Sync our accounts receivable account types with create-or-change semantics.
      method: generated
      generated: '2026-09-26'