PayoutPaymentsReportingData

The payout reporting data organized by payments.

checkGuid
string <UUID>

The identifier assigned by the Toast platform used to identify a check. This is the check associated with the payment.

gratuityAmount
number <double>

The gratuity amount added to the payment.

orderGuid
string <UUID>

The identifier assigned by the Toast platform used to identify an order. This is the order associated with the payment.

orderOpenDateTime
string <string>

The date and time when the order associated with the payment was opened.

paidDateTime
string <string>

The date and time when the order associated with the payment was paid.

paymentCardBrand
string <string>

The brand or card provider of the card used to complete the payment.

paymentCardType
string <string>

The payment type used by the card completing the payment.

paymentGuid
string <UUID>

The identifier assigned by the Toast platform used to identify the payment.

paymentSubtotal
number <double>

The total amount after excluding tip and gratuity.

paymentTotal
number <double>

Total payment that was made on the order.This value includes tip and gratuity.

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.

settledDate
string <integer>

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

tipAmount
number <double>

The tip amount added to the payment.

{
  • "restaurantGuid": "string",
  • "restaurantName": "string",
  • "restaurantLocationName": "string",
  • "restaurantLocationCode": "string",
  • "orderGuid": "string",
  • "checkGuid": "string",
  • "paymentGuid": "string",
  • "settledDate": "string",
  • "orderOpenDateTime": "string",
  • "paidDateTime": "string",
  • "paymentCardBrand": "string",
  • "paymentCardType": "string",
  • "tipAmount": 0,
  • "gratuityAmount": 0,
  • "paymentSubtotal": 0,
  • "paymentTotal": 0
}