Class: GOBL::Bill::Totals

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Bill::Totals

Defined in:

lib/gobl/bill/totals.rb

Overview

Totals contains the summaries of all calculations for the invoice.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Totals structure

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

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary

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

  Total amount already paid in advance.

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

  Sum of all document level charges.

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

  Sum of all document level discounts.

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

  How much actually needs to be paid now.

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

  Total paid in outlays that need to be reimbursed.

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

  Total amount to be paid after applying taxes and outlays.

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

  Sum of all line item sums.

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

  Total amount of tax to apply to the invoice.

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

  If prices include tax, this is the total tax included in the price.

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

  Summary of all the taxes included in the invoice.

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

  Sum of all line sums minus the discounts, plus the charges, without tax.

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

  Grand total after all taxes have been applied.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Total amount already paid in advance.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 73

property :advance, GOBL::Num::Amount

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

Sum of all document level charges

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 30

property :charge, GOBL::Num::Amount

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

Sum of all document level discounts

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 25

property :discount, GOBL::Num::Amount

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

How much actually needs to be paid now.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 78

property :due, GOBL::Num::Amount

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

Total paid in outlays that need to be reimbursed

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 62

property :outlays, GOBL::Num::Amount

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

Total amount to be paid after applying taxes and outlays.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 67

property :payable, GOBL::Num::Amount

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

Sum of all line item sums

Returns:

• (GOBL::Num::Amount)

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

property :sum, GOBL::Num::Amount

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

Total amount of tax to apply to the invoice.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 51

property :tax, GOBL::Num::Amount

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

If prices include tax, this is the total tax included in the price.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 35

property :tax_included, GOBL::Num::Amount

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

Summary of all the taxes included in the invoice.

Returns:

• (GOBL::Tax::Total)

# File 'lib/gobl/bill/totals.rb', line 46

property :taxes, GOBL::Tax::Total

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

Sum of all line sums minus the discounts, plus the charges, without tax.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 40

property :total, GOBL::Num::Amount

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

Grand total after all taxes have been applied.

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/totals.rb', line 56

property :total_with_tax, GOBL::Num::Amount