Class: GOBL::Tax::Scenario

Inherits:
Object show all
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 collapse

SCHEMA_ID =

The Schema ID of the GOBL Scenario structure

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

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

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

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

Returns:



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

property :codes, GOBL::CBC::CodeMap

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

Any additional local meta data that may be useful in integrations.

Returns:



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

property :meta, GOBL::CBC::Meta

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

Name of the scenario for further information.

Returns:



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

property :name, GOBL::I18n::String

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

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

Returns:



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

property :note, GOBL::CBC::Note

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

Tag that was applied to the document

Returns:



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

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

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

Type of document, if present.

Returns:



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

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