UpdateInvoice | DreamClass

curl -X PATCH https://https//https/dreamclassapi/v1/financial/invoices/update/%7BinvoiceId%7D \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "publicNotes": "3213213",
  "privateNotes": "test",
  "issueDate": "2021-01-01",
  "invoiceRefId": "111"
}'

{
  "id": 3,
  "amount": 10,
  "paidAmount": 10,
  "status": 3,
  "fullname": "John  Johnson ",
  "address": "123 Clement Street",
  "createdAt": "2024-04-21T12:22:40.661+00:00",
  "issueDate": "2024-04-01",
  "dueDate": "2024-04-30",
  "fees": [
    {
      "id": 18,
      "name": "Registration Fee",
      "amount": 10,
      "paidamount": 10,
      "status": "PAID"
    }
  ],
  "payments": [
    {
      "id": 2,
      "amount": 5,
      "createdAt": "2024-04-21T12:24:06.877+00:00",
      "invoiceId": 3
    },
    {
      "id": 1,
      "amount": 5,
      "createdAt": "2024-04-21T12:23:07.533+00:00",
      "invoiceId": 3,
      "paymentmethod": 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)

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)

Request

This endpoint expects an object.

publicNotesstringRequired

privateNotesstringRequired

issueDatedateRequired

invoiceRefIdstringRequired

Response

idinteger

amountinteger

paidAmountinteger

statusinteger

fullnamestring

addressstring

createdAtdatetime

issueDatedate

dueDatedate

feeslist of objects

paymentslist of objects

invoiceRefIdanyOptional

telephoneanyOptional

emailanyOptional

privateNotesanyOptional

publicNotesanyOptional

Headers

Request

Response