UpdateInvoice | DreamClass

curl -X PATCH https://api.dreamclass.io/dreamclassapi/v1/financial/invoices/update/1 \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "publicNotes": "Payable within 30 days",
  "privateNotes": "Reviewed by the finance office",
  "issueDate": "2026-01-05",
  "dueDate": "2026-02-05",
  "invoiceRefId": "ACC-2024-0018"
}'

{
  "id": 3,
  "invoiceRefId": "ACC-2024-0018",
  "amount": 10.5,
  "paidAmount": 10.5,
  "status": 3,
  "fullname": "John Johnson",
  "address": "123 Clement Street",
  "telephone": "+30 210 1234567",
  "email": "john.johnson@example.com",
  "createdAt": "2024-04-21T12:22:40.661+00:00",
  "issueDate": "2026-01-05",
  "dueDate": "2026-02-05",
  "privateNotes": "Reviewed by the finance office",
  "publicNotes": "Payable within 30 days",
  "fees": [
    {
      "id": 18,
      "name": "Registration Fee",
      "amount": 10.5,
      "paidamount": 10.5,
      "status": "PAID"
    }
  ],
  "payments": [
    {
      "id": 1,
      "amount": 5.25,
      "publicNotes": "Cash payment at the school office",
      "paymentmethod": {
        "id": 1,
        "translation": "PAYMENTMETHODS.CASH",
        "logOnlyPaymentMethod": true,
        "institutionId": 1
      },
      "createdAt": "2024-04-21T12:23:07.533+00:00",
      "date": "2024-04-21",
      "invoiceId": 3,
      "status": 1,
      "paymentFees": 0
    },
    {
      "id": 2,
      "amount": 5.25,
      "publicNotes": "stripe payment #pi_3ExampleSettled01",
      "paymentmethod": {
        "id": 1000,
        "translation": "PAYMENTMETHODS.STRIPE",
        "logOnlyPaymentMethod": false,
        "institutionId": 1
      },
      "createdAt": "2024-04-21T12:24:06.877+00:00",
      "date": "2024-04-21",
      "invoiceId": 3,
      "status": 1,
      "paymentFees": 1,
      "stripePaymentIntentId": null
    }
  ]
}

Update editable fields of a single invoice

Input variables

invoiceId: number of the invoice
json representation of editable fields of an Invoice
- publicNotes
- privateNotes
- issueDate
- dueDate
- invoiceRefId (helper string field for keeping reference with external accounting systems)

The response is the updated invoice, including its payments. For what status, paymentFees and stripePaymentIntentId mean on a payment — and why the payments array can total more than paidAmount — see the GetInvoice endpoint.

Update editable fields of a single invoice Input variables - invoiceId: number of the invoice - json representation of editable fields of an Invoice - publicNotes - privateNotes - issueDate - dueDate - invoiceRefId (helper string field for keeping reference with external accounting systems) The response is the updated invoice, including its `payments`. For what `status`, `paymentFees` and `stripePaymentIntentId` mean on a payment — and why the payments array can total more than `paidAmount` — see the GetInvoice endpoint.

Path parameters

invoiceIdstringRequired

Headers

Request

This endpoint expects an object.

publicNotesstringRequired

privateNotesstringRequired

issueDatedateRequired

dueDatedateRequired

invoiceRefIdstringRequired

Response

idinteger

invoiceRefIdstring

amountdouble

paidAmountdouble

statusinteger

fullnamestring

addressstring

telephonestring

emailstringformat: "email"

createdAtdatetime

issueDatedate

dueDatedate

privateNotesstring

publicNotesstring

feeslist of objects

paymentslist of objects