Invoices

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

Represents a list of all issued invoices.

URI
/api/v9/invoices

GET List invoices

List invoices using the filters set as parameters. The number of invoices is represented in the X-Count header.

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

Parameters

NameRequired/OptionalDescriptionNotes
byIssuedSinceOptionalISO 8601 datetime. Only show invoices issued after this.
byCollectedSinceOptionalISO 8601 datetime. Only show invoices collected after this.
byApplicantIDsOptionalList of applicant IDs[1] 
bySerieIDsOptionalList of series IDs[1] 
byCurrenciesOptionalList of 3-letter currency symbols[1]
byCollectedOptionalSet true to only fetch invoices that have been collected. Set false to only fetch invoices that have not been collected yet.
byOverdueOptionalSet true to only fetch invoices that are overdue (not collected and the deadline has passed). Set false to fetch invoices that are not overdue (collected or deadline not yet arrived).

Notes

Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators — in other words an application is considered matching if it matches to any of the values in the list.

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/invoices?bySerieIDs=2&byCollected=true"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonMedia type of the resource
Content-Length1234Size of the response body in bytes
X-Count3Number of issued invoices

Response codes

Response codeDescription
200 OKThe list of invoices was successfully returned

Example response

Response
{
  "100": {
    "id": 100,
    "type": "Invoice",
    "nr": "AF-100261125",
    "serie": {
      "id": 2,
      "name": "Application fee"
    },
    "applicant": "/api/v9/applicants/302",
    "application": "/api/v9/applications/413",
    "course": "/api/v9/courses/33",
    "deadline": "2025-12-10",
    "issued": "2025-11-26T07:22:09+00:00",
    "delivered": "2025-11-26T07:22:09+00:00",
    "reminder": true,
    "reminded": null,
    "collected": "2025-12-04T11:13:12+00:00",
    "currency": "EUR",
    "items": [
      {
        "item": "Application fee (one-time)",
        "price": "20.00",
        "qty": "1.00",
        "unit": null,
        "inventory_item_ID": null
      }
    ],
    "collections": {
      "42": {
        "id": 42,
        "amount": "20.00",
        "invoice": "/api/v9/invoices/100",
        "inserted": "2025-12-04T11:13:12+00:00",
        "collected": "2025-12-04",
        "administrator": null,
        "payment": {
          "payment": "01KBMH0V2NEYHBMZ776D4K48G0",
          "external_id": "pi_3SaaTA3BsCbItDpn1Z0rGSdW",
          "status": "captured",
          "message": null,
          "inserted": "2025-12-04T11:12:39+00:00",
          "updated": "2025-12-04T11:13:12+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": "Tasmin Welsh",
      "email": "tasminwelsh@gmail.com"
    }
  },
  "200": {
    "id": 200,
    "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/200",
        "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"
    }
  }
}

Previous

Intakes

Next

Invoice