Class: GOBL::Bill::SubLine

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

Overview

SubLine provides a simplified line that can be embedded inside other lines to provide a more detailed breakdown of the items being sold or substituted.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL SubLine structure

'https://gobl.org/draft-0/bill/line#/$defs/SubLine'

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

#charges ⇒ Array<LineCharge> (readonly)

Charges applied to this sub-line

Returns:



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

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/sub_line.rb', line 49

property :cost, GOBL::CBC::Code

#discounts ⇒ Array<LineDiscount> (readonly)

Discounts applied to this sub-line

Returns:



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

property :discounts, [LineDiscount]

#i ⇒ Integer (readonly)

Line number inside the parent (calculated)

Returns:

  • (Integer) 


23
 
# File 'lib/generated/gobl/bill/sub_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/sub_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/sub_line.rb', line 54

property :item, GOBL::Org::Item

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

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

Returns:



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

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/sub_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/sub_line.rb', line 39

property :period, GOBL::Cal::Period

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

Number of items

Returns:



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

property :quantity, GOBL::Num::Amount

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

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

Returns:



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

property :sum, GOBL::Num::Amount

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

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

Returns:



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

property :total, GOBL::Num::Amount

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


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

property :uuid, String