UpdatePayment | DreamClass

Update editable fields of a payment

Input variables

paymentId: number of the invoice
json representation of editable fields of a Payment
- publicNotes
- privateNotes
- date

For payment id check the GetInvoce endpoint

Update editable fields of a payment Input variables - paymentId: number of the invoice - json representation of editable fields of a Payment - publicNotes - privateNotes - date For payment id check the GetInvoce endpoint

Request

This endpoint expects an object.

datedateRequired

publicNotesstringRequired

privateNotesstringRequired

Response

idinteger

datedate

amountinteger

createdAtdatetime

invoiceIdinteger

publicNotesstring

privateNotesstring

paymentmethodobject

1	curl -X PATCH https://https//https/dreamclassapi/v1/financial/invoices/payment/%7BpaymentId%7D \
2	-H "tenant: {{tenant}}" \
3	-H "schoolCode: {{schoolCode}}" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"date": "2021-01-01",
7	"publicNotes": "3213213",
8	"privateNotes": "test"
9	}'

1	{
2	"id": 63,
3	"date": "2021-01-01",
4	"amount": 1,
5	"createdAt": "2025-09-18T11:58:12.448+00:00",
6	"invoiceId": 24,
7	"publicNotes": "test1",
8	"privateNotes": "test2",
9	"paymentmethod": {
10	"id": 2,
11	"translation": "PAYMENTMETHODS.BANK",
12	"institutionId": 1,
13	"logOnlyPaymentMethod": true
14	}
15	}

Headers

Request

Response