PayoutSettledDateReportingData

The payout reporting data organized by settled date.

paymentAmount
number <double>

The amount paid to the restaurant by guests using cards that contributes towards the payout amount.

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.

payoutStatus
string <string>

The status of the payout.

Valid values:

  • CAPTURED - Toast collected the guest card payments included in the payout successfully.
  • SENT - Toast sent the payout to the bank. It may take some time to appear in the account.
  • NONE - The payout was made prior to January 10, 2024 and is unavailable.
refundAmount
number <double>

The amount refunded to guests by the restaurant that contributes towards the payout amount.

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.

salesPeriodEndDateTime
string <string>

The date and time of the last payment included in the payout amount.

salesPeriodStartDateTime
string <string>

The date and time of the first payment included in the payout amount.

settledDate
string <integer>

The date when the payout was either processed or settled.

totalFeeAmount
number <double>

The amount paid or owed by the restaurant in fees that contributes towards the payout amount. An example is the processing fees charged by card providers on payments.

transactionCount
number <integer>

The number of transactions included in the payout.

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",
  • "settledDate": "string",
  • "salesPeriodStartDateTime": "string",
  • "salesPeriodEndDateTime": "string",
  • "transactionCount": 0,
  • "paymentAmount": 0,
  • "refundAmount": 0,
  • "totalFeeAmount": 0,
  • "withholdingAmount": 0,
  • "payoutAmount": 0,
  • "payoutStatus": "string"
}