Invoice | DreamClass | Documentation

curl -X POST https://https//https#post9 \
     -H "Content-Type: application/json" \
     -d '{
  "tenant": "my-school",
  "timestamp": 1727884920561,
  "id": "aa3a27d6-05b5-4fcd-bd04-505bfffacfc2",
  "signature": "4sB3kHjsoz0srhd/dd+55xSKhlFd/hUXzyrMIJWrXTM=",
  "type": "INVOICE_CREATED",
  "data": {
    "id": 16,
    "invoiceRefId": "abc123",
    "amount": 300,
    "status": 1,
    "fullname": "John Sample",
    "address": "Address 1",
    "telephone": "123456789",
    "email": "test@test.com",
    "createdAt": "2024-10-02T16:02:00.544+00:00",
    "issueDate": "2024-10-01",
    "dueDate": "2024-10-31",
    "fees": [
      {
        "id": 86
      },
      {
        "id": 85
      },
      {
        "id": 84
      }
    ]
  }
}'

Webhook related to invoices, trigged upon

Invoice created: INVOICE_CREATED
Invoice updated: INVOICE_UPDATED
Invoice deleted: INVOICE_DELETED

Using the provided id, use the GetInvoie API to retrieve more data. Using the provided fees.id use the GetPeriodFees to retrieve more data

Webhook related to invoices, trigged upon - Invoice created: INVOICE_CREATED - Invoice updated: INVOICE_UPDATED - Invoice deleted: INVOICE_DELETED Using the provided id, use the GetInvoie API to retrieve more data. Using the provided fees.id use the GetPeriodFees to retrieve more data

Request

This endpoint expects an object.

tenantstringRequired

timestampintegerRequired

idstringRequiredformat: "uuid"

signaturestringRequired

typestringRequired

dataobjectRequired

Response

Successful response