Class: GOBL::Bill::Totals
- Defined in:
- lib/generated/gobl/bill/totals.rb
Overview
Totals contains the summaries of all calculations for the invoice.
Constant Summary collapse
- SCHEMA_ID =
The Schema ID of the GOBL Totals structure
'https://gobl.org/draft-0/bill/totals'
Instance Attribute Summary collapse
-
#advance ⇒ GOBL::Num::Amount
readonly
Total amount already paid in advance by the customer.
-
#charge ⇒ GOBL::Num::Amount
readonly
Total of all charges applied at the document level.
-
#discount ⇒ GOBL::Num::Amount
readonly
Total of all discounts applied at the document level.
-
#due ⇒ GOBL::Num::Amount
readonly
Remaining amount that needs to be paid.
-
#payable ⇒ GOBL::Num::Amount
readonly
Final amount to be paid after retained taxes and rounding adjustments.
-
#retained_tax ⇒ GOBL::Num::Amount
readonly
Total tax amount retained or withheld by the customer to be paid to the tax authority.
-
#rounding ⇒ GOBL::Num::Amount
readonly
Adjustment amount applied to the invoice totals to meet rounding rules or expectations.
-
#sum ⇒ GOBL::Num::Amount
readonly
Total of all line item amounts.
-
#tax ⇒ GOBL::Num::Amount
readonly
Total indirect tax amount to be applied to the invoice.
-
#tax_included ⇒ GOBL::Num::Amount
readonly
Total tax amount included in the prices, if prices are tax-inclusive.
-
#taxes ⇒ GOBL::Tax::Total
readonly
Detailed breakdown of all taxes applied to the invoice.
-
#total ⇒ GOBL::Num::Amount
readonly
Net total amount after subtracting discounts and adding charges, excluding tax.
-
#total_with_tax ⇒ GOBL::Num::Amount
readonly
Final total amount after applying indirect taxes.
Method Summary
Methods inherited from Object
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 by the customer.
77 |
# File 'lib/generated/gobl/bill/totals.rb', line 77 property :advance, GOBL::Num::Amount |
#charge ⇒ GOBL::Num::Amount (readonly)
Total of all charges applied at the document level.
29 |
# File 'lib/generated/gobl/bill/totals.rb', line 29 property :charge, GOBL::Num::Amount |
#discount ⇒ GOBL::Num::Amount (readonly)
Total of all discounts applied at the document level.
24 |
# File 'lib/generated/gobl/bill/totals.rb', line 24 property :discount, GOBL::Num::Amount |
#due ⇒ GOBL::Num::Amount (readonly)
Remaining amount that needs to be paid.
82 |
# File 'lib/generated/gobl/bill/totals.rb', line 82 property :due, GOBL::Num::Amount |
#payable ⇒ GOBL::Num::Amount (readonly)
Final amount to be paid after retained taxes and rounding adjustments.
71 |
# File 'lib/generated/gobl/bill/totals.rb', line 71 property :payable, GOBL::Num::Amount |
#retained_tax ⇒ GOBL::Num::Amount (readonly)
Total tax amount retained or withheld by the customer to be paid to the tax authority.
61 |
# File 'lib/generated/gobl/bill/totals.rb', line 61 property :retained_tax, GOBL::Num::Amount |
#rounding ⇒ GOBL::Num::Amount (readonly)
Adjustment amount applied to the invoice totals to meet rounding rules or expectations.
66 |
# File 'lib/generated/gobl/bill/totals.rb', line 66 property :rounding, GOBL::Num::Amount |
#sum ⇒ GOBL::Num::Amount (readonly)
Total of all line item amounts.
18 |
# File 'lib/generated/gobl/bill/totals.rb', line 18 property :sum, GOBL::Num::Amount |
#tax ⇒ GOBL::Num::Amount (readonly)
Total indirect tax amount to be applied to the invoice.
50 |
# File 'lib/generated/gobl/bill/totals.rb', line 50 property :tax, GOBL::Num::Amount |
#tax_included ⇒ GOBL::Num::Amount (readonly)
Total tax amount included in the prices, if prices are tax-inclusive.
34 |
# File 'lib/generated/gobl/bill/totals.rb', line 34 property :tax_included, GOBL::Num::Amount |
#taxes ⇒ GOBL::Tax::Total (readonly)
Detailed breakdown of all taxes applied to the invoice.
45 |
# File 'lib/generated/gobl/bill/totals.rb', line 45 property :taxes, GOBL::Tax::Total |
#total ⇒ GOBL::Num::Amount (readonly)
Net total amount after subtracting discounts and adding charges, excluding tax.
39 |
# File 'lib/generated/gobl/bill/totals.rb', line 39 property :total, GOBL::Num::Amount |
#total_with_tax ⇒ GOBL::Num::Amount (readonly)
Final total amount after applying indirect taxes.
55 |
# File 'lib/generated/gobl/bill/totals.rb', line 55 property :total_with_tax, GOBL::Num::Amount |