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

Schema ID

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

Properties

TitlePropertyTypeDescription
Keykeycbc.KeyKey that defines how to uniquely identify the add-on.
Requiresrequiresarray of cbc.KeyRequires defines any additional addons that this one depends on to operate correctly.
Namenamei18n.StringName of the add-on
Descriptiondescriptioni18n.StringDescription of the add-on
Sourcessourcesarray of cbc.SourceSources is a list of sources that are used to provide the data for the add-on.
Extensionsextensionsarray of cbc.DefinitionExtensions defines the list of extensions that are associated with an add-on.
Tagstagsarray of tax.TagSetTags is slice of tag sets that define what can be assigned to each document schema.
Scenariosscenariosarray of tax.ScenarioSetScenarios are applied to documents after normalization and before validation to ensure that form specific extensions have been added to the document.
Identitiesidentitiesarray of cbc.DefinitionIdentities that are specific for the add-on and may be validated against or used during conversion processes.
Inboxesinboxesarray of cbc.DefinitionInboxes is a list of keys that are used to identify where copies of documents can be sent.
Correctionscorrectionstax.CorrectionSetCorrections is used to provide a map of correction definitions that are supported by the add-on.

Validation Rules

FieldTestValidation Code / Message
key
  • Present
GOBL-TAX-ADDONDEF-01
Addon must have a key
name
  • Present
GOBL-TAX-ADDONDEF-02
Addon must have a name