Class: GOBL::Tax::Category

Inherits:
Object show all
Defined in:
lib/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'

Constants included from Hashme

Hashme::Boolean

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)

Returns:



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

property :code, GOBL::CBC::Code

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

Returns:



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

property :desc, GOBL::I18n::String

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

Returns:



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

property :name, GOBL::I18n::String

#rates ⇒ Array<Rate> (readonly)

Specific tax definitions inside this category.

Returns:



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

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:



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

property :retained, Boolean