Class: GOBL::Currency::Amount

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Currency::Amount

Defined in:

lib/generated/gobl/currency/amount.rb

Overview

An Amount represents a monetary value in a specific currency.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Amount structure

'https://gobl.org/draft-0/currency/amount'

Instance Attribute Summary

• #currency ⇒ GOBL::Currency::Code readonly

  Code defines the currency for this amount.

• #label ⇒ String readonly

  Label allows for additional information to be added to the currency Amount that may be useful.

• #value ⇒ GOBL::Num::Amount readonly

  Value is the amount in the currency.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#currency ⇒ GOBL::Currency::Code (readonly)

Code defines the currency for this amount.

Returns:

• (GOBL::Currency::Code)

# File 'lib/generated/gobl/currency/amount.rb', line 23

property :currency, GOBL::Currency::Code

#label ⇒ String (readonly)

Label allows for additional information to be added to the currency Amount that may be useful.

Returns:

• (String)

# File 'lib/generated/gobl/currency/amount.rb', line 18

property :label, String

#value ⇒ GOBL::Num::Amount (readonly)

Value is the amount in the currency.

Returns:

• (GOBL::Num::Amount)

# File 'lib/generated/gobl/currency/amount.rb', line 29

property :value, GOBL::Num::Amount