ModifierOptionTaxInfo

Information about the tax rates and tax behavior of this modifier option.

Note: The modifierOptionTaxInfo value always reflects the parent menu item tax rate, unless Toast grants the restaurant the ability to override modifier tax rates. If this permission is not granted, then even if the restaurant configured the modifier with a different tax rate, modifierOptionTaxInfo reflects the parent menu item tax rate.

Note that there are other tax-related features that can impact the tax of a modifier option, such as tax inclusion and smart tax, that are not returned in this ModifierOptionTaxInfo object. For more information, see Tax on modifiers and Tax functionality interaction.

Important: The ModifierOptionTaxInfo object is intended to help you display prices but the /prices endpoint of the orders API is the only supported way to determine the prices of orders that you submit to the orders API. See Order prices in the Toast Developer Guide for more information.

• overrideItemTaxRates:
  boolean

  Indicates whether the tax rates configured for this modifier option override the tax rates configured for a menu item that this modifier option has been applied to. For example, if the menu item is configured for a 6.25% tax rate and the modifier option is configured for a 2.75% tax rate, when that modifier option is applied to the menu item, both are taxed at the 2.75% tax rate.

  Note that the menu item's tax rate is overridden only if the modifier option is added to the menu item on a Toast POS device. The modifier option may be available to apply to the menu item, but if it is not actually added to the menu item on a Toast POS device, then the menu item's tax rate is not overridden. See Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options in the Toast Developer Guide for more information.

• taxRateGuids:
  Array of strings

  An array of GUIDs for the tax rates that apply to this modifier option.

  The taxRateGuids value includes different tax rate GUIDs, depending on whether the modifier option is configured in Toast Web to use its own tax rates or to inherit tax rates from a menu item it has been applied to. See Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options in the Toast Developer Guide for more information.

  To retrieve full configuration data for a tax rate, use the /taxRates/{guid} endpoint in the configuration API.

{
  "taxRateGuids": [
    "string"
  ],
  "overrideItemTaxRates": true
}