Class: GOBL::Tax::KeyDefinition

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

Overview

KeyDefinition defines properties of a key that is specific for a regime.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL KeyDefinition structure

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

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

#codes ⇒ Array<CodeDefinition> (readonly)

Codes describes the list of codes that can be used alongside the Key, for example with identities.

Returns:



36
 
# File 'lib/generated/gobl/tax/key_definition.rb', line 36

property :codes, [CodeDefinition]

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

Description offering more details about when the key should be used.

Returns:



31
 
# File 'lib/generated/gobl/tax/key_definition.rb', line 31

property :desc, GOBL::I18n::String

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

Actual key value.

Returns:



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

property :key, GOBL::CBC::Key

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

Map helps map local keys to specific codes, useful for converting the described key into a local code.

Returns:



41
 
# File 'lib/generated/gobl/tax/key_definition.rb', line 41

property :map, GOBL::CBC::CodeMap

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

Short name for the key.

Returns:



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

property :name, GOBL::I18n::String