SimpleUSTax

The SimpleUSTax component, which appears in the Tax stage of an order processing pipeline, applies a given rate to any order sent to a specified state in the United States.

• υKey. (Read-only) The name of a property on the order form used to specify tax method. The value of this property is compared to the string specified in the Method field to determine whether to apply the tax to the order.
• υApply when. Specifies when to apply the tax.
  • υEqual to Country. Specifies that the tax will be applied only if the value of the property specified for Key is the same as the string specified in the Country field.
  • υHas any value. Specifies that the tax will be applied when the value of the property specified for Key has any value on the order form. If you select this option, the Country field should be left blank.
  • υAlways. Specifies that the tax is always applied to the order.
• υCountry. If Equal to Country is selected, specifies a string that the component compares with the value of ship_to_country on the order form to determine whether to apply the tax to the order. The tax will be applied only if there is an exact match.
• υState Rate List. Specifies each state for which tax is collected, and the tax rate for that state. These are listed as fields in the form state:rate, with state expressed as the two-character postal code abbreviation and rate expressed as a decimal value. For example, an 8.6% tax rate for the state of Washington is entered as WA:8.6. Multiple state/rate pairs are separated by a space. You can enter an at sign (@) (the wildcard character) to represent all states that are not explicitly listed (for example: @:0).

Note

The SimpleUSTax component is a simple tool for you to use to calculate tax rates. Microsoft strongly recommends that you have an independent tax professional verify all applicable tax rates and data generated by this component before you use such information for personal or business purposes.

Remarks

The combination of the Key, Apply when, and Country fields determine whether tax should be applied, but only if the state to which the order is being shipped is listed in the State Rate List.

The SimpleUSTax component first checks the Apply when value. If it is set to Always, the tax is always applied to the order. If Apply when is set to Has any value, the tax is applied to the order whenever the order form contains any value for ship_to_country. If Apply when is set to Equal to Country, the component does a comparison between the value of ship_to_country on the order form and the text string in the Country field on this property page. If there is a match, the component applies the tax.

If the component determines that tax should be applied, it then compares the value of ship_to_state on the order form to the list of states specified in State Rate List. If there is a match, indicating that the order is being shipped to a state where tax should be collected, the component applies the tax rate specified for that state, and sets the values for item._tax_total, item._tax_included, order._tax_total, order._tax_included.

SimpleUSTax always sets _tax_included name/value pairs to zero (0) for both the item and the order. The component does not handle fractions of base currency units; all calculations are rounded to the nearest whole unit.

If the customer types a country or state in the OrderForm that is not specified in the SimpleUSTax component configuration, the values of the _tax_total and _tax_included name/value pairs on the order and on the items will not be set.

Related Topics

• υComponent Coordination