Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Payout by settled date API

3 actions 3 updates phrasing extends openapi/toast-payout-by-settled-date-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/{timeRange}'].post

$.paths['/payout/{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 settled date API
  version: 1.0.0
extends: openapi/toast-payout-by-settled-date-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/{timeRange}'].post
  update:
    x-apievangelist-phrasing:
      intent: Request payout data organized by settled date
      effect: write
      questions:
      - How do I request payouts grouped by the date funds settled?
      - Can a payout-by-settled-date report cover only inactive restaurants?
      instructions:
      - text: Request {time_range} payout data by settled date 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-settled-date 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/{reportRequestGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch payout-by-settled-date report results
      effect: read
      questions:
      - Where do I retrieve payout data by settled date once it is ready?
      - What does a completed payout-by-settled-date request return?
      instructions:
      - text: Get payout-by-settled-date results for report {report}.
        slots:
          report: path.reportRequestGuid
      - text: Fetch the payout data by settlement date for request {report}.
        slots:
          report: path.reportRequestGuid
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/toast-payout-by-settled-date-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.