Class: GOBL::Tax::KeyDef

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::KeyDef

Defined in:

lib/generated/gobl/tax/key_def.rb

Overview

KeyDef defines a key that can be used inside a tax category.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL KeyDef structure

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

Instance Attribute Summary

• #desc ⇒ GOBL::I18n::String readonly

  Useful description of the rate.

• #key ⇒ GOBL::CBC::Key readonly

  Key identifies this rate within the system.

• #name ⇒ GOBL::I18n::String readonly

  Human name of the rate set.

• #no_percent ⇒ Boolean readonly

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

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:

• (GOBL::I18n::String)

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

property :desc, GOBL::I18n::String

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

Key identifies this rate within the system

Returns:

• (GOBL::CBC::Key)

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

property :key, GOBL::CBC::Key

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

Human name of the rate set

Returns:

• (GOBL::I18n::String)

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

property :name, GOBL::I18n::String

#no_percent ⇒ Boolean (readonly)

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

Returns:

• (Boolean)

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

property :no_percent, Boolean