MenuReportingData

The menu reporting data.

• averagePrice:
  number <double>

  The average price of the associated line items. When grouping by MENU, MENU_GROUP, or MENU_ITEM, this is the average price for the menu item and any associated modifiers. When grouping by MODIFIER, this is the average price for the modifier.

• businessDate:
  string <integer>

  The date for the menu reporting data. The business day uses the YYYYMMDD format. For example, 20220824.

• discountAmount:
  number <double>

  The total amount of discounts.

• grossSalesAmount:
  number <double>

  The total sales, including discounts and refunds.

• menuGroupGuid:
  string <UUID>

  The identifier for the menu group, assigned by the Toast platform. This property appears when the request for menu data includes the groupBy property with value MENU_GROUP.

• menuGroupName:
  string <string>

  The name of the menu group. This property appears when the request for menu data includes the groupBy property with value MENU_GROUP.

• menuGuid:
  string <UUID>

  The identifier for the menu, assigned by the Toast platform. This property appears when the request for menu data includes the groupBy property with value MENU.

• menuItemGuid:
  string <UUID>

  The identifier for the menu item, assigned by the Toast platform. This property appears when the request for menu data includes the groupBy property with value MENU_ITEM.

• menuItemName:
  string <string>

  The name of the menu item. This property appears when the request for menu data includes the groupBy property with value MENU_ITEM.

• menuName:
  string <string>

  The name of the menu. This property appears when the request for menu data includes the groupBy property with value MENU.

• modifierGuid:
  string <UUID>

  The identifier for the modifier, assigned by the Toast platform. This property appears when the request for menu data includes the groupBy property with value MODIFIER.

• modifierName:
  string <string>

  The name of the modifier. This property appears when the request for menu data includes the groupBy property with value MODIFIER.

• netSalesAmount:
  number <double>

  The total sales, excluding tax, gratuity, tips, discounts, refunds, and deferred amounts.

• quantitySold:
  number <double>

  The number of line items sold. This number includes items that were made but later refunded. When grouping by MENU, MENU_GROUP, or MENU_ITEM, this is the count of the associated menu items and includes any modifiers. When grouping by MODIFIER, this is the count of the modifier.

• refundAmount:
  number <double>

  The total amount of refunded sales.

• 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.

• voidAmount:
  number <double>

  The total amount of voided sales.

• wasteAmount:
  number <double>

  The total amount of menu items tracked as food waste. When grouping by MENU, MENU_GROUP, or MENU_ITEM, this is the total price for the menu items and any associated modifiers. When grouping by MODIFIER, this is the total price for the modifiers.

• wasteCount:
  number <double>

  The number of line items tracked as food waste. When grouping by MENU, MENU_GROUP, or MENU_ITEM, this is the count of the associated menu items and does not include modifiers. When grouping by MODIFIER, this is the count of the modifier.

{
  "businessDate": "string",
  "restaurantGuid": "string",
  "restaurantName": "string",
  "restaurantLocationName": "string",
  "restaurantLocationCode": "string",
  "netSalesAmount": 0,
  "grossSalesAmount": 0,
  "discountAmount": 0,
  "refundAmount": 0,
  "voidAmount": 0,
  "quantitySold": 0,
  "averagePrice": 0,
  "wasteCount": 0,
  "wasteAmount": 0,
  "menuGuid": "string",
  "menuName": "string",
  "menuGroupGuid": "string",
  "menuGroupName": "string",
  "menuItemGuid": "string",
  "menuItemName": "string",
  "modifierGuid": "string",
  "modifierName": "string"
}