API Documentation

Prepaid Invoice

When an invoice has been paid before (total amount or part of the amount)

About Prepaid

An invoice might have been prepaid : partially or completely. It is important that this information is included in the einvoice sent to the customer.


Information ElementJson tagExample
Partially Paid"To Pay""ToPay": 0.90
Fully Paid"Paid""Paid": true

Example Json and Output UBL

How it is included in the Json body on header level:

{
    "Order" : {
            "OrderNumber": "QS-202565987", 
            "OrderType": "Invoice",
            "OrderDirection": "Income",
            "OrderDate": "2025-08-28",
            "ExpiryDate": "2025-08-28",
            "ToPay": 0.90,

            "OrderLines": [
            {
              "Quantity": 1,
              "UnitPriceExcl": 1.0,
              "Description": "my order line",
              "VATPercentage": 21.0
            }
            ],
            "Customer": {
              "Name": "TestCustomerName",
              "VATNumber": "BE0446725999",
              "PartyType": "Customer",
              "Email" : "[email protected]"
            }
    }
}
{
    "Order" : {
            "OrderNumber": "QS-202565987", 
            "OrderType": "Invoice",
            "OrderDirection": "Income",
            "OrderDate": "2025-08-28",
            "ExpiryDate": "2025-08-28",
            "Paid": true

            "OrderLines": [
            {
              "Quantity": 1,
              "UnitPriceExcl": 1.0,
              "Description": "my order line",
              "VATPercentage": 21.0
            }
            ],
            "Customer": {
              "Name": "TestCustomerName",
              "VATNumber": "BE0446725999",
              "PartyType": "Customer",
              "Email" : "[email protected]"
            }
    }
}

What will be the result in case of the sending of a Peppol UBL, in the LegalMonetaryTotal segment:

  <cac:LegalMonetaryTotal>
    <cbc:LineExtensionAmount currencyID="EUR">1.00</cbc:LineExtensionAmount>
    <cbc:TaxExclusiveAmount currencyID="EUR">1.00</cbc:TaxExclusiveAmount>
    <cbc:TaxInclusiveAmount currencyID="EUR">1.21</cbc:TaxInclusiveAmount>
    <cbc:AllowanceTotalAmount currencyID="EUR">0</cbc:AllowanceTotalAmount>
    <cbc:ChargeTotalAmount currencyID="EUR">0</cbc:ChargeTotalAmount>
    <cbc:PrepaidAmount currencyID="EUR">0.31</cbc:PrepaidAmount>
    <cbc:PayableAmount currencyID="EUR">0.90</cbc:PayableAmount>
  </cac:LegalMonetaryTotal>

The PrepaidAmount and the PayableAmount will be adapted accordingly.


Billit Human Readable when fully paid

When the sender does not include a PDF, then a Billit Human Readable will be generated.

Indocaation Paid will appear on the Human Readable when:

  • the amount is fully prepaid
  • date will be based on the Json tag ""PaidDate"

Example: