Skip to navigation

CreateInvoice

View as Markdown

Creates a new Invoice

Input variables

  • json representation of new Invoice parameters
    • entityType (student | guardian)
      • to select if you are invoicing a Student or a Guardian
    • entityId
      • the id of the entity you are invoicing
    • schoolPeriodId
      • the id of the School Period you are invoicing
    • feesFromDate
      • include all uninvoiced feed from that date
    • feesToDate
      • include all uninvoiced feed to that date
    • issueDate
    • dueDate
    • privateNotes
    • publicNotes
    • notify (true | false)
      • to send auto notification to the invoice recipient

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.
entityTypestringRequired
entityIdintegerRequired
schoolPeriodIdintegerRequired
feesFromDatedateRequired
feesToDatedateRequired
issueDatedateRequired
dueDatedateRequired
privateNotesstringRequired
publicNotesstringRequired
notifybooleanRequired

Response

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