KeyDefinition defines properties of a key that is specific for a regime.

Schema ID

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

Properties

TitlePropertyTypeReq.Description
Keykeycbc.KeytrueActual key value.
Namenamei18n.StringtrueShort name for the key.
Descriptiondesci18n.StringDescription offering more details about when the key should be used.
Codescodesarray of tax.CodeDefinitionCodes describes the list of codes that can be used alongside the Key, for example with identities.
Keyskeysarray of tax.KeyDefinitionKeys is used instead of codes to define a further sub-set of keys that can be used alongside this one.
Mapmapcbc.CodeMapMap helps map local keys to specific codes, useful for converting the described key into a local code.