Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cash Management Entries API

2 actions 2 updates phrasing extends openapi/toast-entries-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 2

$.info
$.paths['/entries'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cash Management Entries API
  version: 1.0.0
extends: openapi/toast-entries-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: 1
- target: $.paths['/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List cash drawer entries for a day
      effect: read
      questions:
      - How much cash was added to or taken out of the cash drawers on a given business day?
      - Can I see every cash entry recorded for one business date?
      instructions:
      - text: List cash entries at restaurant {restaurant} for business date {date}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          date: query.businessDate
      - text: Show cash added to or removed from drawers on {date} at {restaurant}.
        slots:
          date: query.businessDate
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'