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

Schema ID

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

Properties

TitlePropertyTypeReq.Description
UUIDuuidstringUniversally Unique Identifier.
IndexiintegerLine number within the parent document (automatically calculated)
RefundrefundbooleanIndicates whether this payment is a refund of a previous payment, effectively reversing the flow of funds between the supplier and customer or their representatives.
Documentdocumentorg.DocumentRefReference to the document being paid
InstallmentinstallmentintegerWhen making multiple payments for a single document, this specifies the installment number for this payment line.
DescriptiondescriptionstringAdditional 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.
Payablepayablenum.AmountPayable 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.
Advancesadvancesnum.AmountAmount already paid in previous installments, which may be required by some tax regimes or specific use cases.
Amountamountnum.AmounttrueAmount of the total payment allocated to the referenced document.
Dueduenum.AmountDue reflects how much still needs to be paid
Taxtaxtax.TotalTax contains a breakdown of the taxes that will be applied to this payment line after taking into account currency conversion and the relative amounts.
Notesnotesarray of org.NoteAdditional notes specific to this line item for clarification purposes