API Evangelist conversational phrasing for OPERA Cloud Front Desk Operations Service Commissions API

# 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 Operations Service Commissions API
  version: 1.0.0
extends: openapi/oracle-hospitality-commissions-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: 23
- target: $.paths['/hotels/{hotelId}/bankAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List commission bank accounts
      effect: read
      questions:
      - Which bank accounts does my hotel pay travel agent commissions from?
      - Can I filter commission bank accounts by currency using query parameters?
      instructions:
      - text: List commission bank accounts for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Show bank accounts at {hotel} in currency {currency} via query filters.
        slots:
          hotel: path.hotelId
          currency: query.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Search commission bank accounts by criteria
      effect: read
      questions:
      - How do I search commission bank accounts by bank name with a POST body?
      - Can I look up a bank account by its account number in a search request?
      instructions:
      - text: Search bank accounts at hotel {hotel} for bank name {bank}.
        slots:
          hotel: path.hotelId
          bank: requestBody.bankName
      - text: Run a bank account search at {hotel} for account number {account}.
        slots:
          hotel: path.hotelId
          account: requestBody.bankAccountNo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a travel agent's commissionable reservations
      effect: read
      questions:
      - Which reservations is a travel agent owed commission on?
      - Can I list only the reservations where the commission is already paid?
      instructions:
      - text: List commission reservations for agent {agent} on bank account {account} at hotel {hotel}.
        slots:
          agent: path.agentId
          account: path.bankAccountId
          hotel: path.hotelId
      - text: Show agent {agent}'s commission reservations for guest {guest}.
        slots:
          agent: path.agentId
          guest: query.guestName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a travel agent's commission reservations
      effect: read
      questions:
      - How do I search an agent's commission reservations by confirmation number in a request body?
      - Can I search for commission reservations that are on hold?
      instructions:
      - text: Search commission reservations for agent {agent} on account {account} at {hotel} by confirmation {confirmation}.
        slots:
          agent: path.agentId
          account: path.bankAccountId
          hotel: path.hotelId
          confirmation: requestBody.confirmationNo
      - text: Run a search for agent {agent}'s on-hold commission reservations.
        slots:
          agent: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionChecks'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a commission check
      effect: write
      questions:
      - How do I update a commission check issued from a bank account?
      - Can I correct the details on a commission check after it was generated?
      instructions:
      - text: Change the commission check on bank account {account} at hotel {hotel}.
        slots:
          account: path.bankAccountId
          hotel: path.hotelId
      - text: Update commission check details for account {account} using {criteria}.
        slots:
          account: path.bankAccountId
          criteria: requestBody.criteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments'].get
  update:
    x-apievangelist-phrasing:
      intent: View commission payment activity for an account
      effect: read
      questions:
      - What commission payments have gone out from a bank account?
      - Can I find a commission payment by check number or payee?
      instructions:
      - text: Show commission payment activity for bank account {account} at hotel {hotel}.
        slots:
          account: path.bankAccountId
          hotel: path.hotelId
      - text: Find commission payments on account {account} with check number {check}.
        slots:
          account: path.bankAccountId
          check: query.checkNo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments'].put
  update:
    x-apievangelist-phrasing:
      intent: Update commission payment activity by range
      effect: write
      questions:
      - How do I update a range of commission payment records at once?
      - Can I change the status of commission payments across a check range?
      instructions:
      - text: Change commission payment activity by range on bank account {account} at hotel {hotel}.
        slots:
          account: path.bankAccountId
          hotel: path.hotelId
      - text: Update commission payment activity on account {account} matching {criteria}.
        slots:
          account: path.bankAccountId
          criteria: requestBody.criteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/reprintCommission'].put
  update:
    x-apievangelist-phrasing:
      intent: Reprint a range of commission checks
      effect: write
      questions:
      - How do I reprint commission checks that failed to print?
      - Can I reprint a whole range of commission checks from one bank account?
      instructions:
      - text: Reprint commission checks by range for bank account {account} at hotel {hotel}.
        slots:
          account: path.bankAccountId
          hotel: path.hotelId
      - text: Reprint the commission checks on account {account} matching {criteria}.
        slots:
          account: path.bankAccountId
          criteria: requestBody.criteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bankAccounts/{bankAccountId}/travelAgentsForCommissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List travel agents with commissions on an account
      effect: read
      questions:
      - Which travel agents have commissions tied to this bank account?
      - Who are the agents I need to pay from a given commission account?
      instructions:
      - text: List travel agents with commissions on bank account {account} at hotel {hotel}.
        slots:
          account: path.bankAccountId
          hotel: path.hotelId
      - text: Show which agents are paid from account {account}.
        slots:
          account: path.bankAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a commission agent to reservations
      effect: write
      questions:
      - How do I link a travel agent to reservations so they earn commission?
      - Can I attach one commission agent to several reservations at once?
      instructions:
      - text: Associate commission agent {agent} at hotel {hotel} with reservations {reservations}.
        slots:
          agent: path.commissionAgentId
          hotel: path.hotelId
          reservations: requestBody.reservations
      - text: Attach agent {agent} to these reservations for commission.
        slots:
          agent: path.commissionAgentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a commission agent from reservations
      effect: destructive
      questions:
      - How do I take a travel agent off a reservation so no commission is paid?
      - Can I remove a commission agent from one specific reservation?
      instructions:
      - text: Remove commission agent {agent} from reservations at hotel {hotel}.
        slots:
          agent: path.commissionAgentId
          hotel: path.hotelId
      - text: Detach agent {agent} from reservation {reservation}.
        slots:
          agent: path.commissionAgentId
          reservation: query.reservationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissionChecks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Discard generated commission checks
      effect: destructive
      questions:
      - How do I throw away a batch of commission checks before they are paid?
      - Can I discard commission checks starting from a particular check number?
      instructions:
      - text: Discard commission checks at hotel {hotel} for bank account {account}.
        slots:
          hotel: path.hotelId
          account: query.bankAccountId
      - text: Discard commission checks in batch {batch} from check {fromCheck}.
        slots:
          batch: query.BatchId
          fromCheck: query.fromCheck
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissionPayments'].put
  update:
    x-apievangelist-phrasing:
      intent: Process commission payments
      effect: write
      questions:
      - How do I run the commission payment process to pay travel agents?
      - What criteria control which commissions get paid in a payment run?
      instructions:
      - text: Process commission payments at hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Run commission payments at {hotel} using {criteria}.
        slots:
          hotel: path.hotelId
          criteria: requestBody.criteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List commissions for a hotel
      effect: read
      questions:
      - What commissions are recorded for my hotel's travel agents?
      - Can I filter commissions by agent or by payment batch?
      instructions:
      - text: List commissions at hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Show commissions at {hotel} for agent {agent}.
        slots:
          hotel: path.hotelId
          agent: query.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Calculate commissions for a hotel
      effect: write
      questions:
      - How do I recalculate all travel agent commissions for my property?
      - Can I trigger a commission calculation run before paying agents?
      instructions:
      - text: Calculate commissions for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Run the commission calculation at {hotel} now.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions/instructions'].post
  update:
    x-apievangelist-phrasing:
      intent: Set commission processing instructions for agents
      effect: write
      questions:
      - How do I tell the system how to process commissions for specific agents?
      - Can I set processing instructions for several travel agents in one call?
      instructions:
      - text: Set commission processing instructions at hotel {hotel} for agents {agents}.
        slots:
          hotel: path.hotelId
          agents: requestBody.agents
      - text: Apply processing instructions to these commission agents at {hotel}.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions/{commissionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one commission record
      effect: read
      questions:
      - What are the details of a single commission record?
      - How much commission was calculated on one specific entry?
      instructions:
      - text: Get commission {commission} at hotel {hotel}.
        slots:
          commission: path.commissionId
          hotel: path.hotelId
      - text: Show me the details of commission {commission}.
        slots:
          commission: path.commissionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions/{commissionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a commission record
      effect: write
      questions:
      - How do I correct the amount or details on an existing commission?
      - Can I edit a single commission before it is paid?
      instructions:
      - text: Update commission {commission} at hotel {hotel} with {detail}.
        slots:
          commission: path.commissionId
          hotel: path.hotelId
          detail: requestBody.commissionDetail
      - text: Change the details on commission {commission}.
        slots:
          commission: path.commissionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions/{commissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a commission record
      effect: destructive
      questions:
      - How do I delete a commission that should not be paid?
      - Can I record a reason when I detach a commission?
      instructions:
      - text: Remove commission {commission} at hotel {hotel}.
        slots:
          commission: path.commissionId
          hotel: path.hotelId
      - text: Delete commission {commission} with the reason {reason}.
        slots:
          commission: path.commissionId
          reason: query.detachDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissions/{commissionId}/commissionCodes/{commissionCode}/recalculate'].put
  update:
    x-apievangelist-phrasing:
      intent: Recalculate a commission after a code change
      effect: write
      questions:
      - How do I recompute a commission after switching its commission code?
      - Does changing the commission code on a record recalculate the amount?
      instructions:
      - text: Recalculate commission {commission} at hotel {hotel} using commission code {code}.
        slots:
          commission: path.commissionId
          hotel: path.hotelId
          code: path.commissionCode
      - text: Switch commission {commission} to code {code} and recalculate it.
        slots:
          commission: path.commissionId
          code: path.commissionCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/commissionNotes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get commission notes on a reservation
      effect: read
      questions:
      - What commission notes were left on a reservation?
      - Can I read the comments explaining a reservation's commission?
      instructions:
      - text: Get commission notes for reservation {reservation} at hotel {hotel}.
        slots:
          reservation: path.reservationId
          hotel: path.hotelId
      - text: Show the commission notes on reservation {reservation}.
        slots:
          reservation: path.reservationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/commissionPaymentDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get commission payment details for a reservation
      effect: read
      questions:
      - Has the commission on a reservation been paid, and how?
      - Where can I see payment details of the commission for one booking?
      instructions:
      - text: Get commission payment details for reservation {reservation} at hotel {hotel}.
        slots:
          reservation: path.reservationId
          hotel: path.hotelId
      - text: Show how the commission on reservation {reservation} was paid.
        slots:
          reservation: path.reservationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/commissions/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the commissions service is up
      effect: read
      questions:
      - Is the commissions service available right now?
      - Which version of the commissions service is running?
      instructions:
      - text: Ping the commissions service.
      - text: Get the commissions service version as hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'