Class: GOBL::Bill::Charge

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Bill::Charge

Defined in:

lib/gobl/bill/charge.rb

Overview

Charge represents a surchange applied to the complete document independent from the individual lines.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Charge structure

'https://gobl.org/draft-0/bill/invoice#/$defs/Charge'

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary

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

  Amount to apply (calculated if percent present).

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

  Base represents the value used as a base for percent calculations.

• #code ⇒ String readonly

  Code for why was this charge applied?.

• #i ⇒ Integer readonly

  Line number inside the list of discounts (calculated).

• #meta ⇒ GOBL::CBC::Meta readonly

  Additional semi-structured information.

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

  Percentage to apply to the invoice’s Sum.

• #reason ⇒ String readonly

  Text description as to why the charge was applied.

• #ref ⇒ String readonly

  Code to used to refer to the this charge.

• #taxes ⇒ GOBL::Tax::Set readonly

  List of taxes to apply to the charge.

• #uuid ⇒ GOBL::UUID::UUID readonly

  Unique identifying for the discount entry.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Amount to apply (calculated if percent present)

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/charge.rb', line 44

property :amount, GOBL::Num::Amount

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

Base represents the value used as a base for percent calculations. If not already provided, we’ll take the invoices sum before discounts.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/charge.rb', line 34

property :base, GOBL::Num::Amount

#code ⇒ String (readonly)

Code for why was this charge applied?

Returns:

• (String)

# File 'lib/gobl/bill/charge.rb', line 54

property :code, String

#i ⇒ Integer (readonly)

Line number inside the list of discounts (calculated).

Returns:

• (Integer)

# File 'lib/gobl/bill/charge.rb', line 24

property :i, Integer

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

Additional semi-structured information.

Returns:

• (GOBL::CBC::Meta)

# File 'lib/gobl/bill/charge.rb', line 64

property :meta, GOBL::CBC::Meta

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

Percentage to apply to the invoice’s Sum

Returns:

• (GOBL::Num::Percentage)

# File 'lib/gobl/bill/charge.rb', line 39

property :percent, GOBL::Num::Percentage

#reason ⇒ String (readonly)

Text description as to why the charge was applied

Returns:

• (String)

# File 'lib/gobl/bill/charge.rb', line 59

property :reason, String

#ref ⇒ String (readonly)

Code to used to refer to the this charge

Returns:

• (String)

# File 'lib/gobl/bill/charge.rb', line 29

property :ref, String

#taxes ⇒ GOBL::Tax::Set (readonly)

List of taxes to apply to the charge

Returns:

• (GOBL::Tax::Set)

# File 'lib/gobl/bill/charge.rb', line 49

property :taxes, GOBL::Tax::Set

#uuid ⇒ GOBL::UUID::UUID (readonly)

Unique identifying for the discount entry

Returns:

• (GOBL::UUID::UUID)

# File 'lib/gobl/bill/charge.rb', line 19

property :uuid, GOBL::UUID::UUID