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 | Description offering more details about when the key should be used. |
| Meta | meta | cbc.Meta | Meta defines any additional details that may be useful or associated with the key. |
| 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 | Values defines the possible values associated with the key, which themselves will either be keys or codes depending on the context. |
| Pattern | pattern | string | Pattern is used to validate the key value instead of using a fixed value from the code or key definitions. |
| Code Map | map | cbc.CodeMap | Map helps map local keys to specific codes, useful for converting the described key into a local code. |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
| Definition |
| GOBL-CBC-DEFINITION-02Definition must have either a key or a code, and not both |
name |
| GOBL-CBC-DEFINITION-01Name is required |
pattern |
| GOBL-CBC-DEFINITION-03Pattern must be a valid regular expression |