ConnectCloud Developers

The tenant's document types in their order (tenant:dms:read or tenant:settings:read)

GET /api/dms/v1/document-types

Module: DMS · operationId: listDocumentTypes · Tag: Document types · Auth: access token (Authorization: Bearer <accessToken>)

Responses

  • 200 Document types (application/json)

Fields of the 200 answer:

  • items (array of DocumentType, required): The document types in their order
    • code (string, required): Code of the type, used as category
    • createdAt (string (date-time), required): Creation time
    • isActive (boolean, required): Only active types can be chosen for uploads
    • name (string, required): Display name
    • platform (boolean, required): Used by the platform (mail, outgoing_invoice or assigned to a role); cannot be deleted or deactivated
    • retentionYears (integer, required): Retention period of documents of the type in years
    • sortOrder (integer, required): Position in the list
    • updatedAt (string (date-time), required): Time of the last change
    • classifierDescription (string): Tells the document classifier when the type applies; types without one are never chosen (except the type of the Original-Eingangsbeleg) (max length 1000)
    • defaultFolderId (string (uuid)): Uploads of this type without a folder are filed here
    • role (string): Role the type is assigned to, if any (one of incoming_original, incoming_supplement)
    • targetModule (string): Module that processes classified documents of the type; none only files them (one of none, trade.invoice, trade.delivery_note, trade.order_confirmation, hr)
  • total (integer, required): Number of types

Example 200 answer:

{
  "items": [
    {
      "classifierDescription": "Eingangsrechnung, Gutschrift oder Rechnungskorrektur eines Lieferanten: Rechnungsnummer, Rechnungsdatum und ein zu zahlender oder zu erstattender Betrag.",
      "code": "incoming_document",
      "createdAt": "2026-01-02T08:00:00Z",
      "defaultFolderId": "3b1f6a2c-7d4e-4f1a-9c2b-8e5d0a1f7b63",
      "isActive": true,
      "name": "Eingangsbeleg",
      "platform": true,
      "retentionYears": 10,
      "role": "incoming_original",
      "sortOrder": 1,
      "targetModule": "trade.invoice",
      "updatedAt": "2026-01-02T08:00:00Z"
    },
    {
      "classifierDescription": "Lieferschein: begleitet eine Warenlieferung und listet gelieferte Artikel und Mengen, meist ohne Preise und ohne Zahlungsaufforderung.",
      "code": "delivery_note",
      "createdAt": "2026-01-02T08:00:00Z",
      "isActive": true,
      "name": "Lieferschein",
      "platform": false,
      "retentionYears": 8,
      "sortOrder": 3,
      "targetModule": "trade.delivery_note",
      "updatedAt": "2026-01-02T08:00:00Z"
    }
  ],
  "total": 2
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/dms/v1/document-types' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI