> ## Documentation Index
> Fetch the complete documentation index at: https://gobl-regime-code.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/draft-0/org/document_ref) |      | 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](/draft-0/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](/draft-0/num/amount)            |      | Amount already paid in previous installments, which may be required by some tax regimes or specific use cases.                                                                        |
| Amount      | `amount`      | [num.Amount](/draft-0/num/amount)            | true | Amount of the total payment allocated to the referenced document.                                                                                                                     |
| Due         | `due`         | [num.Amount](/draft-0/num/amount)            |      | Due reflects how much still needs to be paid                                                                                                                                          |
| Tax         | `tax`         | [tax.Total](/draft-0/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](/draft-0/org/note)       |      | Additional notes specific to this line item for clarification purposes                                                                                                                |