Class: GOBL::Tax::ScenarioNote

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::ScenarioNote

Defined in:

lib/generated/gobl/tax/scenario_note.rb

Overview

ScenarioNote represents the structure of the note that needs to be added to the document.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL ScenarioNote structure

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

Instance Attribute Summary

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

  Code used for additional data that may be required to identify the note.

• #ext ⇒ GOBL::Tax::Extensions readonly

  Extension data.

• #key ⇒ GOBL::CBC::Key readonly

  Key specifying subject of the text.

• #src ⇒ GOBL::CBC::Key readonly

  Source of this note, especially useful when auto-generated.

• #text ⇒ String readonly

  The contents of the note.

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 used for additional data that may be required to identify the note.

Returns:

• (GOBL::CBC::Code)

# File 'lib/generated/gobl/tax/scenario_note.rb', line 23

property :code, GOBL::CBC::Code

#ext ⇒ GOBL::Tax::Extensions (readonly)

Extension data

Returns:

• (GOBL::Tax::Extensions)

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

property :ext, GOBL::Tax::Extensions

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

Key specifying subject of the text

Returns:

• (GOBL::CBC::Key)

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

property :key, GOBL::CBC::Key

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

Source of this note, especially useful when auto-generated.

Returns:

• (GOBL::CBC::Key)

# File 'lib/generated/gobl/tax/scenario_note.rb', line 28

property :src, GOBL::CBC::Key

#text ⇒ String (readonly)

The contents of the note

Returns:

• (String)

# File 'lib/generated/gobl/tax/scenario_note.rb', line 33

property :text, String