/api/applicants/ID/invoices

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

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 field is set to NULL.

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

Content-Type: application/json
Content-Length: 1234

{
  "1": {
      "nr": "TUIT-123/2014",
      "applicant": "/api/applicants/65",
      "issued": "2014-07-12T12:09:42+00:00",
      "delivered": "2014-07-12T12:09:57+00:00",
      "reminded": null,
      "collected": null,
      "items": [
          {
              "item": "Tuition fee",
              "price": "1899",
              "qty": "1",
              "unit": "-"
          }
      ],
      "currency": "EUR",
      "instructions": "dfgsdfgs dfgs\r\ndfg\r\nsdfg\r\nsd\r\nfgsdfgsdfgsdfg",
      "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/2014",
      "applicant": "/api/applicants/65",
      "issued": "2014-07-17T10:54:19+00:00",
      "delivered": "2014-07-17T10:54:19+00:00",
      "reminded": null,
      "collected": null,
      "items": [
          {
              "item": "Appfee",
              "price": "44",
              "qty": "1",
              "unit": "-"
          }
      ],
      "currency": "EUR",
      "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."
  },
}