Toast · JSON Structure

Orders Refund Details Structure

Information about refunded currency amounts for an item selection, modifier option, or service charge. The refund information includes separate values for the pre-tax value being refunded and the tax amount being refunded.

Type: object Properties: 3
Food ServicePoint of SaleRestaurantsHospitality

RefundDetails is a JSON Structure definition published by Toast, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

refundAmount taxRefundAmount refundTransaction

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-structure/orders-refund-details-structure.json",
  "name": "RefundDetails",
  "description": "Information about refunded currency amounts for an item\nselection, modifier option, or service charge. The refund\ninformation includes separate values for the pre-tax value\nbeing refunded and the tax amount being refunded.\n",
  "type": "object",
  "properties": {
    "refundAmount": {
      "description": "The value of the menu item or service charge (excluding taxes) being\nrefunded. Includes the value of any nested modifier options that\nincreased the price of the item or modifier option (an upcharge for\nthe modifier option).\n",
      "type": "double"
    },
    "taxRefundAmount": {
      "description": "The tax amount being refunded.\n",
      "type": "double"
    },
    "refundTransaction": {
      "description": "An identifier for the refund transaction. You can use the identifier to associate items and service charges that were refunded in the same transaction.\n",
      "type": "object",
      "$ref": "#/definitions/RefundTransaction"
    }
  }
}