GetInvoicePayments

View as Markdown

Get the list of payments recorded against an invoice. Optionally filter by a payment date range.

InvoiceId: Check the GetInvoices call

fromDate/toDate: optional payment date range in ISO format e.g. 2026-01-01 (both must be set to apply the filter)

Headers

tenantstringOptional
schoolCodestringOptional

Query parameters

fromDatestringOptional

Start payment date e.g. 2026-01-01 ISO format (optional)

toDatestringOptional

End payment date e.g. 2026-06-30 ISO format (optional)

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
X-Content-Type-OptionsstringOptional
Cache-ControlstringOptional

Response

OK
idinteger
amountinteger
publicNotesstring
privateNotesstring
paymentmethodobject
createdAtdatetime
datedate
invoiceIdinteger