Class: GOBL::Tax::AddonDef

Inherits:
Object show all
Extended by:
Extensions::Tax::AddonHelper::ClassMethods
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 included from Extensions::Tax::AddonHelper::ClassMethods

fetch

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:



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

property :corrections, CorrectionSet

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

Description of the add-on

Returns:



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

property :description, GOBL::I18n::String

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

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

Returns:



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

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

#identities ⇒ Array<GOBL::CBC::Definition> (readonly)

Identities that are specific for the add-on and may be validated against or used during conversion processes.

Returns:



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

property :identities, [GOBL::CBC::Definition]

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

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

Returns:



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

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

#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:



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

property :name, GOBL::I18n::String

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

Requires defines any additional addons that this one depends on to operate correctly.

Returns:



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

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

#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:



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

property :scenarios, [ScenarioSet]

#sources ⇒ Array<GOBL::CBC::Source> (readonly)

Sources is a list of sources that are used to provide the data for the add-on.

Returns:



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

property :sources, [GOBL::CBC::Source]

#tags ⇒ Array<TagSet> (readonly)

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

Returns:



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

property :tags, [TagSet]