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 '{
  "issueDate": "2021-01-01",
  "publicNotes": "3213213",
  "invoiceRefId": "111",
  "privateNotes": "test"
}'

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

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.

issueDatedateRequired

publicNotesstringRequired

invoiceRefIdstringRequired

privateNotesstringRequired

Response

idinteger

feeslist of objects

amountinteger

statusinteger

addressstring

dueDatedate

fullnamestring

paymentslist of objects

createdAtdatetime

issueDatedate

paidAmountinteger

emailany

telephoneany

publicNotesany

invoiceRefIdany

privateNotesany

Headers

Request

Response