Class: GOBL::Tax::RateValue

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::RateValue

Defined in:

lib/generated/gobl/tax/rate_value.rb

Overview

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

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL RateValue structure

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

Instance Attribute Summary

• #disabled ⇒ Boolean readonly

  When true, this value should no longer be used.

• #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.

• #zones ⇒ Array<GOBL::L10n::Code> readonly

  Only use this value if one of the zones matches.

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

property :disabled, Boolean

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

Percent rate that should be applied

Returns:

• (GOBL::Num::Percentage)

# File 'lib/generated/gobl/tax/rate_value.rb', line 29

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

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

property :surcharge, GOBL::Num::Percentage

#zones ⇒ Array<GOBL::L10n::Code> (readonly)

Only use this value if one of the zones matches.

Returns:

• (Array<GOBL::L10n::Code>)

# File 'lib/generated/gobl/tax/rate_value.rb', line 19

property :zones, [GOBL::L10n::Code]