Class: GOBL::Tax::Identity

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

Overview

Identity stores the details required to identify an entity for tax purposes in a specific country.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Identity structure

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

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::CBC::Code (readonly)

Normalized code shown on the original identity document.

Returns:



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

property :code, GOBL::CBC::Code

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

ISO country code for Where the tax identity was issued.

Returns:



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

property :country, GOBL::L10n::CountryCode

#type ⇒ GOBL::CBC::Key (readonly)

Type is set according to the requirements of each regime, some have a single tax document type code, others require a choice to be made. Deprecated: Tax Identities should only be used for VAT or similar codes for companies. Use the identities array for other types of identification.

Returns:



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

property :type, GOBL::CBC::Key

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

Zone identifies a sub-locality within a country. Deprecated: Removed 2024-03-14 in favour of using tax tags and extensions with local data when required. Maintained here to support data migration.

Returns:



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

property :zone, GOBL::L10n::Code