Class: GOBL::Bill::Line

Inherits:
Object show all
Defined in:
lib/generated/gobl/bill/line.rb

Overview

Line is a single row in an invoice.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Line structure

'https://gobl.org/draft-0/bill/line'

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#breakdown ⇒ Array<SubLine> (readonly)

Breakdown of the line item for more detailed information. The sum of all lines will be used for the item price.

Returns:



60
 
# File 'lib/generated/gobl/bill/line.rb', line 60

property :breakdown, [SubLine]

#charges ⇒ Array<LineCharge> (readonly)

Charges applied to this line

Returns:



75
 
# File 'lib/generated/gobl/bill/line.rb', line 75

property :charges, [LineCharge]

#cost ⇒ GOBL::CBC::Code (readonly)

Buyer accounting reference cost code to associate with the line.

Returns:



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

property :cost, GOBL::CBC::Code

#discounts ⇒ Array<LineDiscount> (readonly)

Discounts applied to this line

Returns:



70
 
# File 'lib/generated/gobl/bill/line.rb', line 70

property :discounts, [LineDiscount]

#ext ⇒ GOBL::Tax::Extensions (readonly)

Extension codes that apply to the line

Returns:



100
 
# File 'lib/generated/gobl/bill/line.rb', line 100

property :ext, GOBL::Tax::Extensions

#i ⇒ Integer (readonly)

Line number inside the parent (calculated)

Returns:

  • (Integer) 


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

property :i, Integer

#identifier ⇒ GOBL::Org::Identity (readonly)

Single identifier provided by the supplier for an object on which the line item is based and is not considered a universal identity. Examples include a subscription number, telephone number, meter point, etc. Utilize the label property to provide a description of the identifier.

Returns:



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

property :identifier, GOBL::Org::Identity

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

Details about the item, service or good, that is being sold

Returns:



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

property :item, GOBL::Org::Item

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

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

Returns:



95
 
# File 'lib/generated/gobl/bill/line.rb', line 95

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

#order ⇒ GOBL::CBC::Code (readonly)

Order reference for a specific line within a purchase order provided by the buyer.

Returns:



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

property :order, GOBL::CBC::Code

#period ⇒ GOBL::Cal::Period (readonly)

A period of time relevant to when the service or item is delivered.

Returns:



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

property :period, GOBL::Cal::Period

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

Number of items

Returns:



28
 
# File 'lib/generated/gobl/bill/line.rb', line 28

property :quantity, GOBL::Num::Amount

#substituted ⇒ Array<SubLine> (readonly)

List of substituted lines. Useful for deliveries or corrective documents in order to indicate to the recipient which of the requested lines are being replaced. This is for purely informative purposes, and will not be used for calculations.

Returns:



90
 
# File 'lib/generated/gobl/bill/line.rb', line 90

property :substituted, [SubLine]

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

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

Returns:



65
 
# File 'lib/generated/gobl/bill/line.rb', line 65

property :sum, GOBL::Num::Amount

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

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

Returns:



80
 
# File 'lib/generated/gobl/bill/line.rb', line 80

property :taxes, GOBL::Tax::Set

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

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

Returns:



85
 
# File 'lib/generated/gobl/bill/line.rb', line 85

property :total, GOBL::Num::Amount

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


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

property :uuid, String