Skip to main content

Get payment details


Retrieve the current payment summary for a specific invoice.

Endpoint

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

Example Request

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

Path parameters

ParameterTypeRequiredDescription
invoiceIdUUIDYesInvoice ID from Search documents

Response

{
"paymentStatus": "PAID",
"paidAmount": 1800.0,
"totalAmount": 1800.0,
"remainingAmount": 0.0,
"paymentDate": "2026-06-16"
}

Response fields

FieldDescription
paymentStatusPayment status. Possible values: SENT (unpaid), PARTIAL_PAID, PAID
paidAmountTotal amount paid
totalAmountTotal invoice amount
remainingAmountRemaining balance
paymentDateDate of last payment