CreateInvoice | DreamClass

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

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

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

Headers

Request

This endpoint expects an object.

entityTypestringRequired

entityIdintegerRequired

schoolPeriodIdintegerRequired

feesFromDatedateRequired

feesToDatedateRequired

issueDatedateRequired

dueDatedateRequired

privateNotesstringRequired

publicNotesstringRequired

notifybooleanRequired

Response

idinteger

amountdouble

paidAmountinteger

statusinteger

fullnamestring

addressstring

telephonestring

emailstringformat: "email"

createdAtdatetime

issueDatedate

dueDatedate

privateNotesstring

publicNotesstring

feeslist of objects

paymentslist of any

invoiceRefIdanyOptional