Tax
Regime
Tax
Regime
Regime defines the holding structure for the definitions of taxes inside a country or territory.
Schema ID
https://gobl.org/draft-0/tax/regime
Properties
Title | Property | Type | Req. | Description |
---|---|---|---|---|
Name | name | i18n.String | true | Name of the country |
Code | country | l10n.CountryCode | true | Country code for the region |
Zone | zone | l10n.Code | Specific Locality, region, city, province, county, or similar code inside the country, if needed. | |
Zones | zones | array of tax.Zone | List of sub-zones inside a country. | |
Currency | currency | currency.Code | true | Currency used by the country. |
Tags | tags | array of tax.KeyDefinition | Tags that can be applied at the document level to identify additional considerations. | |
Identity Types | identity_types | array of tax.KeyDefinition | Identity types specific for the regime and may be validated against. | |
Charge Types | charge_types | array of tax.KeyDefinition | Charge types specific for the regime and may be validated or used in the UI as suggestions | |
Payment Means | payment_means | array of tax.KeyDefinition | PaymentMeansKeys specific for the regime that extend the original base payment means keys. | |
Item Keys | item_keys | array of tax.KeyDefinition | ItemKeys specific for the regime that need to be added to org.Item data in line rows. | |
Scenarios | scenarios | array of tax.ScenarioSet | Sets of scenario definitions for the regime. | |
Preceding | preceding | tax.PrecedingDefinitions | Configuration details for preceding options. | |
Categories | categories | array of tax.Category | true | List of tax categories. |