PayInvoice | DreamClass | Documentation

curl -X POST https://api.dreamclass.io/dreamclassapi/v1/financial/invoices/pay/1 \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "amount": 5.25,
  "publicNotes": "Cash payment at the school office",
  "paymentmethod": {
    "id": 1
  },
  "createdAt": "2026-01-15T10:30:00Z"
}'

{
  "id": 3,
  "invoiceRefId": "ACC-2024-0018",
  "amount": 10.5,
  "paidAmount": 10.5,
  "status": 3,
  "fullname": "John Johnson",
  "address": "123 Clement Street",
  "telephone": "+30 210 1234567",
  "email": "john.johnson@example.com",
  "createdAt": "2024-04-21T12:22:40.661+00:00",
  "issueDate": "2024-04-01",
  "dueDate": "2024-04-30",
  "publicNotes": "Thank you for your payment.",
  "fees": [
    {
      "id": 18,
      "name": "Registration Fee",
      "amount": 10.5,
      "paidamount": 10.5,
      "status": "PAID"
    }
  ],
  "payments": [
    {
      "id": 1,
      "amount": 5.25,
      "publicNotes": "Cash payment at the school office",
      "paymentmethod": {
        "id": 1,
        "translation": "PAYMENTMETHODS.CASH",
        "logOnlyPaymentMethod": true,
        "institutionId": 1
      },
      "createdAt": "2024-04-21T12:23:07.533+00:00",
      "date": "2024-04-21",
      "invoiceId": 3,
      "status": 1,
      "paymentFees": 0
    },
    {
      "id": 2,
      "amount": 5.25,
      "publicNotes": "stripe payment #pi_3ExampleSettled01",
      "paymentmethod": {
        "id": 1000,
        "translation": "PAYMENTMETHODS.STRIPE",
        "logOnlyPaymentMethod": false,
        "institutionId": 1
      },
      "createdAt": "2024-04-21T12:24:06.877+00:00",
      "date": "2024-04-21",
      "invoiceId": 3,
      "status": 1,
      "paymentFees": 1,
      "stripePaymentIntentId": null
    }
  ]
}

Used to issue a payment against an invoice.

Input variables

invoiceId: id of the invoice (path variable)
json representation of a payment object
- amount (decimal)
- privateNotes (if any)
- publicNotes (if any)
- paymentmethod: the id of a payment method. The defaults are 1 Cash, 2 Bank Transfer, 3 Online, 4 Check, but methods are configured per school - call GetPaymentMethods for the list that applies to yours.
- createdAt (optional)

A payment recorded here is always settled

This endpoint records money the school already has in hand, so the payment is created with status 1 (VALID) and counts towards the invoice’s paidAmount immediately.

status, paymentFees and stripePaymentIntentId are read-only and ignored if sent - they describe what a payment provider did, and this endpoint takes no payment. Card and bank payments reach the invoice through Stripe instead, and those are the ones that can appear with status 2 (failed) or 3 (still clearing).

The response is the updated invoice, whose payments array carries these fields for every payment on it.

Used to issue a payment against an invoice. Input variables - invoiceId: id of the invoice (path variable) - json representation of a payment object - amount (decimal) - privateNotes (if any) - publicNotes (if any) - paymentmethod: the id of a payment method. The defaults are 1 Cash, 2 Bank Transfer, 3 Online, 4 Check, but methods are configured per school - call GetPaymentMethods for the list that applies to yours. - createdAt (optional) ## A payment recorded here is always settled This endpoint records money the school already has in hand, so the payment is created with `status` 1 (VALID) and counts towards the invoice's `paidAmount` immediately. `status`, `paymentFees` and `stripePaymentIntentId` are read-only and ignored if sent - they describe what a payment provider did, and this endpoint takes no payment. Card and bank payments reach the invoice through Stripe instead, and those are the ones that can appear with status 2 (failed) or 3 (still clearing). The response is the updated invoice, whose `payments` array carries these fields for every payment on it.

Path parameters

invoiceIdstringRequired

Headers

Request

This endpoint expects an object.

amountdoubleRequired

publicNotesstringRequired

paymentmethodobjectRequired

createdAtdatetimeRequired

privateNotesanyOptional

Response

idinteger

invoiceRefIdstring

amountdouble

paidAmountdouble

statusinteger

fullnamestring

addressstring

telephonestring

emailstringformat: "email"

createdAtdatetime

issueDatedate

dueDatedate

publicNotesstring

feeslist of objects

paymentslist of objects