Development Documents
05-Apr-2023
Concept - IOM Taxes
Document Properties
Kbid
2Q9832
Added to KB
23-Mar-2021
Status
online
Product
  • IOM 4.0
  • IOM 4.2
  • IOM 4.4
  • IOM 4.6
  • IOM 5.0
Last Modified
05-Apr-2023
Public Access
everyone
Doc Type
Concepts
Product
  • IOM 4.1
  • IOM 4.3
  • IOM 4.5
  • IOM 4.7
  • IOM 5.1
Document Link
https://knowledge.intershop.com/kb/2Q9832

Introduction

Taxes are an essential element of an order. This concept describes selected aspects of taxes in Intershop Order Management. The target audience are consultants and developers.

Glossary

TermDescription
IOMThe abbreviation for Intershop Order Management

References

Taxes at Order Creation

Taxes are an essential element of an order. In addition to static configurations, IOM also supports variable tax rates and tax location rules at order creation. This is required for several markets, e.g. in the EU (see VAT in European Commission | Buying goods online coming from within the European Union) or US, where rules can be complex and can change at any time.

This section describes in short how to create orders with the old and the new approach for taxes.

Possible Tax Data at Order Creation

Starting from Reference - IOM REST API - Order 2.2 taxes support a rate and a location.

The following table describes useful combinations that may be submitted on order creation.

#JSON of Tax-model
1{"taxType": "FullTax", "amount": 20}
2{"taxType": "FullTax", "location": "US/Baltimore", "amount": 20}
3{"taxType": "FullTax", "rate" : 6.5, "amount": 20}
4{"taxType": "carbon dioxide tax", "rate" : 3.75, "amount": 12.3", "location": "USA"}

Info

If the location is a country, it is recommended to use its ISO-3-code.

Mapping Rules

The following list of rules describes how the tax will be stored depending on the given data of the REST API and the configuration of the shop.

Depending on the configuration and the available information, either a strict validation of predefined taxes is used or (almost) anything will be accepted.

For Tax-model see the table above.

Tax-model

Rule/ Mapping

#1 or #2Without rate, the tax must be pre-configured in TaxDO, with a valid tie range. Otherwise, the order will be refused.
#1 or #3

Without location it will be selected during the order validation. It will always be set to a country code (ISO 3166-1 alpha-3).

Depending on the configuration, the location will be selected as follows:

  • ShopDO.shippingCountryTaxMapping IS NOT set, ShopDO.country will be used.
  • ShopDO.shippingCountryTaxMapping IS set:
    • For all taxes located within a shipping bucket, the country of the shipping bucket's shipping address will be used
    • For all taxes located outside a shipping bucket (e.g.: order charges), the country of the first shipping bucket's shipping address will be used.

      Info

      This is an arbitrary choice, and customers with shipping buckets to different countries should in fact always include the location as a tax attribute.

#3 or #4

Type and rate provided.

If no corresponding entry in TaxDO is found, a new one will be created automatically (and possibly a new tax-type too).


Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Website, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Home
Knowledge Base
User Manuals
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.