Class: GOBL::Tax::RateValueDef

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::RateValueDef

Defined in:

lib/generated/gobl/tax/rate_value_def.rb

Overview

RateValueDef contains a percentage rate or fixed amount for a given date range.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL RateValueDef structure

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

Instance Attribute Summary

• #disabled ⇒ Boolean readonly

  When true, this value should no longer be used.

• #ext ⇒ GOBL::Tax::Extensions readonly

  Ext map of keys that can be used to filter to determine if the rate applies.

• #percent ⇒ GOBL::Num::Percentage readonly

  Percent rate that should be applied.

• #since ⇒ GOBL::Cal::Date readonly

  Date from which this value should be applied.

• #surcharge ⇒ GOBL::Num::Percentage readonly

  An additional surcharge to apply.

• #tags ⇒ Array<GOBL::CBC::Key> readonly

  Only apply this rate if one of the tags is present in the invoice.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#disabled ⇒ Boolean (readonly)

When true, this value should no longer be used.

Returns:

• (Boolean)

# File 'lib/generated/gobl/tax/rate_value_def.rb', line 44

property :disabled, Boolean

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

Ext map of keys that can be used to filter to determine if the rate applies.

Returns:

• (GOBL::Tax::Extensions)

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

property :ext, GOBL::Tax::Extensions

#percent ⇒ GOBL::Num::Percentage (readonly)

Percent rate that should be applied

Returns:

• (GOBL::Num::Percentage)

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

property :percent, GOBL::Num::Percentage

#since ⇒ GOBL::Cal::Date (readonly)

Date from which this value should be applied.

Returns:

• (GOBL::Cal::Date)

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

property :since, GOBL::Cal::Date

#surcharge ⇒ GOBL::Num::Percentage (readonly)

An additional surcharge to apply.

Returns:

• (GOBL::Num::Percentage)

# File 'lib/generated/gobl/tax/rate_value_def.rb', line 39

property :surcharge, GOBL::Num::Percentage

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

Only apply this rate if one of the tags is present in the invoice.

Returns:

• (Array<GOBL::CBC::Key>)

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

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