Class: GOBL::Tax::Regime
- Extended by:
- Extensions::Tax::RegimeHelper::ClassMethods
- Defined in:
- lib/generated/gobl/tax/regime.rb
Overview
Regime defines the holding structure for the definitions of taxes inside a country or territory.
Constant Summary collapse
- SCHEMA_ID =
The Schema ID of the GOBL Regime structure
'https://gobl.org/draft-0/tax/regime'
Instance Attribute Summary collapse
-
#categories ⇒ Array<Category>
readonly
List of tax categories.
-
#charge_types ⇒ Array<KeyDefinition>
readonly
Charge types specific for the regime and may be validated or used in the UI as suggestions.
-
#country ⇒ GOBL::L10n::CountryCode
readonly
Country code for the region.
-
#currency ⇒ GOBL::Currency::Code
readonly
Currency used by the country.
-
#extensions ⇒ Array<KeyDefinition>
readonly
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.
-
#identity_types ⇒ Array<KeyDefinition>
readonly
Identity types specific for the regime and may be validated against.
-
#item_keys ⇒ Array<KeyDefinition>
readonly
ItemKeys specific for the regime that need to be added to ‘org.Item` data in line rows.
-
#name ⇒ GOBL::I18n::String
readonly
Name of the country.
-
#payment_means ⇒ Array<KeyDefinition>
readonly
PaymentMeansKeys specific for the regime that extend the original base payment means keys.
-
#preceding ⇒ PrecedingDefinitions
readonly
Configuration details for preceding options.
-
#scenarios ⇒ Array<ScenarioSet>
readonly
Sets of scenario definitions for the regime.
-
#tags ⇒ Array<KeyDefinition>
readonly
Tags that can be applied at the document level to identify additional considerations.
-
#time_zone ⇒ String
readonly
Location name for the country’s central time zone.
-
#zone ⇒ GOBL::L10n::Code
readonly
Specific Locality, region, city, province, county, or similar code inside the country, if needed.
-
#zones ⇒ Array<Zone>
readonly
List of sub-zones inside a country.
Method Summary
Methods included from Extensions::Tax::RegimeHelper::ClassMethods
Methods inherited from Object
Methods inherited from Struct
#as_json, from_data, from_json!, #to_json
Instance Attribute Details
#categories ⇒ Array<Category> (readonly)
List of tax categories.
93 |
# File 'lib/generated/gobl/tax/regime.rb', line 93 property :categories, [Category] |
#charge_types ⇒ Array<KeyDefinition> (readonly)
Charge types specific for the regime and may be validated or used in the UI as suggestions
68 |
# File 'lib/generated/gobl/tax/regime.rb', line 68 property :charge_types, [KeyDefinition] |
#country ⇒ GOBL::L10n::CountryCode (readonly)
Country code for the region
31 |
# File 'lib/generated/gobl/tax/regime.rb', line 31 property :country, GOBL::L10n::CountryCode |
#currency ⇒ GOBL::Currency::Code (readonly)
Currency used by the country.
47 |
# File 'lib/generated/gobl/tax/regime.rb', line 47 property :currency, GOBL::Currency::Code |
#extensions ⇒ Array<KeyDefinition> (readonly)
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.
63 |
# File 'lib/generated/gobl/tax/regime.rb', line 63 property :extensions, [KeyDefinition] |
#identity_types ⇒ Array<KeyDefinition> (readonly)
Identity types specific for the regime and may be validated against.
58 |
# File 'lib/generated/gobl/tax/regime.rb', line 58 property :identity_types, [KeyDefinition] |
#item_keys ⇒ Array<KeyDefinition> (readonly)
ItemKeys specific for the regime that need to be added to ‘org.Item` data in line rows.
78 |
# File 'lib/generated/gobl/tax/regime.rb', line 78 property :item_keys, [KeyDefinition] |
#name ⇒ GOBL::I18n::String (readonly)
Name of the country
19 |
# File 'lib/generated/gobl/tax/regime.rb', line 19 property :name, GOBL::I18n::String |
#payment_means ⇒ Array<KeyDefinition> (readonly)
PaymentMeansKeys specific for the regime that extend the original base payment means keys.
73 |
# File 'lib/generated/gobl/tax/regime.rb', line 73 property :payment_means, [KeyDefinition] |
#preceding ⇒ PrecedingDefinitions (readonly)
Configuration details for preceding options.
88 |
# File 'lib/generated/gobl/tax/regime.rb', line 88 property :preceding, PrecedingDefinitions |
#scenarios ⇒ Array<ScenarioSet> (readonly)
Sets of scenario definitions for the regime.
83 |
# File 'lib/generated/gobl/tax/regime.rb', line 83 property :scenarios, [ScenarioSet] |
#tags ⇒ Array<KeyDefinition> (readonly)
Tags that can be applied at the document level to identify additional considerations.
53 |
# File 'lib/generated/gobl/tax/regime.rb', line 53 property :tags, [KeyDefinition] |
#time_zone ⇒ String (readonly)
Location name for the country’s central time zone. Accepted values from IANA Time Zone Database (iana.org/time-zones).
25 |
# File 'lib/generated/gobl/tax/regime.rb', line 25 property :time_zone, String |
#zone ⇒ GOBL::L10n::Code (readonly)
Specific Locality, region, city, province, county, or similar code inside the country, if needed.
37 |
# File 'lib/generated/gobl/tax/regime.rb', line 37 property :zone, GOBL::L10n::Code |