Tax
Scenario
Tax
Scenario
Scenario is used to describe a tax scenario of a document based on the combination of document type and tag used.
Schema ID
https://gobl.org/draft-0/tax/regime-def#/$defs/Scenario
Properties
| Title | Property | Type | Req. | Description |
|---|---|---|---|---|
| Name | name | i18n.String | Name of the scenario for further information. | |
| Type | type | array of cbc.Key | Type of document, if present. | |
| Tags | tags | array of cbc.Key | Array of tags that have been applied to the document. | |
| Extension Key | ext_key | cbc.Key | Extension key that must be present in the document. | |
| Extension Value | ext_value | string | Extension value that along side the key must be present for a match to happen. This cannot be used without an ExtKey. The value will be copied to the note code if needed. | |
| Note | note | cbc.Note | A note to be added to the document if the scenario is applied. | |
| Codes | codes | cbc.CodeMap | Codes is used to define additional codes for regime specific situations. | |
| Extensions | ext | tax.Extensions | Ext represents a set of tax extensions that should be applied to the document in the appropriate “tax” context. |