Class: GOBL::Bill::PaymentLine

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

Overview

PaymentLine defines the details of a line item in a payment document.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL PaymentLine structure

'https://gobl.org/draft-0/bill/payment#/$defs/PaymentLine'

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

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

Amount already paid in previous installments, which may be required by some tax regimes or specific use cases.

Returns:



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

property :advances, GOBL::Num::Amount

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

Amount of the total payment allocated to the referenced document.

Returns:



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

property :amount, GOBL::Num::Amount

#description ⇒ String (readonly)

Additional human readable description of the payment line which may be useful for explaining the purpose or special conditions. Notes should be used for more formal comments.

Returns:

  • (String) 


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

property :description, String

#document ⇒ GOBL::Org::DocumentRef (readonly)

Reference to the document being paid

Returns:



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

property :document, GOBL::Org::DocumentRef

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

Due reflects how much still needs to be paid

Returns:



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

property :due, GOBL::Num::Amount

#i ⇒ Integer (readonly)

Line number within the parent document (automatically calculated)

Returns:

  • (Integer) 


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

property :i, Integer

#installment ⇒ Integer (readonly)

When making multiple payments for a single document, this specifies the installment number for this payment line.

Returns:

  • (Integer) 


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

property :installment, Integer

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

Additional notes specific to this line item for clarification purposes

Returns:



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

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

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

Payable reflects the amount of the document that is payable. This will be calculated from the embedded document’s amount automatically and converted to the currency of the document.

Returns:



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

property :payable, GOBL::Num::Amount

#refund ⇒ Boolean (readonly)

Indicates whether this payment is a refund of a previous payment, effectively reversing the flow of funds between the supplier and customer or their representatives.

Returns:

  • (Boolean) 


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

property :refund, Boolean

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

Tax contains a breakdown of the taxes that will be applied to this payment line after taking into account currency conversion and the relative amounts.

Returns:



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

property :tax, GOBL::Tax::Total

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


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

property :uuid, String