List Invoice Payments | Coperniq API

Retrieve all payment records for an invoice.

Amounts are returned in dollars (internal storage uses cents).

x-api-keystring

API Key authentication via header

invoiceIdintegerRequired

Invoice identifier

List of payments for the invoice

idinteger

Payment record identifier

amountdouble

Payment amount in dollars

statusstring

Payment status

paymentMethodstring

Payment method (e.g. CASH, ACH, CREDIT_CARD, CHECK)

invoiceNumberinteger or null

Payment display number (when present)

paymentDatestring or nullformat: "date-time"

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

paymentReferencestring or null

notesstring or null

isExternalboolean or null

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

createdAtstring or nullformat: "date-time"

updatedAtstring or nullformat: "date-time"

createdByobject or null

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/invoices/1/payments';
2	const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}