Category

Category contains the definition of a general type of tax inside a region.

Schema ID

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

Title	Property	Type	Req.	Description
Code	`code`	cbc.Code	true	Code to be used in documents
Name	`name`	i18n.String	true	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.
Rate Required	`rate_required`	boolean		RateRequired when true implies that when a tax combo is defined using this category that one of the rate’s keys must be defined. This is normally needed for regimes that categorize taxes in local document formats as opposed to grouping by percentage values.
Rates	`rates`	array of tax.Rate		Specific tax definitions inside 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 tax.Source		List of sources for the information contained in this category.
Meta	`meta`	cbc.Meta		Meta contains additional information about the category that is relevant for local frequently used formats.