Schema ID
https://gobl.org/draft-0/tax/regime-def#/$defs/CategoryDef
Properties
| Title | Property | Type | Description |
|---|---|---|---|
| Code | code | cbc.Code | Code to be used in documents |
| Name | name | i18n.String | Short name of the category to be used instead of code in output |
| Title | title | i18n.String | Human name for the code to use for titles |
| Description | desc | i18n.String | Useful description of the category. |
| Retained | retained | boolean | Retained when true implies that the tax amount will be retained by the buyer on behalf of the supplier, and thus subtracted from the invoice taxable base total. Typically used for taxes related to income. |
| Informative | informative | boolean | Informative when true implies that the tax amount will be calculated and reported but will not affect the invoice totals. Typically used for taxes that are embedded in the base amount or don’t impact the final payable amount. |
| Keys | keys | array of tax.KeyDef | Specific tax definitions inside this category. |
| Rates | rates | array of tax.RateDef | Rates defines the set of rates that can be used with this category. |
| Extensions | extensions | array of cbc.Key | Extensions defines a list of extension keys that may be used or required as an alternative or alongside choosing a rate for the tax category. Every key must be defined in the Regime’s extensions table. |
| Map | map | cbc.CodeMap | Map defines a set of regime specific code mappings. |
| Sources | sources | array of cbc.Source | List of sources for the information contained in this category and most importantly, an official source where the tax rates can be reviewed and updated in the future. |
| Extensions | ext | tax.Extensions | Extension key-value pairs that will be copied to the tax combo if this category is used. |
| Meta | meta | cbc.Meta | Meta contains additional information about the category that is relevant for local frequently used formats. |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
| CategoryDef |
| GOBL-TAX-CATEGORYDEF-04Category def cannot be retained and informative |
code |
| GOBL-TAX-CATEGORYDEF-01Category def code is required |
name |
| GOBL-TAX-CATEGORYDEF-02Category def name is required |
title |
| GOBL-TAX-CATEGORYDEF-03Category def title is required |