Skip to main content

List payments


Retrieve all payment records for a specific invoice.

Endpoint

PropertyValue
URLGET /invoice/payment/payment-list/{invoiceId}
MethodGET
AuthR-Auth: <company-jwt>

Example Request

curl --location '{{baseUrl}}/invoice/payment/payment-list/{{invoiceId}}' \
--header 'R-Auth: {{companyJwt}}'

Path parameters

ParameterTypeRequiredDescription
invoiceIdUUIDYesInvoice ID from Search documents

Response

[
{
"id": "378a0cc0-1254-463b-9061-62eaf458e227",
"paymentStatus": "PAID",
"paidAmount": 1800.0,
"paidDate": "2026-06-16T00:00:00",
"paymentSource": "MANUAL",
"miniUser": {
"id": "3dbe411a-0033-4de2-a4bc-f0217e09a60f",
"email": "marie.martin@alpinesoft-fr.com",
"firstName": "Marie",
"lastName": "Martin"
},
"description": null,
"createdDate": "2026-06-16T09:31:29.324486"
}
]

Response fields

FieldDescription
idPayment ID. Use this value for Update payment and Delete payment.
paymentStatusCurrent payment status
paidAmountAmount of this payment
paidDatePayment date
paymentSourcePayment source, for example MANUAL or system-generated
miniUserUser who recorded the payment
miniUser.idUser UUID
miniUser.emailUser email address
miniUser.firstNameUser first name
miniUser.lastNameUser last name
descriptionOptional payment description
createdDateTimestamp when the payment record was created