Class: GOBL::CBC::Note

Inherits:
Object show all
Defined in:
lib/generated/gobl/cbc/note.rb

Overview

Note represents a free text of additional information that may be added to a document.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Note structure

'https://gobl.org/draft-0/cbc/note'
KEY_ENUM =

Enumeration of possible values for #key with their corresponding descriptions

{
  'goods' => 'Goods Description',
  'payment' => 'Terms of Payment',
  'legal' => 'Legal or regulatory information',
  'dangerous-goods' => 'Dangerous goods additional information',
  'ack' => 'Acknowledgement Description',
  'rate' => 'Rate additional information',
  'reason' => 'Explanation of something relevant to the document',
  'dispute' => 'Details on a dispute.',
  'customer' => 'Customer remarks',
  'glossary' => 'Glossary of terms',
  'customs' => 'Customs declaration information',
  'general' => 'General information',
  'handling' => 'Handling instructions',
  'packaging' => 'Packaging information',
  'loading' => 'Loading instructions',
  'price' => 'Price conditions',
  'priority' => 'Priority information',
  'regulatory' => 'Regulatory information',
  'safety' => 'Safety instructions',
  'ship-line' => 'Ship line',
  'supplier' => 'Supplier remarks',
  'transport' => 'Transportation information',
  'delivery' => 'Delivery information',
  'quarantine' => 'Quarantine information',
  'tax' => 'Tax declaration'
}.freeze

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

#code ⇒ String (readonly)

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

Returns:

  • (String) 


53
 
# File 'lib/generated/gobl/cbc/note.rb', line 53

property :code, String

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

Key specifying subject of the text

Returns:



47
 
# File 'lib/generated/gobl/cbc/note.rb', line 47

property :key, GOBL::CBC::Key

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

Additional information about the note

Returns:



69
 
# File 'lib/generated/gobl/cbc/note.rb', line 69

property :meta, GOBL::CBC::Meta

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

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

Returns:



58
 
# File 'lib/generated/gobl/cbc/note.rb', line 58

property :src, GOBL::CBC::Key

#text ⇒ String (readonly)

The contents of the note

Returns:

  • (String) 


63
 
# File 'lib/generated/gobl/cbc/note.rb', line 63

property :text, String