Tax Management in Brink Commerce API Documentation

Introduction

Tax management in the Brink Commerce API is a separate service designed to provide maximum flexibility when adding tax (VAT) to products and markets. This documentation explains the concepts and structure of tax management within the Brink Commerce API.

Prerequisites

Before creating products in Brink, it is recommended to set up taxGroups and taxMarkets, especially when bootstrapping your merchant environment. This ensures a smooth tax calculation process for your products.

Concepts of Tax in Brink Commerce

TaxGroups

• TaxGroups represent the tax group of a product. Examples of tax groups include electronics, books, groceries, etc.
• Each TaxGroup has a unique "id" and a descriptive "name" field.
• TaxGroups are used to categorize products for tax calculation.

TaxMarkets

• TaxMarkets represent the actual tax percentage that a merchant should charge in a given market (country code).
• Each TaxMarket consists of two properties: "percentage" and "decimals," which define the tax rate accurately.
• For example, the tax rate for Books (a TaxGroup) in Sweden might be represented as 6% with "percentage" being 6 and "decimals" being 0.06.
• TaxMarkets are associated with specific markets for precise tax calculations.

Product Variants

• Product Variants are assigned to a specific TaxGroup.
• This assignment allows the Brink Shopper API to automatically calculate tax based on the tax rate associated with the TaxGroup.

Entity Relationships

The following Entity Relationship Diagram (ERD) illustrates the relationships between taxGroups, taxMarkets, and productVariants in Brink Commerce:

• A TaxGroup can have multiple TaxMarkets assigned.
• A TaxMarket can be associated with only one TaxGroup.
• A ProductVariant is assigned to one specific TaxGroup for tax calculation.

This structure allows you to effectively manage tax rates for various product categories and markets in the Brink Commerce API.