⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Register a payment against the given partner invoice. The entry is recorded as a settlement record linked to the invoice, the invoice's amountPaid is recomputed from all of its linked entries, and paymentStatus is re-derived as unpaid, partially_paid or paid from the recomputed total against totalAmount.withTax.

The request body uses the same property names as the settlement record it creates — date, paidAmount and note, with note empty when omitted here. The record returned by the partner settlement report records endpoints additionally carries partnerInvoiceId pointing back to this invoice.

A negative paidAmount is accepted and records a reversing entry, as long as the resulting total paid does not fall below zero.

While a settlement report has at least one partner invoice, its settlement records can no longer be created, updated or deleted directly — register payments here instead.

A 409 means the invoice is permanently ineligible or the entry is inconsistent with the invoice's current state: the invoice has already been credited, the target is itself a credit note, or the entry would drive the total amount paid below zero.