Class: GOBL::CBC::CodeDefinition

Inherits:

Object

• Object
• Struct
• Object
• GOBL::CBC::CodeDefinition

Defined in:

lib/generated/gobl/cbc/code_definition.rb

Overview

CodeDefinition describes a specific code and how it maps to a human name and description if appropriate.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL CodeDefinition structure

'https://gobl.org/draft-0/cbc/code-definition'

Instance Attribute Summary

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

  Code for which the definition is for.

• #desc ⇒ GOBL::I18n::String readonly

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

• #meta ⇒ GOBL::CBC::Meta readonly

  Meta defines any additional details that may be useful or associated with the code.

• #name ⇒ GOBL::I18n::String readonly

  Short name for the code, if relevant.

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)

Code for which the definition is for.

# File 'lib/generated/gobl/cbc/code_definition.rb', line 18

property :code, GOBL::CBC::Code

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

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

# File 'lib/generated/gobl/cbc/code_definition.rb', line 29

property :desc, GOBL::I18n::String

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

Meta defines any additional details that may be useful or associated with the code.

# File 'lib/generated/gobl/cbc/code_definition.rb', line 34

property :meta, GOBL::CBC::Meta

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

Short name for the code, if relevant.

# File 'lib/generated/gobl/cbc/code_definition.rb', line 24

property :name, GOBL::I18n::String