Skip to main content
GET
List reported payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string<uuid>
required

UUID of the invoice in this request.

Response

amount
string<decimal>
required

Amount received toward the invoice in its currency, expressed in major units and greater than zero. Partial payments reduce balance; covering the full invoice stops dunning unless it has already been handed to debt collection.

Pattern: ^[0-9]{1,10}(?:\.[0-9]{1,2})?$
created
string<date-time>
required
read-only

Time at which the payment was recorded.

id
string<uuid>
required
read-only

Stable identifier of the payment.

value_date
string<date>
required

Date the payment was received; must not be in the future. Together with amount and reference, it identifies an identical repeated payment report.

reference
string | null

Optional payment reference. Omitted, blank and null references are treated alike. A repeat with the same invoice, amount, value_date and nonempty reference (compared case-insensitively) returns the existing payment (200). An identical unreferenced payment returns 409 duplicate_payment; use a distinct reference for a genuine second payment.

Maximum string length: 255