Class: GOBL::Tax::AddonDef

Inherits:
Object show all
Defined in:
lib/generated/gobl/tax/addon_def.rb

Overview

AddonDef is an interface that defines the methods that a tax add-on must implement.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL AddonDef structure

'https://gobl.org/draft-0/tax/addon-def'

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

#corrections ⇒ CorrectionSet (readonly)

Corrections is used to provide a map of correction definitions that are supported by the add-on.

Returns:



57
 
# File 'lib/generated/gobl/tax/addon_def.rb', line 57

property :corrections, CorrectionSet

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

Description of the add-on

Returns:



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

property :description, GOBL::I18n::String

#extensions ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

Extensions defines the list of extensions that are associated with an add-on.

Returns:



35
 
# File 'lib/generated/gobl/tax/addon_def.rb', line 35

property :extensions, [GOBL::CBC::KeyDefinition]

#inboxes ⇒ Array<GOBL::CBC::KeyDefinition> (readonly)

Inboxes is a list of keys that are used to identify where copies of documents can be sent.

Returns:



52
 
# File 'lib/generated/gobl/tax/addon_def.rb', line 52

property :inboxes, [GOBL::CBC::KeyDefinition]

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

Key that defines how to uniquely idenitfy the add-on.

Returns:



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

property :key, GOBL::CBC::Key

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

Name of the add-on

Returns:



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

property :name, GOBL::I18n::String

#scenarios ⇒ Array<ScenarioSet> (readonly)

Scenarios are applied to documents after normalization and before validation to ensure that form specific extensions have been added to the document.

Returns:



46
 
# File 'lib/generated/gobl/tax/addon_def.rb', line 46

property :scenarios, [ScenarioSet]

#tags ⇒ Array<TagSet> (readonly)

Tags is slice of tag sets that define what can be assigned to each document schema.

Returns:



41
 
# File 'lib/generated/gobl/tax/addon_def.rb', line 41

property :tags, [TagSet]