payments

Create Invoice Payment

Record a manual payment against an invoice.

Request body

  • amount: Positive number in dollars
  • paymentDate: ISO 8601 datetime string
  • paymentMethod: One of CASH, ACH, CREDIT_CARD, KLARNA, AFFIRM, CHECK
  • notes (optional)
  • paymentReference (optional)
post/invoices/{invoice_id}/payments

Request

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

Path parameters

invoice_idinteger required

Invoice identifier

Request body

amountnumber double required

Payment amount in dollars

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

Payment method

paymentDatestring date-time required
notesstring

Optional notes about the payment

paymentReferencestring nullable

Response

Payment created successfully

idinteger required

Payment record identifier

invoiceNumberinteger nullable

Payment display number (when present)

amountnumber double required

Payment amount in dollars

statusstring required

Payment status

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

Payment method

paymentDatestring date-time nullable

When the payment was recorded (ISO 8601); null if absent from upstream

paymentReferencestring nullable
notesstring nullable
isExternalboolean nullable

Whether the payment originated from an external processor (e.g. Stripe)

createdAtstring date-time nullable
updatedAtstring date-time nullable

Changes

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