Skip to navigation

UpdateInvoice

View as Markdown

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

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional

Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.

schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Request

This endpoint expects an object.
publicNotesstringRequired
privateNotesstringRequired
issueDatedateRequired
invoiceRefIdstringRequired
dueDatedateOptional

Response

OK
idinteger
invoiceRefIdstring
amountdouble
paidAmountdouble
statusinteger
fullnamestring
addressstring
telephonestring
emailstringformat: "email"
createdAtdatetime
issueDatedate
dueDatedate
privateNotesstring
publicNotesstring
feeslist of objects
paymentslist of objects
studentIdslist of integers