Invoice
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single invoice issued to the applicant.
/api/v9/applicants/ID/invoices/IDGDPR information
Due to GDPR regulations, it is possible to delete applicants from the system, for example with the Right to be forgotten tool, batch purge (by academic term) or with an individual applicant record deletion.
However, in order to not destroy accounting records, invoices are the only data that is preserved after an applicant record is destroyed. To achieve this, invoices are detached from the applicant records, losing this association. This is why in the admin UI they are distinctive with a gray anonymous icon and also why in the API response the applicant and application field is set to null.
The response field collected designates that the invoice has been collected in full. Partial collections will not set this field, also collections in excess will reset this field back to null. In addition, it is possible to edit the invoice after the payment — if the invoice amount is changed as a result, this field will also be cleared. In short, this field indicates whether the invoice is currently paid in full. The only exception is 0 invoices, in which case the field value is undefined.
GET Get an invoice
Retrieve information about a particular applicant invoice.
GET /api/v9/applicants/123/invoices/321
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applicants/123/invoices/321"| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The invoice data was successfully returned |
404 Not Found | The invoice was not found |
Example response
{
"nr": "TUIT-123/2025",
"applicant": "/api/v9/applicants/65",
"application": "/api/v9/applications/70",
"course": "/api/v9/courses/5",
"issued": "2025-07-12T12:09:42+00:00",
"delivered": "2025-07-12T12:09:57+00:00",
"deadline": "2019-09-17",
"reminded": null,
"collected": null,
"items": [
{
"item": "Tuition fee",
"price": "1899",
"qty": "1",
"unit": "-"
}
],
"currency": "EUR",
"instructions": "Some instructions",
"smallprint": "Please make sure that you include the invoice number in the payment transaction. Otherwise the payment may not get properly processed.\r\n\r\nThis invoice has been issued electronically and is valid without a signature. The invoice is issued in accordance to the region that you specified during your registration. If the region (and the currency) is not correct, please contact us for re-issuance."
}