payments

Update Payment

Update an existing payment record by its own id — no invoice or bill id is required in the path.

Supports partial updates of amount, paymentMethod, paymentDate, notes, and paymentReference — the same fields the Coperniq UI exposes when editing a logged payment.

If the payment is external (processed by Stripe), only notes may be updated; any other field returns a 400.

Updating amount may fail with a 400 if the new total would exceed the parent invoice/bill's outstanding balance. The parent document's amountPaid/status are recalculated automatically.

patch/payments/{payment_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/payments/{payment_id}
  • Auth: API key in header x-api-key

Path parameters

payment_idstring required

Request body

amountnumber double

Payment amount in dollars

paymentMethod'CASH' | 'ACH' | 'CREDIT_CARD' | 'KLARNA' | 'AFFIRM' | 'CHECK'

Payment method

paymentDatestring date-time
notesstring

Optional notes about the payment

paymentReferencestring nullable

Response

Payment updated successfully

OR

Changes

No recorded changes to this operation across all 1 revision of this API.