Invoices

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of invoices issued to the applicant.

URI
/api/v9/applicants/ID/invoices

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.

List invoices

Get a list of invoices that have been issued for the applicant in question.

Syntax
GET /api/v9/applicants/123/invoices
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applicants/123/invoices"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`2`	Number of returned invoices

Response codes

Response code	Description
`200 OK`	The list of invoices was successfully returned

Example response

Response
{
  "1": {
    "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."
  },
  "2": {
    "nr": "APPF-223/2025",
    "applicant": "/api/v9/applicants/65",
    "application": "/api/v9/applications/70",
    "course": null,
    "issued": "2025-07-17T10:54:19+00:00",
    "delivered": "2025-07-17T10:54:19+00:00",
    "deadline": "2019-09-17",
    "reminded": null,
    "collected": null,
    "items": [
      {
        "item": "Appfee",
        "price": "44",
        "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."
  }
}

Trackers

Invoice