Creates a new payment for a public document.
Only invoice, proforma, and credit-note are supported.
documentType + documentId.documentType + documentId; all other fields can be omitted and are derived server-side.paymentDate is omitted, today’s date is used.paymentMethodId is omitted, the payment method from the source document is used.currencyId is omitted, the currency from the source document is used.amount is omitted, the current remaining toBePaid amount from the source document is used. This shortcut only works when the document still has a non-zero toBePaid; otherwise the endpoint returns 422.amount is sent explicitly, it can have at most 2 decimal places.amount is sent explicitly, its magnitude must not exceed the current toBePaid and it must keep the same sign, so the payment cannot over-settle the document or move in the opposite direction.currencyRate is omitted, the system derives it from the final paymentDate using the previous day’s rate.currencyRate for a currency other than EUR, that override value is used as-is.EUR, the backend always stores and returns currencyRate = 1.0, even when you send a different value.receiptInvoice.If you send an Idempotency-Key, the same key with the same payload returns the original response without creating the payment again.
Bearer token created for a specific company in Integrations → API.
Optional request identifier for safe retries. Use a unique value for each create request you want to retry safely.
"invoice-create-2026-03-03-001"
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.
Type of the document you are paying.
invoice, proforma, credit-note "invoice"
ID of the document you are paying.
301
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
Payment date in Y-m-d format. If omitted, today's date is used.
"2026-03-07"
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.
0.0115.5
Document payment created.
One payment of a public document.
Internal payment ID.
801
Type of the document this payment belongs to.
invoice, proforma, credit-note "invoice"
ID of the document this payment belongs to.
301
Used payment method as a nested lookup object.
Payment currency as a nested lookup object.
Payment date in Y-m-d format.
"2026-03-07"
Payment amount in the payment currency.
15.5
Exchange rate of the payment currency against EUR. If the payment currency is EUR, the backend always returns 1.0.
1
Preview of the linked payment receipt invoice, when it exists.