Class: GOBL::Tax::RateDef

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

Overview

RateDef defines a single rate inside a category

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL RateDef structure

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

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_def.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_def.rb', line 35

property :exempt, Boolean

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

Extensions key-value pair that will be copied to the tax combo if this rate is used.

Returns:



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

property :ext, GOBL::Tax::Extensions

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

Key identifies this rate within the system

Returns:



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

property :key, GOBL::CBC::Key

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

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

Returns:



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

property :meta, GOBL::CBC::Meta

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

Human name of the rate

Returns:



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

property :name, GOBL::I18n::String

#values ⇒ Array<RateValueDef> (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_def.rb', line 40

property :values, [RateValueDef]