SpotOn · Schema

OrderSurcharge

A surcharge applied to an order check or payment.

RestaurantPoint of SalePaymentsOnline OrderingReservationsReporting

Properties

Name	Type	Description
surchargeId	string	Surcharge identifier.
surchargeName	string	Surcharge name at the time of application.
createdAt	string	RFC 3339 timestamp when the surcharge was applied.
amount	string	Surcharge amount in US dollars, as a decimal string.
taxesAmount	string	Applied tax amount, as a decimal string.
taxes	array	Tax details.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderSurcharge",
  "description": "A surcharge applied to an order check or payment.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/spoton/refs/heads/main/json-schema/restaurant-pos-export-order-surcharge-schema.json",
  "type": "object",
  "properties": {
    "surchargeId": {
      "type": "string",
      "description": "Surcharge identifier."
    },
    "surchargeName": {
      "type": "string",
      "description": "Surcharge name at the time of application."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 timestamp when the surcharge was applied."
    },
    "amount": {
      "type": "string",
      "description": "Surcharge amount in US dollars, as a decimal string."
    },
    "taxesAmount": {
      "type": "string",
      "description": "Applied tax amount, as a decimal string."
    },
    "taxes": {
      "type": "array",
      "description": "Tax details.",
      "items": {
        "type": "object",
        "description": "A tax applied to an order line, modifier, or surcharge.",
        "properties": {
          "taxId": {
            "type": "string",
            "description": "Tax identifier. Empty for splick.it orders."
          },
          "taxName": {
            "type": "string",
            "description": "Tax name at the time of application."
          },
          "percentage": {
            "type": "string",
            "description": "Tax percentage as a decimal string, for example \"6.5\"."
          },
          "amount": {
            "type": "string",
            "description": "Tax amount in US dollars, as a decimal string."
          }
        }
      }
    }
  }
}