Invoice

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

Represents a single invoice for an application.

URI
/api/v10/applications/ID/invoices/ID

GDPR information

Due to GDPR regulations, you can delete applicants from the system using the Right to be forgotten tool, batch purges (by academic term) or individual applicant record deletions.

To preserve the accounting history, DreamApply retains invoices in the system after an applicant record is deleted. During deletion, it detaches invoices from the applicant records, removing the data association. As a result:

  • In the list of invoices, these invoices are marked with the anonymous icon.
  • In the API response, the applicant and application fields are set to null.

The collected field indicates whether an invoice is paid in full. Partial collections do not update this field. Collections in excess reset this field to null. If you edit an invoice after the payment and this edit changes the invoice amount, this field is also set to null. For invoices with a value of 0, the field value remains undefined.

GET Get an invoice

Retrieve information about a specific invoice created for an application.

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

Response headers

HeaderValueDescription
Content-Typeapplication/jsonThe media type of the resource
Content-Length1234The size of the response body in bytes

Response codes

Response codeDescription
200 OKThe invoice was successfully returned
404 Not FoundThe invoice was not found

Example response

Response
{
  "id": 527,
  "type": "Invoice",
  "nr": "AF-101031225",
  "serie": {
    "id": 2,
    "name": "Application fee"
  },
  "applicant": "/api/v10/applicants/423",
  "application": "/api/v10/applications/415",
  "course": "/api/v10/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/v10/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"
  }
}

See Also

Previous

Invoices

Next

Flags