Regime defines the holding structure for the definitions of taxes inside a country or territory.

Schema ID


Namenamei18n.StringtrueName of the country
Codecountryl10n.CountryCodetrueCountry code for the region
Zonezonel10n.CodeSpecific Locality, region, city, province, county, or similar code inside the country, if needed.
Zoneszonesarray of tax.ZoneList of sub-zones inside a country.
Currencycurrencycurrency.CodetrueCurrency used by the country.
Tagstagsarray of tax.KeyDefinitionTags that can be applied at the document level to identify additional considerations.
Identity Typesidentity_typesarray of tax.KeyDefinitionIdentity types specific for the regime and may be validated against.
Charge Typescharge_typesarray of tax.KeyDefinitionCharge types specific for the regime and may be validated or used in the UI as suggestions
Payment Meanspayment_meansarray of tax.KeyDefinitionPaymentMeansKeys specific for the regime that extend the original base payment means keys.
Item Keysitem_keysarray of tax.KeyDefinitionItemKeys specific for the regime that need to be added to org.Item data in line rows.
Scenariosscenariosarray of tax.ScenarioSetSets of scenario definitions for the regime.
Precedingprecedingtax.PrecedingDefinitionsConfiguration details for preceding options.
Categoriescategoriesarray of tax.CategorytrueList of tax categories.