Definition - GOBL

Definition defines properties of a key, code, or other value that has a specific meaning or utility.

Schema ID

https://gobl.org/draft-0/cbc/definition

Properties

Title	Property	Type	Description
Key	`key`	cbc.Key	Key being defined.
Code	`code`	cbc.Code	Code this definition represents.
Name	`name`	i18n.String	Short name for the key.
Description	`desc`	i18n.String	More details about when the key should be used.
Meta	`meta`	cbc.Meta	Any additional details associated with the key.
Usage	`usage`	cbc.Usage	Context in which the definition may be used, such as the addons or regimes that offer it, and where it can be placed inside a document.
Sources	`sources`	array of cbc.Source	Where the information was sourced from and where it can be reviewed for updates in the future.
Values	`values`	array of cbc.Definition	Possible values associated with the key, which are themselves either keys or codes depending on the context.
Pattern	`pattern`	string	Regular expression used to validate the value instead of a fixed value from the code or key definitions.
Code Map	`map`	cbc.CodeMap	Maps local keys to specific codes, useful for converting the described key into a local code.

Validation Rules

Field	Test	Validation Code / Message
Definition	String(Code) != ” \|\| string(Key) != ”	`GOBL-CBC-DEFINITION-02` Definition must have either a key or a code, and not both
`name`	Present	`GOBL-CBC-DEFINITION-01` Name is required
`pattern`	Is a regexp	`GOBL-CBC-DEFINITION-03` Pattern must be a valid regular expression