Class: GOBL::Tax::Rate

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

Overview

Rate defines a single rate inside a category

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Rate structure

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

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

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

Useful description of the rate.

Returns:



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

property :desc, GOBL::I18n::String

#exempt ⇒ Boolean (readonly)

Exempt when true implies that the rate when used in a tax Combo should not define a percent value.

Returns:

  • (Boolean) 


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

property :exempt, Boolean

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

Extensions defines a list of keys for codes that can or must be associated with the tax rate for it to be validated. Every key must be defined in the Regime’s extensions.

Returns:



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

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

#key ⇒ GOBL::CBC::Key (readonly)

Key identifies this rate within the system

Returns:



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

property :key, GOBL::CBC::Key

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

Map is used to associate specific codes with the chosen rate.

Returns:



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

property :map, GOBL::CBC::CodeMap

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

Meta contains additional information about the rate that is relevant for local frequently used implementations.

Returns:



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

property :meta, GOBL::CBC::Meta

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

Human name of the rate

Returns:



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

property :name, GOBL::I18n::String

#values ⇒ Array<RateValue> (readonly)

Values contains a list of Value objects that contain the current and historical percentage values for the rate and additional filters. Order is important, newer values should come before older values.

Returns:



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

property :values, [RateValue]