Class: GOBL::Bill::Line

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Bill::Line

Defined in:

lib/gobl/bill/line.rb

Overview

Line is a single row in an invoice.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Line structure

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

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary

• #charges ⇒ Array<LineCharge> readonly

  Charges applied to this line.

• #discounts ⇒ Array<LineDiscount> readonly

  Discounts applied to this line.

• #i ⇒ Integer readonly

  Line number inside the parent (calculated).

• #item ⇒ GOBL::Org::Item readonly

  Details about what is being sold.

• #notes ⇒ Array<GOBL::CBC::Note> readonly

  Set of specific notes for this line that may be required for clarification.

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

  Number of items.

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

  Result of quantity multiplied by the item’s price (calculated).

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

  Map of taxes to be applied and used in the invoice totals.

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

  Total line amount after applying discounts to the sum (calculated).

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

  Unique identifier for this line.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#charges ⇒ Array<LineCharge> (readonly)

Charges applied to this line

Returns:

• (Array<LineCharge>)

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

property :charges, [LineCharge]

#discounts ⇒ Array<LineDiscount> (readonly)

Discounts applied to this line

Returns:

• (Array<LineDiscount>)

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

property :discounts, [LineDiscount]

#i ⇒ Integer (readonly)

Line number inside the parent (calculated)

Returns:

• (Integer)

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

property :i, Integer

#item ⇒ GOBL::Org::Item (readonly)

Details about what is being sold

Returns:

• (GOBL::Org::Item)

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

property :item, GOBL::Org::Item

#notes ⇒ Array<GOBL::CBC::Note> (readonly)

Set of specific notes for this line that may be required for clarification.

Returns:

• (Array<GOBL::CBC::Note>)

# File 'lib/gobl/bill/line.rb', line 66

property :notes, [GOBL::CBC::Note]

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

Number of items

Returns:

• (GOBL::Num::Amount)

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

property :quantity, GOBL::Num::Amount

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

Result of quantity multiplied by the item’s price (calculated)

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/line.rb', line 41

property :sum, GOBL::Num::Amount

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

Map of taxes to be applied and used in the invoice totals

Returns:

• (GOBL::Tax::Set)

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

property :taxes, GOBL::Tax::Set

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

Total line amount after applying discounts to the sum (calculated).

Returns:

• (GOBL::Num::Amount)

# File 'lib/gobl/bill/line.rb', line 61

property :total, GOBL::Num::Amount

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

Unique identifier for this line

Returns:

• (GOBL::UUID::UUID)

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

property :uuid, GOBL::UUID::UUID