¶ Entities
This figure depicts the main models and their relationships.
Some of the fields in the diagram are not up-to-date. Please refer to bellow specifications.
¶ Tax (Tax)
Represents the tax rates to be applied to product items through tax rules and calculated with at the cart item level.
¶ Fields
- Id (
ididentifier, required:string<UUIDv4>) Autogenerated identifier for the tax. - Code (
codeidentifier, required:string<[a-zA-Z0-9-_]+>, max length50) Human friendly code to identify the tax. - Description (
description:string) Description of the tax. Defaults toundefinedinterpreted as"". - Rate (
rate, required:float<range[0.0, 100.0]>) Rate in percentage from 0.0 to 100.0.
¶ Tax Rule (TaxRule)
Represets the coditions to apply each specific tax depending on customers, products and addresses.
¶ Fields
- Id (
ididentifier, required:string<UUIDv4>) Autogenerated identifier for the tax rule. - Title (
title:string) Title of the rule to be easily identified by humans. Defaults toundefinedinterpreted as"". - Description (
description:string) Description for the rule. Defaults toundefinedinterpreted as"". - Enabled (
enabled:boolean) Yes/no value to enable/disable the rule. Defaults toundefinedinterpreted astrue. - Tax (
taxId, required, ref<Tax>:string) Reference to the tax to be applied whe the rule condition are met. - Customer Tax Class (
customerTaxClassId, required, ref<CustomerTaxClass>:string) Tax class code to identify the class of customers which the tax applies to. - Product Tax Class (
productTaxClassId, required, ref<ProductTaxClass>:string) Tax class code to identify the class of products which the tax applies to. - Zone (
zoneId, required, ref<TaxZone>:string) Identifier of the geographic zone where the tax applies.
¶ Tax Zone (TaxZone)
Represents the geographic zones where taxes are applied.
¶ Fields
- Id (
ididentifier, required:string<UUIDv4>) Autogenerated identifier for the tax zone. - Name (
name:string) Name of the tax zone to be easily identified by humans. Defaults toundefinedinterpreted as"". - Description (
description:string) Description for the tax zone. Defaults toundefinedinterpreted as"". - Country (
countryCode, required:string<ISO_3166-1_alpha-2>) Country code in ISO_3166-1_alpha-2 format. - Region (State/Province) (
regionCode:string) Region identifier. It can refer to a state, province, or other possible political division in a country. Defaults toundefinedinterpreted as "All the regions in the country". - Postal/ZIP Code From (
postalCodeFrom:string) The starting postal code of the range. If the other limit of the range is not specified, this one refers to a specific postal code. If no postal codes specified in all the range, it is interpreted as "All the postal codes". Defaults toundefined. - Postal/ZIP Code To (
postalCodeTo:string) The ending postal code of the range. If the other limit of the range is not specified, this one refers to a specific postal code. Defaults toundefined.
¶ Customer Tax Class (CustomerTaxClass)
Represents the identifiers to classify customers according to their applied taxes.
¶ Fields
- Id (
ididentifier, required:string<UUIDv4>) Autogenerated identifier for the customer tax class. - Code (
codeidentifier, required:string<[a-zA-Z0-9-_]+>, max length50) Human friendly code to identify the customer tax class. - Description (
description:string) Description for the customer tax class. Defaults toundefinedinterpreted as"".
¶ Product Tax Class (ProductTaxClass)
Represents the identifiers to classify products according to their applied taxes.
¶ Fields
- Id (
ididentifier, required:string<UUIDv4>) Autogenerated identifier for the product tax class. - Code (
codeidentifier, required:string<[a-zA-Z0-9-_]+>, max length50) Human friendly code to identify the product tax class. - Description (
description:string) Description for the product tax class. Defaults toundefinedinterpreted as"".