CreateInvoice | DreamClass

curl -X POST https://https//https/dreamclassapi/v1/financial/invoices/create \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "notify": false,
  "dueDate": "2023-06-30",
  "entityId": 16,
  "issueDate": "2023-05-01",
  "entityType": "student",
  "feesToDate": "2023-12-31",
  "publicNotes": "This is a public notes",
  "feesFromDate": "2023-05-01",
  "privateNotes": "some private notes here",
  "schoolPeriodId": 1
}'

{
  "id": 11,
  "fees": [
    {
      "id": 65,
      "name": "Tuition - Monthly Fee",
      "amount": 100,
      "status": "INVOICED",
      "paidamount": 0
    }
  ],
  "email": "test@test.com",
  "amount": 100,
  "status": 1,
  "address": "",
  "dueDate": "2023-06-30",
  "fullname": "John Brown ",
  "payments": [],
  "createdAt": "2024-09-16T10:05:23.633+00:00",
  "issueDate": "2023-05-01",
  "telephone": "123",
  "paidAmount": 0,
  "publicNotes": "This is a public notes",
  "privateNotes": "some private notes here"
}

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

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

Request

This endpoint expects an object.

notifybooleanRequired

dueDatedateRequired

entityIdintegerRequired

issueDatedateRequired

entityTypestringRequired

feesToDatedateRequired

publicNotesstringRequired

feesFromDatedateRequired

privateNotesstringRequired

schoolPeriodIdintegerRequired

Response

idinteger

feeslist of objects

emailstringformat: "email"

amountinteger

statusinteger

addressstring

dueDatedate

fullnamestring

paymentslist of any

createdAtdatetime

issueDatedate

telephonestring

paidAmountinteger

publicNotesstring

privateNotesstring

invoiceRefIdany

Headers

Request

Response