Class: GOBL::Tax::CodeDefinition

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::CodeDefinition

Defined in:

lib/generated/gobl/tax/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/tax/regime#/$defs/CodeDefinition'

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.

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

Returns:

• (GOBL::CBC::Code)

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

property :code, GOBL::CBC::Code

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

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

Returns:

• (GOBL::I18n::String)

# File 'lib/generated/gobl/tax/code_definition.rb', line 30

property :desc, GOBL::I18n::String

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

Short name for the code, if relevant.

Returns:

• (GOBL::I18n::String)

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

property :name, GOBL::I18n::String