Toast · Schema

VoidInformation

Information about a void applied to a check or item.

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name Type Description
voidUser object The user who voided the order.
voidApprover object The user who approved the void.
voidDate string The date on which the void was made.
voidBusinessDate integer The business date (yyyyMMdd) on which the void was made. Response only.
voidReason object A reference to the configured void reason for the void.
View JSON Schema on GitHub

JSON Schema

orders-void-information-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/orders-void-information-schema.json",
  "title": "VoidInformation",
  "description": "Information about a void applied to a check or item.",
  "type": "object",
  "properties": {
    "voidUser": {
      "type": "object",
      "description": "The user who voided the order.",
      "$ref": "#/definitions/ExternalReference"
    },
    "voidApprover": {
      "type": "object",
      "description": "The user who approved the void.",
      "$ref": "#/definitions/ExternalReference"
    },
    "voidDate": {
      "description": "The date on which the void was made.",
      "type": "string",
      "format": "date-time"
    },
    "voidBusinessDate": {
      "x-toast-read-only": true,
      "description": "The business date (yyyyMMdd) on which the void was made. Response only.",
      "type": "integer"
    },
    "voidReason": {
      "type": "object",
      "description": "A reference to the configured void reason for the void.",
      "$ref": "#/definitions/ExternalReference"
    }
  }
}