PayoutSalesDateReportingData

The payout reporting data organized by sales date.

paymentAmount
number <double>

The amount paid to the restaurant by guests using cards on the sales date.

payoutAmount
number <double>

The amount to be deposited into the restaurant’s account. This amount is calculated by subtracting the refund, fee, and withholding amounts from the payment amount.

refundAmount
number <double>

The amount refunded to guests by the restaurant for payments made on the sales date.

restaurantGuid
string <UUID>

The identifier assigned by the Toast platform used to identify a restaurant location.

restaurantLocationCode
string <string>

The restaurant’s location code.

restaurantLocationName
string <string>

The restaurant’s location name.

restaurantName
string <string>

The restaurant’s name.

salesDate
string <integer>

The date when the payment was completed. The sales date is considered the same as the order payment date.

settledDates
Array of strings <integer>

The date when the payouts associated with the payment were either processed or settled.

totalFeeAmount
number <double>

The amount paid or owed by the restaurant in fees associated with payments made on the sales date. An example is the processing fees charged by card providers on payments.

transactionCount
number <integer>

The number of transactions made on the sales date.

withholdingAmount
number <double>

The amount owed to Toast by the restaurant for products and services. For example, this includes Toast Capital, Fundraising, and Instant Deposit.

{
  • "restaurantGuid": "string",
  • "restaurantName": "string",
  • "restaurantLocationName": "string",
  • "restaurantLocationCode": "string",
  • "salesDate": "string",
  • "settledDates": [
    ],
  • "transactionCount": 0,
  • "paymentAmount": 0,
  • "refundAmount": 0,
  • "totalFeeAmount": 0,
  • "withholdingAmount": 0,
  • "payoutAmount": 0
}