SimpleJapanTax

The SimpleJapanTax component, which appears in the Tax stage of an order processing pipeline, computes a tax rate for the Japanese tax model. It can be used for any country that uses a similar model. The component handles fractions of currency units only at the item level; order-level calculations (order._tax_total and order._tax_included) are rounded to the nearest whole unit.

• υ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.
• υInclude Item Key. Specifies the name of the field in the item Dictionary that indicates whether the tax is already included in the item’s price. This field is assumed to contain a Boolean value that indicates whether or not the tax rate is to be added to the line item (in which case item._tax_total is set to the tax amount and item._tax_included is set to zero), or whether the tax rate is included in the price (in which case item._tax_included is set to the tax amount and item._tax_total is set to zero).
• υRate Item Key. Specifies the name of the field in the item that contains the tax rate charged for the item.

Note

The SimpleJapanTax 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 tax is not already included in the item’s price.

The SimpleJapanTax 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 whose value is stored in the field specified in Rate Item Key.

Example

To specify that a 9.54% tax rate is included within an item’s price and is not included in another item’s price for items in Japan, do the following:

1. Add a column for the included tax rate to your product table. The tax rate should be specified as a smallint number:

   jpn_prod_tax_included   smallint  NOT NULL,
   

2. Add a column for the tax rate to your product table. The tax rate should be specified as a real number:

   jpn_prod_tax_rate       real     NOT NULL,
   

3. Assign tax rates and tax included values to each product in your product table using an SQL script. This example uses two products, Product Included and Product Excluded. Assign Product Included the 9.54% tax rate with the tax included in the product price. Type 9.54 into the jpn_prod_tax_rate column and 1 (True), in the jpn_prod_tax_included column in the Product Included row. Assign Product Excluded the 9.54% tax rate with the tax not included in the product price. Type 9.54 into the jpn_prod_tax_rate column and 0 (False), in the jpn_prod_tax_included column in the Product Excluded row.
4. Double-click the SimpleJapanTax icon in the Win32®-based Pipeline Editor, or click the Edit link for the component in the ASP-based Pipeline Editor and enter the following in the resulting property page.

Note

If the customer types a country in the OrderForm that is not specified in the SimpleJapanTax 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