Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PSA Invoice Overview API

3 actions 3 updates phrasing extends openapi/acronis-invoiceoverview-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Acronis's API. It is a proposal applied on top of the contract, not a document Acronis publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/InvoiceOverview'].get

$.paths['/InvoiceOverview'].post

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 PSA Invoice Overview API
  version: 1.0.0
extends: openapi/acronis-invoiceoverview-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['/InvoiceOverview'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the invoice overview
      effect: read
      questions:
      - How do I list a customer's invoices a page at a time?
      - Can I find invoices whose payment hasn't been confirmed yet?
      - Which invoices have already been exported?
      instructions:
      - text: Show page {Page} of invoices, {PageSize} per page.
        slots:
          Page: query.Page
          PageSize: query.PageSize
      - text: List invoices for customer {Customer}, page {Page} of size {PageSize}.
        slots:
          Customer: query.Customer
          Page: query.Page
          PageSize: query.PageSize
      - text: Find invoice number {InvoiceNumber} on page {Page}, size {PageSize}.
        slots:
          InvoiceNumber: query.InvoiceNumber
          Page: query.Page
          PageSize: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/InvoiceOverview'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an invoice or confirm its payment
      effect: write
      questions:
      - How do I mark an invoice as paid?
      - Can I set the payment type when updating an invoice?
      instructions:
      - text: Update invoice {invoice}.
        slots:
          invoice: requestBody.invoice
      - text: Mark invoice {invoice} payment as confirmed with payment type {intPaymentType}.
        slots:
          invoice: requestBody.invoice
          intPaymentType: requestBody.intPaymentType
      method: generated
      generated: '2026-09-26'