Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Cashiering Asynchronous Cashiering Async API

3 actions 3 updates phrasing extends openapi/oracle-hospitality-cashieringasync-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 3

$.info

$.paths['/hotels/{hotelId}/financialPostingsNetVat'].post

$.paths['/hotels/{hotelId}/financialPostingsNetVat/{statusId}'].head

OpenAPI Overlay

# 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 Cashiering Asynchronous Cashiering Async API
  version: 1.0.0
extends: openapi/oracle-hospitality-cashieringasync-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: 2
- target: $.paths['/hotels/{hotelId}/financialPostingsNetVat'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a net and VAT financial postings request
      effect: read
      questions:
      - How do I get financial postings with a net and VAT breakdown for my hotel?
      - Can I request postings with VAT split out as a background job?
      instructions:
      - text: Start a net and VAT financial postings request for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Request financial postings for hotel {hotel} using criteria {criteria}.
        slots:
          hotel: path.hotelId
          criteria: requestBody.netvatcriteriatype
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/financialPostingsNetVat/{statusId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check if a financial postings request is ready
      effect: read
      questions:
      - Is my net and VAT postings request finished yet?
      - Where do I find the status ID to poll after starting a postings request?
      instructions:
      - text: Check the status of postings request {status_id} at hotel {hotel}.
        slots:
          status_id: path.statusId
          hotel: path.hotelId
      - text: Poll whether financial postings job {status_id} for hotel {hotel} is ready.
        slots:
          status_id: path.statusId
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'