Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Payout by payments API

3 actions 3 updates phrasing extends openapi/toast-payout-by-payments-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/payout/payments/{timeRange}'].post

$.paths['/payout/payments/{reportRequestGuid}'].get

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 Analytics Payout by payments API
  version: 1.0.0
extends: openapi/toast-payout-by-payments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/payout/payments/{timeRange}'].post
  update:
    x-apievangelist-phrasing:
      intent: Request payout data organized by payment
      effect: write
      questions:
      - How do I request payout data broken down by individual payment?
      - Can a payout-by-payment report be limited to inactive restaurants?
      instructions:
      - text: Request {time_range} payout data by payment from {start} to {end} for {restaurants}.
        slots:
          time_range: path.timeRange
          start: requestBody.startDate
          end: requestBody.endDate
          restaurants: requestBody.restaurantIds
      - text: Start a payout-by-payment report from {start} to {end} excluding {excluded}.
        slots:
          start: requestBody.startDate
          end: requestBody.endDate
          excluded: requestBody.excludedRestaurantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payout/payments/{reportRequestGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch payout-by-payment report results
      effect: read
      questions:
      - Where do I get the payout data by payment once my request is ready?
      - What does a finished payout-by-payment report return?
      instructions:
      - text: Get payout-by-payment results for report {report}.
        slots:
          report: path.reportRequestGuid
      - text: Fetch the payout data by payment for request {report}.
        slots:
          report: path.reportRequestGuid
      method: generated
      generated: '2026-10-01'