Class: GOBL::Tax::RegimeDef

Inherits:
Object show all
Extended by:
Extensions::Tax::RegimeHelper::ClassMethods
Defined in:
lib/generated/gobl/tax/regime_def.rb

Overview

RegimeDef 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 RegimeDef structure

'https://gobl.org/draft-0/tax/regime-def'

Instance Attribute Summary collapse

Method Summary

Methods included from Extensions::Tax::RegimeHelper::ClassMethods

fetch

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#alt_country_codes ⇒ Array<GOBL::L10n::Code> (readonly)

Alternative localization codes that may be used to identify the tax regime in specific circumstances.

Returns:



41
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 41

property :alt_country_codes, [GOBL::L10n::Code]

#calculator_rounding_rule ⇒ String (readonly)

Rounding rule to use when calculating the tax totals, default is always ‘sum-then-round`.

Returns:

  • (String) 


57
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 57

property :calculator_rounding_rule, String

#categories ⇒ Array<CategoryDef> (readonly)

List of tax categories.

Returns:



106
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 106

property :categories, [CategoryDef]

#charge_keys ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

Charge keys specific for the regime and may be validated or used in the UI as suggestions

Returns:



82
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 82

property :charge_keys, [GOBL::CBC::KeyDefinition]

#corrections ⇒ CorrectionSet (readonly)

Configuration details for corrections to be used with correction options.

Returns:



101
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 101

property :corrections, CorrectionSet

#country ⇒ GOBL::L10n::TaxCountryCode (readonly)

Country code for the region

Returns:



35
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 35

property :country, GOBL::L10n::TaxCountryCode

#currency ⇒ GOBL::Currency::Code (readonly)

Currency used by the country.

Returns:



51
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 51

property :currency, GOBL::Currency::Code

#description ⇒ GOBL::I18n::String (readonly)

Introductory details about the regime.

Returns:



24
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 24

property :description, GOBL::I18n::String

#extensions ⇒ Array<GOBL::CBC::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.

Returns:



67
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 67

property :extensions, [GOBL::CBC::KeyDefinition]

#identity_keys ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

Identity keys used in addition to regular tax identities and specific for the regime that may be validated against.

Returns:



77
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 77

property :identity_keys, [GOBL::CBC::KeyDefinition]

#inbox_keys ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

InboxKeys specific to the regime that can be used to identify where a document should be forwarded to.

Returns:



92
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 92

property :inbox_keys, [GOBL::CBC::KeyDefinition]

#name ⇒ GOBL::I18n::String (readonly)

Name of the tax regime.

Returns:



18
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 18

property :name, GOBL::I18n::String

#payment_means_keys ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

PaymentMeansKeys specific for the regime that extend the original base payment means keys.

Returns:



87
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 87

property :payment_means_keys, [GOBL::CBC::KeyDefinition]

#scenarios ⇒ Array<ScenarioSet> (readonly)

Returns:



96
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 96

property :scenarios, [ScenarioSet]

#tags ⇒ Array<TagSet> (readonly)

Tags that can be applied at the document level to identify additional considerations.

Returns:



62
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 62

property :tags, [TagSet]

#tax_identity_type_keys ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

Tax Identity types specific for the regime and may be validated against.

Returns:



72
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 72

property :tax_identity_type_keys, [GOBL::CBC::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).

Returns:

  • (String) 


29
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 29

property :time_zone, String

#zone ⇒ GOBL::L10n::Code (readonly)

Specific Locality, region, city, province, county, or similar code inside the country, if needed.

Returns:



46
 
# File 'lib/generated/gobl/tax/regime_def.rb', line 46

property :zone, GOBL::L10n::Code