GetInvoices
Headers
Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.
Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.
Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.
Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.
Returns a list of invoices based on issue date, due date and status
Input variables
amount, which never includes it. Stripe collects amount + paymentFees as a single charge, so this is what reconciles a payment against a Stripe payout.All three are read-only: they report what the payment provider did and are never accepted in a request body.
An invoice’s payments are every attempt made against it, not only the money it received. A declined card records a payment row of its own, so the array can total more than paidAmount. Only status 1 rows move paidAmount, and only those sum to it.
status 3 is not a failure: bank debits (ACH) sit there for 3-5 business days while they clear. Count 1 as received, exclude 2, and report 3 separately as pending receipts.
A retried card charge is billed for the invoice’s remaining balance, so repeated attempts carry identical amounts. The amount alone cannot separate a failed retry from a genuine instalment — use status.
The example response below shows this: two settled payments of 5.25 summing to paidAmount 10.50, alongside a declined 10.50 card attempt that does not.
Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.