Invoice
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single issued invoice.
URI
/api/v9/invoices/IDGET Get an invoice
Return information about an invoice identified by the invoice ID.
Syntax
GET /api/v9/invoices/123
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/invoices/123"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 data was successfully returned |
404 Not Found | The invoice was not found |
Example response
Response
{
"id": 1,
"type": "Invoice",
"nr": "1",
"serie": {
"id": 100,
"name": "Default invoice series"
},
"applicant": "/api/v9/applicants/2",
"application": "/api/v9/applications/2",
"course": null,
"deadline": "2023-08-15",
"issued": "2023-04-27T16:00:00+00:00",
"delivered": "2023-04-27T16:00:00+00:00",
"reminder": true,
"reminded": null,
"collected": null,
"currency": "EUR",
"items": [
{
"item": "Tuition fee",
"price": "1000.00",
"qty": "1.00",
"unit": null,
"inventory_item_ID": null
}
],
"collections": {},
"instructions": "Bank account details:\r\n\r\nDREAMAPPLY BANK\r\n\r\nSwift Code : DREAMBNK\r\n\r\nIBAN : EE12 1234 1234 1234 1234",
"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": "j.smith@example.com"
}
}DELETE Delete an invoice
Delete an invoice identified by a specific ID.
Syntax
DELETE /api/v9/invoices/123
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X DELETE \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/invoices/123"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The invoice was successfully deleted |
404 Not Found | The invoice was not found |