PayInvoice | DreamClass | Documentation

curl -X POST https://https//https/dreamclassapi/v1/financial/invoices/pay/%7BinvoiceId%7D \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "amount": "10",
  "publicNotes": "test",
  "paymentmethod": {
    "id": 1
  },
  "createdAt": "2021-04-25T15:23:00Z"
}'

{
  "id": 3,
  "amount": 10,
  "paidAmount": 10,
  "status": 3,
  "fullname": "John  Johnson",
  "address": "123 Clement Street",
  "createdAt": "2024-04-21T12:22:40.661+00:00",
  "issueDate": "2024-04-01",
  "dueDate": "2024-04-30",
  "fees": [
    {
      "id": 18,
      "name": "Registration Fee",
      "amount": 10,
      "paidamount": 10,
      "status": "PAID"
    }
  ],
  "payments": [
    {
      "id": 2,
      "amount": 5,
      "createdAt": "2024-04-21T12:24:06.877+00:00",
      "invoiceId": 3
    },
    {
      "id": 1,
      "amount": 5,
      "createdAt": "2024-04-21T12:23:07.533+00:00",
      "invoiceId": 3,
      "paymentmethod": null
    }
  ]
}

Used to issue a payment against an invoice.

Input variables

invoiceId: number of the invoice (path variable)
json representation of a payment object
- amount (decimal)
- privateNotes (if any)
- publicNotes (if any)
- paymentmethod (1 Cash, 2 Bank Transfer, 3 Online, 4 Check,…)
- createdAt (optional)

Used to issue a payment against an invoice. Input variables - invoiceId: number of the invoice (path variable) - json representation of a payment object - amount (decimal) - privateNotes (if any) - publicNotes (if any) - paymentmethod (1 Cash, 2 Bank Transfer, 3 Online, 4 Check,...) - createdAt (optional)

Request

This endpoint expects an object.

amountstringRequired

publicNotesstringRequired

paymentmethodobjectRequired

createdAtdatetimeRequired

privateNotesanyOptional

Response

idinteger

amountinteger

paidAmountinteger

statusinteger

fullnamestring

addressstring

createdAtdatetime

issueDatedate

dueDatedate

feeslist of objects

paymentslist of objects

invoiceRefIdanyOptional

telephoneanyOptional

emailanyOptional

privateNotesanyOptional

publicNotesanyOptional

Headers

Request

Response