How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Toast Payout by sales date API

The analytics API endpoint for payout reporting data organized by sales date.

Toast Payout by sales date API is one of 80 APIs that Toast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payout by sales date. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://toast-api-server/era/v1.

2 operations 2 paths 5 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://toast-api-server/era/v1
Authentication
OAuth 2.0
Contact
Toast developer support
Resource Areas
1

Authentication & Security 1

Toast Payout by sales date API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope.

  • oauth2 — Access to Toast APIs, specific endpoints, and specific API endpoint operations is controlled by the scopes that are associated with your API account. A full re…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payout by sales date 2

The analytics API endpoint for payout reporting data organized by sales date.

POST
/payout/sales-date/{timeRange}
Post a payout data request organized by sales date for a specific time range
postPayoutReportSalesDateSpecificTimeRange 2 params body → 200400500
GET
/payout/sales-date/{reportRequestGuid}
Get the payout reporting data organized by sales date
getPayoutSalesDateReportingData 1 param → 200202404409500504

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PayoutSalesDateReportingData (12 properties), ErrorMessage (10 properties), PayoutSalesDateReportingDataRequest (4 properties), ReportingDataInProgress (3 properties). Each schema is shown below with its type and property counts.

PayoutSalesDateReportingDataRequest
object
Information about what the payout data organized by sales date covers and how it is presented. This includes the starting and ending dates of the time range, a…
4 properties 4 required
ReportRequestGuid
string
The Toast platform assigned identifier used to identify a specific analytics reporting data request.
PayoutSalesDateReportingData
object
The payout reporting data organized by sales date.
12 properties
ErrorMessage
object
Information about an unsuccessful REST request.
10 properties
ReportingDataInProgress
object
The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

toast-payout-by-sales-date-api-openapi.yml Raw ↑

Other APIs Toast publishes across the network.

Toast Authentication API
Toast ConnectedRestaurants API
Toast Discounts API
Toast Employees API
Toast Groups API
Toast Jobs API
Toast Menus API
Toast Metadata API
Toast Orders API
Toast Payments API
Toast Restaurants API
Toast Shifts API
Where this information came from

This is an independent, third-party profile of Toast Payout by sales date API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.