Invoice

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

Represents a single invoice for the application.

URI
/api/v9/applications/ID/invoices/ID

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.

Get an invoice

Retrieve information about a particular application invoice.

Syntax
GET /api/v9/applications/123/invoices/321
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/applications/123/invoices/321"

Response headers

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 was successfully returned
`404 Not Found`	The invoice was not found

Example response

Response
{
  "id": 527,
  "type": "Invoice",
  "nr": "AF-101031225",
  "serie": {
    "id": 2,
    "name": "Application fee"
  },
  "applicant": "/api/v9/applicants/423",
  "application": "/api/v9/applications/415",
  "course": "/api/v9/courses/33",
  "deadline": "2025-12-17",
  "issued": "2025-12-03T13:15:31+00:00",
  "delivered": "2025-12-03T13:15:31+00:00",
  "reminder": true,
  "reminded": null,
  "collected": "2025-12-04T07:06:40+00:00",
  "currency": "EUR",
  "items": [
    {
      "item": "Application fee (one-time)",
      "price": "20.00",
      "qty": "1.00",
      "unit": null,
      "inventory_item_ID": null
    },
    {
      "item": "Discount \"ADVISOR\"",
      "price": "-3.00",
      "qty": "1.00",
      "unit": null,
      "inventory_item_ID": null
    }
  ],
  "collections": {
    "41": {
      "id": 41,
      "amount": "17.00",
      "invoice": "/api/v9/invoices/527",
      "inserted": "2025-12-04T07:06:40+00:00",
      "collected": "2025-12-04",
      "administrator": null,
      "payment": {
        "payment": "01KBM2X9KYE7WBY25DFNMXNS4R",
        "external_id": "pi_3SaWcb3BsCbItDpn02T9muKv",
        "status": "captured",
        "message": null,
        "inserted": "2025-12-04T07:06:02+00:00",
        "updated": "2025-12-04T07:06:40+00:00",
        "gateway": {
          "id": 39,
          "name": "Stripe",
          "adapter": "Stripe"
        }
      }
    }
  },
  "instructions": "Account Name: Institute of Technology BE\r\nKBC Bank:\r\nIBAN: BE75 ABCD 1234 5678 90XY\r\nBIC/SWIFT Code: KREDBEBB",
  "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.",
  "payer": {
    "name": "John Smith",
    "email": "john.smith@email.com"
  }
}

Invoices

References