PaymentLine

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

Schema ID

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

Properties

Title	Property	Type	Description
UUID	uuid	string	Universally Unique Identifier.
Index	i	integer	Line number within the parent document (automatically calculated)
Refund	refund	boolean	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.
Document	document	org.DocumentRef	Reference to the document being paid
Installment	installment	integer	When making multiple payments for a single document, this specifies the installment number for this payment line.
Description	description	string	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.
Payable	payable	num.Amount	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.
Advances	advances	num.Amount	Amount already paid in previous installments, which may be required by some tax regimes or specific use cases.
Amount	amount	num.Amount	Amount of the total payment allocated to the referenced document.
Due	due	num.Amount	Due reflects how much still needs to be paid
Tax	tax	tax.Total	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.
Notes	notes	array of org.Note	Additional notes specific to this line item for clarification purposes

Validation Rules

Field	Test	Validation Code / Message
PaymentLine	Advances within payable	GOBL-BILL-PAYMENTLINE-11 Advances must not exceed payable
PaymentLine	Amount within limit	GOBL-BILL-PAYMENTLINE-12 Amount must not exceed payable less advances
installment	At least 1 At most 999	GOBL-BILL-PAYMENTLINE-01 Installment must be between 1 and 999
payable	Min 0	GOBL-BILL-PAYMENTLINE-02 Payable must be positive
advances	Min 0	GOBL-BILL-PAYMENTLINE-03 Advances must be zero or positive
amount	Min 0	GOBL-BILL-PAYMENTLINE-04 Amount must be positive
due	Min 0	GOBL-BILL-PAYMENTLINE-05 Due must be zero or positive