Class: GOBL::Tax::CategoryDef

Inherits:
Object show all
Defined in:
lib/generated/gobl/tax/category_def.rb

Overview

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

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL CategoryDef structure

'https://gobl.org/draft-0/tax/regime-def#/$defs/CategoryDef'

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#code ⇒ GOBL::CBC::Code (readonly)

Code to be used in documents

Returns:



18
 
# File 'lib/generated/gobl/tax/category_def.rb', line 18

property :code, GOBL::CBC::Code

#desc ⇒ GOBL::I18n::String (readonly)

Useful description of the category.

Returns:



35
 
# File 'lib/generated/gobl/tax/category_def.rb', line 35

property :desc, GOBL::I18n::String

#ext ⇒ GOBL::Tax::Extensions (readonly)

Extension key-value pairs that will be copied to the tax combo if this category is used.

Returns:



75
 
# File 'lib/generated/gobl/tax/category_def.rb', line 75

property :ext, GOBL::Tax::Extensions

#extensions ⇒ Array<GOBL::CBC::Key> (readonly)

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.

Returns:



60
 
# File 'lib/generated/gobl/tax/category_def.rb', line 60

property :extensions, [GOBL::CBC::Key]

#informative ⇒ Boolean (readonly)

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.

Returns:

  • (Boolean) 


45
 
# File 'lib/generated/gobl/tax/category_def.rb', line 45

property :informative, Boolean

#keys ⇒ Array<KeyDef> (readonly)

Specific tax definitions inside this category.

Returns:



50
 
# File 'lib/generated/gobl/tax/category_def.rb', line 50

property :keys, [KeyDef]

#map ⇒ GOBL::CBC::CodeMap (readonly)

Map defines a set of regime specific code mappings.

Returns:



65
 
# File 'lib/generated/gobl/tax/category_def.rb', line 65

property :map, GOBL::CBC::CodeMap

#meta ⇒ GOBL::CBC::Meta (readonly)

Meta contains additional information about the category that is relevant for local frequently used formats.

Returns:



80
 
# File 'lib/generated/gobl/tax/category_def.rb', line 80

property :meta, GOBL::CBC::Meta

#name ⇒ GOBL::I18n::String (readonly)

Short name of the category to be used instead of code in output

Returns:



24
 
# File 'lib/generated/gobl/tax/category_def.rb', line 24

property :name, GOBL::I18n::String

#rates ⇒ Array<RateDef> (readonly)

Rates defines the set of rates that can be used with this category.

Returns:



55
 
# File 'lib/generated/gobl/tax/category_def.rb', line 55

property :rates, [RateDef]

#retained ⇒ Boolean (readonly)

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.

Returns:

  • (Boolean) 


40
 
# File 'lib/generated/gobl/tax/category_def.rb', line 40

property :retained, Boolean

#sources ⇒ Array<GOBL::CBC::Source> (readonly)

List of sources for the information contained in this category.

Returns:



70
 
# File 'lib/generated/gobl/tax/category_def.rb', line 70

property :sources, [GOBL::CBC::Source]

#title ⇒ GOBL::I18n::String (readonly)

Human name for the code to use for titles

Returns:



30
 
# File 'lib/generated/gobl/tax/category_def.rb', line 30

property :title, GOBL::I18n::String