Class: GOBL::Org::Identity

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

Overview

Identity is used to define a code for a specific context.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Identity structure

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

The actual value of the identity code.

Returns:



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

property :code, GOBL::CBC::Code

#description ⇒ String (readonly)

Description adds details about what the code could mean or imply

Returns:

  • (String) 


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

property :description, String

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

Uniquely classify this identity using a key instead of a code.

Returns:



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

property :key, GOBL::CBC::Key

#label ⇒ String (readonly)

Optional label useful for non-standard identities to give a bit more context.

Returns:

  • (String) 


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

property :label, String

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

The type of Code being represented and usually specific for a particular context, country, or tax regime, and cannot be used alongside the key.

Returns:



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

property :type, GOBL::CBC::Code

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

Unique identity for this identity object.

Returns:



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

property :uuid, GOBL::UUID::UUID