Bill
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 | Req. | 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 | true | 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 |