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

Schema ID

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

Properties

TitlePropertyTypeReq.Description
Codecodecbc.CodetrueCode to be used in documents
Namenamei18n.StringtrueShort name of the category to be used instead of code in output
Titletitlei18n.StringHuman name for the code to use for titles
Descriptiondesci18n.StringUseful description of the category.
RetainedretainedbooleanRetained 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 Requiredrate_requiredbooleanRateRequired when true implies that when a tax combo is defined using this category that one of the rates must be defined.
Ratesratesarray of tax.RateSpecific tax definitions inside this category.
Extensionsextensionsarray of cbc.KeyExtensions defines a list of keys for codes to use as an alternative to choosing a rate for the tax category. Every key must be defined in the Regime’s extensions table.
Mapmapcbc.CodeMapMap defines a set of regime specific code mappings.
Sourcessourcesarray of tax.SourceList of sources for the information contained in this category.
Metametacbc.MetaMeta contains additional information about the category that is relevant for local frequently used formats.