Skip to main content
Version: 1.0.0

Add payment

Payment status is managed manually and is not automatically updated by the Peppol network. Use this endpoint to record payments against an invoice. The system automatically sets the status to LATE when the invoice due date has passed and the invoice has not been fully paid; all other status values (SENT, PARTIAL_PAID, PAID) are set through this endpoint.

Endpoint

PropertyValue
URLPOST /invoice/payment/add-payment/{invoiceId}
MethodPOST
AuthR-Auth: <company-jwt>
Base URLStage Environment https://api-stage.docnova.ai/
Production Environment https://api.docnova.ai/

Example Request

curl --location '{{baseUrl}}/invoice/payment/add-payment/{{invoiceId}}?paidAmount=1800.00&paymentDate=2026-06-16T00:00:00' \
--header 'R-Auth: {{companyJwt}}' \
--request POST

Path parameters

ParameterTypeRequiredDescription
invoiceIdUUIDYesInvoice ID from Search documents

Query parameters

ParameterTypeRequiredFormatDescription
paidAmountnumberYesNumberAmount being paid
paymentDatestringYesyyyy-MM-ddTHH:mm:ssDate of payment

Response

{
"paymentStatus": "PAID",
"paidAmount": 1800.0,
"totalAmount": 1800.0,
"remainingAmount": 0.0,
"paymentDate": "2026-06-16"
}

Response fields

FieldDescription
paymentStatusCurrent payment status of the invoice. Possible values: SENT (unpaid), PARTIAL_PAID, PAID, LATE (due date passed, not fully paid)
paidAmountAmount paid so far
totalAmountTotal invoice amount
remainingAmountRemaining balance
paymentDateDate of payment