Class: GOBL::Tax::Category

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

Overview

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

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Category structure

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

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:



19
 
# File 'lib/generated/gobl/tax/category.rb', line 19

property :code, GOBL::CBC::Code

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

Useful description of the category.

Returns:



36
 
# File 'lib/generated/gobl/tax/category.rb', line 36

property :desc, GOBL::I18n::String

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

Extensions 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.

Returns:



56
 
# File 'lib/generated/gobl/tax/category.rb', line 56

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

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

Map defines a set of regime specific code mappings.

Returns:



61
 
# File 'lib/generated/gobl/tax/category.rb', line 61

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:



71
 
# File 'lib/generated/gobl/tax/category.rb', line 71

property :meta, GOBL::CBC::Meta

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

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

Returns:



25
 
# File 'lib/generated/gobl/tax/category.rb', line 25

property :name, GOBL::I18n::String

#rate_required ⇒ Boolean (readonly)

RateRequired when true implies that when a tax combo is defined using this category that one of the rates must be defined.

Returns:

  • (Boolean) 


46
 
# File 'lib/generated/gobl/tax/category.rb', line 46

property :rate_required, Boolean

#rates ⇒ Array<Rate> (readonly)

Specific tax definitions inside this category.

Returns:



51
 
# File 'lib/generated/gobl/tax/category.rb', line 51

property :rates, [Rate]

#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) 


41
 
# File 'lib/generated/gobl/tax/category.rb', line 41

property :retained, Boolean

#sources ⇒ Array<Source> (readonly)

List of sources for the information contained in this category.

Returns:



66
 
# File 'lib/generated/gobl/tax/category.rb', line 66

property :sources, [Source]

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

Human name for the code to use for titles

Returns:



31
 
# File 'lib/generated/gobl/tax/category.rb', line 31

property :title, GOBL::I18n::String