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 |
Description | description | i18n.String | Introductory details about the regime. | |
Time Zone | time_zone | string | true | Location name for the country’s central time zone. Accepted values from IANA Time Zone Database (https://iana.org/time-zones). |
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. | |
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. | |
Extensions | extensions | array of tax.KeyDefinition | Extensions defines the keys that can be used for extended or extra data inside the regime that is specific to the regime and cannot be easily determined from other GOBL structures. Typically these are used to define local codes for suppliers, customers, products, or tax rates. | |
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. | |
Inbox Keys | inbox_keys | array of tax.KeyDefinition | InboxKeys specific to the regime that can be used to identify where a document should be forwarded to. | |
Scenarios | scenarios | array of tax.ScenarioSet | ||
Corrections | corrections | array of tax.CorrectionDefinition | Configuration details for corrections to be used with correction options. | |
Categories | categories | array of tax.Category | true | List of tax categories. |
zones | array of tax.Zone | List of zones to identify specific areas, regions, or provinces inside a country tha may be required for tax purposes. |