Class: GOBL::Tax::Identity

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

Overview

Identity stores the details required to identify an entity for tax purposes.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Identity structure

'https://gobl.org/draft-0/tax/identity'

Constants included from Hashme

Hashme::Boolean

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 ⇒ String (readonly)

Normalized code shown on the original identity document.

Returns:

  • (String) 


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

property :code, String

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

ISO country code for Where the tax identity was issued.

Returns:



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

property :country, GOBL::L10n::CountryCode

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

Additional details that may be required.

Returns:



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

property :meta, GOBL::CBC::Meta

#source ⇒ SourceKey (readonly)

What is the source document of the tax identity.

Returns:



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

property :source, SourceKey

#uuid ⇒ GOBL::UUID::UUID (readonly)

Unique universal identity code for this tax identity.

Returns:



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

property :uuid, GOBL::UUID::UUID

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

Where inside the country the tax identity holder is based for tax purposes like a village, town, district, city, county, state or province. For some areas, this could be a regular post or zip code. See the regime packages for specific validation rules.

Returns:



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

property :zone, GOBL::L10n::Code