Class: GOBL::Tax::Zone

Inherits:
Object show all
Defined in:
lib/generated/gobl/tax/zone.rb

Overview

Zone represents an area inside a country, like a province or a state, which shares the basic definitions of the country, but may vary in some validation rules.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Zone structure

'https://gobl.org/draft-0/tax/regime#/$defs/Zone'

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Unique zone code.

Returns:



19
 
# File 'lib/generated/gobl/tax/zone.rb', line 19

property :code, GOBL::L10n::Code

#codes ⇒ GOBL::CBC::CodeMap (readonly)

Codes defines a set of regime specific code mappings.

Returns:



40
 
# File 'lib/generated/gobl/tax/zone.rb', line 40

property :codes, GOBL::CBC::CodeMap

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

Village, town, district, or city name which should coincide with address data.

Returns:



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

property :locality, GOBL::I18n::String

#meta ⇒ GOBL::CBC::Meta (readonly)

Any additional information

Returns:



45
 
# File 'lib/generated/gobl/tax/zone.rb', line 45

property :meta, GOBL::CBC::Meta

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

Name of the zone to be use if a locality or region is not applicable.

Returns:



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

property :name, GOBL::I18n::String

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

Province, county, or state which should match address data.

Returns:



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

property :region, GOBL::I18n::String