Class: GOBL::Tax::Identity

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::Identity

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

SCHEMA_ID =

The Schema ID of the GOBL Identity structure

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

Instance Attribute Summary

• #code ⇒ GOBL::CBC::Code readonly

  Normalized code shown on the original identity document.

• #country ⇒ GOBL::L10n::TaxCountryCode readonly

  Tax country code for Where the tax identity was issued.

• #scheme ⇒ GOBL::CBC::Code readonly

  Scheme is an optional field that may be used to override the tax regime’s default tax scheme.

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

• #zone ⇒ GOBL::L10n::Code readonly

  Zone identifies a sub-locality within a country.

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:

• (GOBL::CBC::Code)

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

property :code, GOBL::CBC::Code

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

Tax country code for Where the tax identity was issued.

Returns:

• (GOBL::L10n::TaxCountryCode)

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

property :country, GOBL::L10n::TaxCountryCode

#scheme ⇒ GOBL::CBC::Code (readonly)

Scheme is an optional field that may be used to override the tax regime’s default tax scheme. Many electronic formats such as UBL or CII define an equivalent field. Examples: ‘VAT`, `GST`, `ST`, etc.

Returns:

• (GOBL::CBC::Code)

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

property :scheme, GOBL::CBC::Code

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

• (GOBL::CBC::Key)

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

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:

• (GOBL::L10n::Code)

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

property :zone, GOBL::L10n::Code