AppliedTaxRate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/orders-applied-tax-rate-schema.json",
  "title": "AppliedTaxRate",
  "description": "A tax rate that is applied to an item or service charge.",
  "type": "object",
  "required": [
    "taxRate"
  ],
  "allOf": [
    {
      "$ref": "#/definitions/ToastReference"
    },
    {
      "type": "object",
      "properties": {
        "entityType": {
          "description": "The type of object this is.",
          "type": "string"
        },
        "taxRate": {
          "type": "object",
          "$ref": "#/definitions/ToastReference"
        },
        "name": {
          "type": "string",
          "description": "The name of the tax rate."
        },
        "rate": {
          "type": "number",
          "format": "double",
          "description": "The tax rate, which can be a fixed amount, a percentage, or null."
        },
        "taxAmount": {
          "type": "number",
          "format": "double",
          "description": "The tax amount that was actually applied."
        },
        "type": {
          "type": "string",
          "description": "The type of the tax rate. Default is `PERCENT`.\n\nThe value `EXTERNAL` indicates that the tax is for a marketplace\nfacilitator order, and that the marketplace facilitator\norganization calculated the tax amount.\n",
          "enum": [
            "PERCENT",
            "FIXED",
            "NONE",
            "TABLE",
            "EXTERNAL"
          ]
        },
        "facilitatorCollectAndRemitTax": {
          "type": "boolean",
          "description": "Indicates whether the marketplace facilitator that\nreceived a guest order remitted the tax amount on behalf\nof the Toast platform restaurant.\n\nYou can use this information to identify tax amounts that\nhave already been paid by an ordering service provider\nand do not need to be paid again.\n\n* `true` - The marketplace facilitator paid the tax\namount on behalf of the Toast platform restaurant\nlocation.\n\n* `false` - The marketplace facilitator has not paid the\ntax amount. The Toast platform restaurant location may be\nrequired to pay the tax amount.\n\n**Note**: Toast API response data is not guidance or\nadvice for tax compliance.\n"
        },
        "displayName": {
          "type": "string",
          "description": "The name of the tax rate as it appears on guest receipts."
        },
        "jurisdiction": {
          "type": "string",
          "description": "The state or province of the tax rate for reporting purposes."
        },
        "jurisdictionType": {
          "type": "string",
          "description": "The jurisdiction type (ex. STATE, COUNTY, etc.) of the tax rate for reporting purposes."
        }
      }
    }
  ]
}