Class: GOBL::Tax::Regime

Inherits:
Object show all
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

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

#categories ⇒ Array<Category> (readonly)

List of tax categories.

Returns:



98
 
# File 'lib/generated/gobl/tax/regime.rb', line 98

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

Returns:



68
 
# File 'lib/generated/gobl/tax/regime.rb', line 68

property :charge_types, [KeyDefinition]

#corrections ⇒ Array<CorrectionDefinition> (readonly)

Configuration details for corrections to be used with correction options.

Returns:



93
 
# File 'lib/generated/gobl/tax/regime.rb', line 93

property :corrections, [CorrectionDefinition]

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

Country code for the region

Returns:



36
 
# File 'lib/generated/gobl/tax/regime.rb', line 36

property :country, GOBL::L10n::CountryCode

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

Currency used by the country.

Returns:



47
 
# File 'lib/generated/gobl/tax/regime.rb', line 47

property :currency, GOBL::Currency::Code

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

Introductory details about the regime.

Returns:



25
 
# File 'lib/generated/gobl/tax/regime.rb', line 25

property :description, GOBL::I18n::String

#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.

Returns:



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.

Returns:



58
 
# File 'lib/generated/gobl/tax/regime.rb', line 58

property :identity_types, [KeyDefinition]

#inbox_keys ⇒ Array<KeyDefinition> (readonly)

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

Returns:



83
 
# File 'lib/generated/gobl/tax/regime.rb', line 83

property :inbox_keys, [KeyDefinition]

#item_keys ⇒ Array<KeyDefinition> (readonly)

ItemKeys specific for the regime that need to be added to ‘org.Item` data in line rows.

Returns:



78
 
# File 'lib/generated/gobl/tax/regime.rb', line 78

property :item_keys, [KeyDefinition]

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

Name of the country

Returns:



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.

Returns:



73
 
# File 'lib/generated/gobl/tax/regime.rb', line 73

property :payment_means, [KeyDefinition]

#scenarios ⇒ Array<ScenarioSet> (readonly)

Sets of scenario definitions for the regime.

Returns:



88
 
# File 'lib/generated/gobl/tax/regime.rb', line 88

property :scenarios, [ScenarioSet]

#tags ⇒ Array<KeyDefinition> (readonly)

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

Returns:



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).

Returns:

  • (String) 


30
 
# File 'lib/generated/gobl/tax/regime.rb', line 30

property :time_zone, String

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

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

Returns:



42
 
# File 'lib/generated/gobl/tax/regime.rb', line 42

property :zone, GOBL::L10n::Code

#zones ⇒ Array<Zone> (readonly)

List of zones to identify specific areas, regions, or provinces inside a country tha may be required for tax purposes.

Returns:



104
 
# File 'lib/generated/gobl/tax/regime.rb', line 104

property :zones, [Zone]