Invoice series

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

Represents a list of invoice series.

URI
/api/v9/invoices/series

List invoice series

List all invoice series set up in the system. Invoice series are used to generate new numbers for invoices under a specific series. For example, invoice for appfees and tuition fees may be issued with different series and thus will maintain a different numbering scheme.

Format markers

Marker	Description
`%inc%`	Number (continuous)
`%incYearly%`	Number (re-started yearly)
`%incMonthly%`	Number (re-started monthly)
`%incDaily%`	Number (re-started daily)
`%yearLong%`	Year number (long, i.e. 2023)
`%yearShort%`	Year number (short, i.e. 23)
`%month%`	Month number (zero-padded, i.e. 02)
`%day%`	Day number (zero-padded. i.e. 31 or 03)

Syntax
GET /api/v9/invoices/series
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/series"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`15`	Number of returned series

Response codes

Response code	Description
`200 OK`	The list of series was successfully returned

Example response

Response
{
  "1": {
    "id": 1,
    "name": "Tuition fee",
    "format": "TF-%incYearly%%day%%month%%yearShort%",
    "last": {
      "when": "2025-10-21T07:02:40+00:00",
      "number": "TF-9211025"
    }
  },
  "2": {
    "id": 2,
    "name": "Application fee",
    "format": "AF-%incYearly%%day%%month%%yearShort%",
    "last": {
      "when": "2025-12-16T09:54:07+00:00",
      "number": "AF-105161225"
    }
  },
  "100": {
    "id": 100,
    "name": "Default invoice series",
    "format": "%inc%",
    "last": {
      "when": "2025-04-29T10:28:47+00:00",
      "number": "57"
    }
  },
  "200": {
    "id": 200,
    "name": "Shopping invoice series",
    "format": "SH-%yearShort%%inc%",
    "last": {
      "when": "2025-05-08T12:22:51+00:00",
      "number": "SH-25386"
    }
  }
}

Invoice

Transactions