Differences

This shows you the differences between two versions of the page.

--- api:api_applicants_id_invoices [2018/10/17 11:40] – Lauri
+++ api:api_applicants_id_invoices [2025/01/24 10:26] (current) – [GDPR information] Lauri
@@ Line 1: / Line 1: @@
 ====== /api/applicants/ID/invoices ======
-===== HEAD, GET =====
+===== GDPR information =====
-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.
-==== GDPR information ====
+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''.
-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.
+:!: 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.
+===== HEAD, GET =====
-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 a list of invoices that have been issued for the applicant in question.
 ==== Syntax ====
@@ Line 28: / Line 29: @@
         "nr": "TUIT-123/2014",
         "applicant": "/api/applicants/65",
+        "application": "/api/applications/70",
+        "course": "/api/courses/5",
         "issued": "2014-07-12T12:09:42+00:00",
         "delivered": "2014-07-12T12:09:57+00:00",
+        "deadline": "2019-09-17",
         "reminded": null,
         "collected": null,
@@ Line 47: / Line 51: @@
         "nr": "APPF-223/2014",
         "applicant": "/api/applicants/65",
+        "application": "/api/applications/70",
+        "course": null,
         "issued": "2014-07-17T10:54:19+00:00",
         "delivered": "2014-07-17T10:54:19+00:00",
+        "deadline": "2019-09-17"
         "reminded": null,
         "collected": null,