Class: GOBL::Tax::Scenario

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::Scenario

Defined in:

lib/generated/gobl/tax/scenario.rb

Overview

Scenario is used to describe a tax scenario of a document based on the combination of document type and tag used.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Scenario structure

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

Instance Attribute Summary

• #codes ⇒ GOBL::CBC::CodeMap readonly

  Codes is used to define additional codes for regime specific situations.

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

  Ext represents a set of tax extensions that should be applied to the document in the appropriate “tax” context.

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

  Extension key that must be present in the document.

• #ext_value ⇒ String readonly

  Extension value that along side the key must be present for a match to happen.

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

  Name of the scenario for further information.

• #note ⇒ GOBL::CBC::Note readonly

  A note to be added to the document if the scenario is applied.

• #tags ⇒ Array<GOBL::CBC::Key> readonly

  Array of tags that have been applied to the document.

• #type ⇒ Array<GOBL::CBC::Key> readonly

  Type of document, if present.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Codes is used to define additional codes for regime specific situations.

Returns:

• (GOBL::CBC::CodeMap)

# File 'lib/generated/gobl/tax/scenario.rb', line 48

property :codes, GOBL::CBC::CodeMap

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

Ext represents a set of tax extensions that should be applied to the document in the appropriate “tax” context.

Returns:

• (GOBL::Tax::Extensions)

# File 'lib/generated/gobl/tax/scenario.rb', line 53

property :ext, GOBL::Tax::Extensions

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

Extension key that must be present in the document.

Returns:

• (GOBL::CBC::Key)

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

property :ext_key, GOBL::CBC::Key

#ext_value ⇒ String (readonly)

Extension value that along side the key must be present for a match to happen. This cannot be used without an ‘ExtKey`. The value will be copied to the note code if needed.

Returns:

• (String)

# File 'lib/generated/gobl/tax/scenario.rb', line 38

property :ext_value, String

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

Name of the scenario for further information.

Returns:

• (GOBL::I18n::String)

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

property :name, GOBL::I18n::String

#note ⇒ GOBL::CBC::Note (readonly)

A note to be added to the document if the scenario is applied.

Returns:

• (GOBL::CBC::Note)

# File 'lib/generated/gobl/tax/scenario.rb', line 43

property :note, GOBL::CBC::Note

#tags ⇒ Array<GOBL::CBC::Key> (readonly)

Array of tags that have been applied to the document.

Returns:

• (Array<GOBL::CBC::Key>)

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

property :tags, [GOBL::CBC::Key]

#type ⇒ Array<GOBL::CBC::Key> (readonly)

Type of document, if present.

Returns:

• (Array<GOBL::CBC::Key>)

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

property :type, [GOBL::CBC::Key]