Create document payment
Creates a new payment for a public document.
Supported document types
Only invoice, proforma, and credit-note are supported.
Business behavior
- The payment is always linked to one document via
documentType+documentId. - The minimal create payload is only
documentType+documentId; all other fields can be omitted and are derived server-side. - If
paymentDateis omitted, today’s date is used. - If
paymentMethodIdis omitted, the payment method from the source document is used. - If
currencyIdis omitted, the currency from the source document is used. - If
amountis omitted, the current remainingtoBePaidamount from the source document is used. This shortcut only works when the document still has a non-zerotoBePaid; otherwise the endpoint returns422. - If
amountis sent explicitly, it can have at most 2 decimal places. - If
amountis sent explicitly, its magnitude must not exceed the currenttoBePaidand it must keep the same sign, so the payment cannot over-settle the document or move in the opposite direction. - If
currencyRateis omitted, the system derives it from the finalpaymentDateusing the previous day’s rate. - If you send
currencyRatefor a currency other thanEUR, that override value is used as-is. - If the final payment currency is
EUR, the backend always stores and returnscurrencyRate = 1.0, even when you send a different value. - Creating a payment recalculates the document payment status exactly like the web and mobile flows.
- If you later issue a payment receipt invoice for a proforma payment, the payment response may expose it in
receiptInvoice.
If you send an Idempotency-Key, the same key with the same payload returns the original response without creating the payment again.
Authorizations
Headers
Body
Payload used to create a document payment. Only invoice, proforma, and credit-note documents are supported, and the target document must be available in the token scope.
Optional currency ID from the currency reference table. If omitted, the source document currency is used.
1
Exchange rate of the payment currency against EUR. If omitted, the system derives it from the final paymentDate using the previous day's rate. If provided for a currency other than EUR, the override value is used as-is. If the final payment currency is EUR, the backend always stores 1.0.
1
Optional payment method ID from the payment method reference table. If omitted, the source document payment method is used.
1
Payment amount in the payment currency. If omitted, the current remaining toBePaid amount from the source document is used. This derived amount is available only when the source document has a non-zero toBePaid; otherwise the endpoint returns 422. If sent explicitly, it can have at most 2 decimal places, its magnitude must not exceed the current toBePaid, and it must keep the same sign. The backend also accepts negative amounts, for example when settling a credit note. On storage, the sign is normalized by document type: negative absolute value for credit-note, positive absolute value for invoice and proforma.
0.0115.5
Response
Document payment created.
One payment of a public document.

