Module

DMS

Das DMS ist die zentrale Ablage für Dateien — Verträge, Rechnungen, Personalakte, Compliance-Nachweise. Versionen, Anhänge und Inhalts-Layer liegen direkt am dms_document-Datensatz; die Datei-Storage-Schicht ist über den separaten File-Upload-Flow getrennt.

Resources – Inhalte

Resource	Pfad	Permission-Präfix
Dokumente	`/api/v1/dms_documents`	`dms_document`
Ordner	`/api/v1/dms_folders`	`dms_folder`
Dokumenttypen	`/api/v1/dms_document_types`	`dms_document_type`
Annotationen	`/api/v1/dms_annotations`	`dms_annotation`
Kommentare	`/api/v1/dms_comments`	`dms_comment`
Templates	`/api/v1/dms_templates`	`dms_template`
Form-Layouts	`/api/v1/dms_form_layouts`	`dms_form_layout`
Sharing-Links	`/api/v1/dms_shares`	`dms_share`
Signaturen	`/api/v1/dms_signatures`	`dms_signature`
Signatur-Anfragen	`/api/v1/dms_signing_requests`	`dms_signing_request`

Resources – Verarbeitung & Storage

Resource	Pfad	Permission-Präfix
Filing-Regeln	`/api/v1/dms_filing_rules`	`dms_filing_rule`
Parser	`/api/v1/dms_parsers`	`dms_parser`
Extraction-Feedback	`/api/v1/dms_extraction_feedback`	`dms_extraction_feedback`
Retention-Policies	`/api/v1/dms_retention_policies`	`dms_retention_policy`
Storage-Backends	`/api/v1/dms_storage_backends`	`dms_storage_backend`
DATEV-Exports	`/api/v1/dms_datev_exports`	`dms_datev_export`
SharePoint-Sync-Logs	`/api/v1/dms_sharepoint_sync_logs`	`dms_sharepoint_sync_log`
Sync-Konflikte	`/api/v1/dms_sync_conflicts`	`dms_sync_conflict`

Schemas

Document

dms_documents4 Permissions

Schema for validating DMS document entities (Dokumentenverwaltung)

title string erforderlich

Document title

1–500 Zeichen

description string optional

Optional description or summary

nullable

documentTypeId uuid optional

Reference to dms_document_types (custom document type)

nullable

documentType string optional

Legacy document type string (deprecated, use documentTypeId)

nullable

customFields object optional

Custom field values defined by the document type schema

nullable

status string erforderlich

Document lifecycle status

Werte

DRAFTNEEDS_REVIEWAPPROVEDREJECTEDBOOKEDARCHIVED

Default: "DRAFT"

partyId uuid optional

Linked CRM party

nullable

contactPartyId uuid optional

Linked contact person

nullable

contractId uuid optional

Linked contract

nullable

projectId uuid optional

Linked project

nullable

employeeId uuid optional

Linked employee profile

nullable

assignedToId uuid optional

Assigned user for review

nullable

customerVisible boolean optional

When true, document is published on the project customer portal (requires project.customerAccess feature releasedDocuments).

Default: false

customerUploaded boolean optional

True if the document was uploaded by a customer via the public portal.

Default: false

uploadedByPartyId uuid optional

Customer party that uploaded this file (set when customerUploaded = true).

nullable

orgUnitId uuid optional

Owning org unit

nullable

tags string[] optional

Manual + auto tags

Default: []

folderId uuid optional

Reference to dms_folders entity

nullable

folderPath string optional

Virtual folder path (e.g. /invoices/2026/)

max 1000 Zeichennullable

checkedOutBy uuid optional

User ID who has this document checked out

read-onlynullable

checkedOutAt datetime optional

When the document was checked out

read-onlynullable

lockExpiresAt datetime optional

Auto-release lock after this time (default 24h)

read-onlynullable

fileId uuid optional

Reference to files collection

nullable

mimeType string optional

MIME type of the document file

nullable

sizeBytes number optional

File size in bytes

≥ 0nullable

s3Key string optional

S3 storage key

nullable

thumbnailS3Key string optional

S3 key for thumbnail image

nullable

pageCount number optional

Number of pages (PDF)

≥ 0nullable

extractedText string optional

Full text extracted from document for search

nullable

textExtractionStatus string optional

Text extraction pipeline status

Werte

PENDINGCOMPLETEFAILED

nullable

ocrStatus string optional

OCR processing status

Werte

NOT_NEEDEDPENDINGCOMPLETEFAILED

nullable

ocrMethod string optional

Which OCR method produced the text

Werte

tesseractai-vision

nullable

ocrConfidence number optional

OCR confidence score (0-100)

0 – 100nullable

ocrError string optional

Reason why the last OCR attempt failed (exception message or diagnostic hint)

nullable

searchablePdfS3Key string optional

S3 key for the searchable PDF (original + invisible OCR text layer)

nullable

classificationConfidence number optional

Classification confidence score 0-1

0 – 1nullable

classificationSource string optional

How the document was classified. EINVOICE = ZUGFeRD/XRechnung Pre-Classifier matched the embedded SellerTradeParty/BuyerTradeParty against the tenant identity.

Werte

LLMRULEMANUALEINVOICE

nullable

classificationTrace object optional

Diagnose-Spur der letzten Klassifikation: welche Regeln matchten, welche E-Invoice-Felder die Tenant-Identität trafen, oder bei MANUAL der vorherige Doktyp. Zeigt im UI „Warum wurde dieses Dokument so klassifiziert?".

nullable

source string optional

Werte

LLMRULEMANUALEINVOICE

at datetime optional

confidence number optional

0 – 1nullable

winnerScore number optional

nullable

winnerName string optional

nullable

candidates object[] optional

nullable

documentTypeId string optional

documentTypeName string optional

nullable

score number optional

vetoed boolean optional

isWinner boolean optional

evaluations object[] optional

pattern string optional

patternType string optional

Werte

keywordregexbuiltin

weight number optional

field string optional

nullable

position string optional

nullable

required boolean optional

nullable

matched boolean optional

matchedSnippet string optional

nullable

contributedScore number optional

einvoiceFormat string optional

nullable

einvoiceMatchedOn string optional

Werte

vendor.ibanvendor.vatIdbuyer.vatId

nullable

einvoiceVendorName string optional

nullable

einvoiceVendorIban string optional

nullable

einvoiceVendorVatId string optional

nullable

einvoiceBuyerName string optional

nullable

einvoiceBuyerVatId string optional

nullable

previousDocumentTypeId string optional

nullable

previousDocumentTypeName string optional

nullable

previousSource string optional

nullable

manualByUserId string optional

nullable

retentionPolicyId uuid optional

Applied retention policy

nullable

retentionExpiresAt datetime optional

When retention period expires

nullable

retentionStartAt datetime optional

Zeitpunkt, an dem die Aufbewahrungsuhr gestartet ist (abgeleitet aus retentionStartTrigger des Doctypes).

read-onlynullable

retentionUntil datetime optional

Berechneter Ablauf der Aufbewahrungspflicht. Vor diesem Zeitpunkt blockiert der Soft-Delete-Endpoint und (bei retentionMode=compliance) auch S3 jede Löschung.

read-onlynullable

retentionMode string optional

Effektiver Object-Lock-Modus dieses Dokuments (vom Doctype geerbt, beim Lock-Apply eingefroren).

Werte

nonegovernancecompliance

read-onlynullable

s3VersionId string optional

S3-VersionId des PUT, an dem der Object-Lock haftet. Pflicht, weil Lock immer auf eine konkrete Version greift.

max 200 Zeichenread-onlynullable

s3ObjectLockApplied boolean optional

Sanity-Flag: true sobald PutObjectRetention erfolgreich gegen S3 gefeuert wurde. Daily-Integrity-Job verifiziert via GetObjectRetention.

Default: falseread-only

contentSha256 string optional

Hex-codierter SHA-256-Hash des Originalinhalts beim Upload. Daily-Integrity-Job vergleicht gegen neu berechneten Hash zur Manipulationsprüfung (GoBD Rz. 110 Unveränderbarkeit).

Patternread-onlynullable

legalHold object optional

Aufbewahrungs-Sperre (S3 PutObjectLegalHold). Wenn active=true, blockiert jede Löschung — auch nach Ablauf von retentionUntil. Verwendung: Steuerprüfung, Litigation Hold, Audit.

read-onlynullable

active boolean erforderlich

reason string optional

max 500 Zeichennullable

setBy uuid erforderlich

setAt datetime erforderlich

releasedBy uuid optional

nullable

releasedAt datetime optional

nullable

caseRef string optional

Aktenzeichen / Case-ID für Audit-Trail

max 200 Zeichennullable

documentVersions object[] optional

Previous versions of this document

Default: []

versionNumber number erforderlich

≥ 1

s3Key string erforderlich

uploadedBy uuid erforderlich

uploadedAt datetime erforderlich

changeNote string optional

nullable

sizeBytes number optional

nullable

linkedEntities object[] optional

Links to other entities

Default: []

entityType string erforderlich

entityId uuid erforderlich

role string optional

nullable

incomingInvoice object optional

Incoming invoice specific data (Eingangsrechnung)

nullable

vendorPartyId uuid optional

Matched CRM party for vendor

nullable

vendorName string optional

nullable

vendorTaxId string optional

Steuernummer or USt-IdNr

nullable

vendorIban string optional

nullable

invoiceNumber string optional

nullable

invoiceDate date optional

nullable

dueDate date optional

nullable

netAmount string optional

Patternnullable

vatAmount string optional

Patternnullable

grossAmount string optional

Patternnullable

currency string optional

max 3 ZeichenDefault: "EUR"

lineItems object[] optional

Default: []

description string optional

quantity string optional

Patternnullable

unitPrice string optional

Patternnullable

vatRate number optional

nullable

netAmount string optional

Patternnullable

articleNumber string optional

nullable

paymentTerms string optional

nullable

paymentReference string optional

Verwendungszweck / payment reference

nullable

zugferdVersion string optional

nullable

xRechnungVersion string optional

nullable

extractionMethod string optional

Werte

ZUGFERDXRECHNUNGLLM_VISIONOCR_LLMPARSERMANUAL

nullable

extractionConfidence number optional

0 – 1nullable

extractionParserId uuid optional

Which dms_parser was used

nullable

corrections object[] optional

User corrections for feedback loop

Default: []

field string erforderlich

originalValue any optional

correctedValue any erforderlich

correctedBy uuid erforderlich

correctedAt datetime erforderlich

bookingReference string optional

nullable

datevExportedAt datetime optional

nullable

aiSummary string optional

AI-generated document summary

nullable

aiTags string[] optional

AI-suggested tags

nullable

suggestedFolderPath string optional

AI-suggested filing location

max 1000 Zeichennullable

suggestedFolderId uuid optional

AI-suggested folder ID

nullable

duplicateOfId uuid optional

Reference to potential duplicate document

nullable

duplicateConfidence number optional

Similarity score for duplicate detection (0-1)

0 – 1nullable

embeddingStatus string optional

Vector embedding generation status

Werte

PENDINGPROCESSINGDONEFAILED

nullable

lastEmbeddedAt datetime optional

When embeddings were last generated

nullable

entitySuggestions object[] optional

Default: nullnullable

entityType string erforderlich

entityId string erforderlich

displayName string erforderlich

confidence number erforderlich

0 – 1

reason string optional

nullable

entitySuggestionStatus string optional

Werte

PENDINGCOMPLETEFAILED

nullable

expiresAt datetime optional

Document expiry date (e.g. TÜV, certificates, warranties)

nullable

expiryNotificationDays integer optional

Days before expiry to send notification

1 – 365Default: nullnullable

sharePointItemId string optional

nullable

sharePointDriveId string optional

nullable

sharePointWebUrl string optional

nullable

sharePointChangeTag string optional

nullable

sharePointLastModifiedAt datetime optional

nullable

syncSource string optional

Werte

localsharepoint

nullable

lastSyncedAt datetime optional

nullable

syncError string optional

nullable

sharePointCreatedByAadId string optional

read-onlynullable

sharePointCreatedByUpn string optional

read-onlynullable

sharePointCreatedByEmail string optional

read-onlynullable

sharePointCreatedByDisplayName string optional

read-onlynullable

sharePointCreatedByUserId uuid optional

Resolved Codemeta user ID matching the SharePoint uploader (via AAD object ID, UPN, or email). Null when no match found.

read-onlynullable

backendId uuid optional

Storage backend currently holding the bytes.

nullable

backendItemId string optional

Backend-specific item id (e.g. Graph driveItem id, S3 key, FS path).

max 500 Zeichennullable

backendETag string optional

Backend ETag at last sync — used for 3-way conflict detection.

max 500 Zeichennullable

appliedFilingPolicyId uuid optional

Filing policy most recently applied to this document.

nullable

resolvedPath string optional

Backend-absolute path at the time of last filing (audit + quick display).

max 2000 Zeichennullable

originalBackendPath string optional

Pfad, an dem das Dokument beim Inbound-Sync ursprünglich lag (z.B. "/Kunden/ACME/Rechnungen/file.pdf"). Quelle der Pfad-Hoheit, wenn keine Filing-Policy mit overrideBackendPath greift.

max 2000 Zeichennullable

originalBackendId uuid optional

Backend, das das Dokument ursprünglich geliefert hat (Inbound-Origin). Bleibt stabil, auch wenn ein späterer Move das aktive Backend ändert.

nullable

pathSource string optional

Welcher Pfad gewinnt aktuell als resolvedPath: "origin" = Backend-Original (Inbound), "policy" = Filing-Policy-Template.

Werte

originpolicy

nullable

filingStatus string optional

Filing lifecycle state (ADR 0051).

Werte

unfiledinboxfiledmisfiledfiling_failedmissing_in_backend

Default: "unfiled"

syncState string optional

Conflict-locking state-machine (ADR 0052 §7.4).

Werte

cleanpending_outboundpending_inboundconflictrenamingmigrating

Default: "clean"

requiresHumanReview boolean optional

Ingestion-Inbox quarantine flag (ADR 0051 §7.2.5).

Default: false

classification string optional

Sensitivity classification used by filing policies (§9.4).

Werte

publicinternalconfidentialstrictly_confidential

nullable

processingStartedAt datetime optional

When the post-ingestion pipeline acquired this lock. Null = idle.

nullable

processingJobId string optional

BullMQ jobId of the running pipeline (used for explicit cancellation).

max 200 Zeichennullable

processingStage string optional

Current pipeline stage — surfaced to the user as a progress hint.

Werte

ocrclassifyextractfile

nullable

processingExpiresAt datetime optional

Lock TTL — past this point the lock is considered stale.

nullable

processingCancelledAt datetime optional

Set by POST /dms/documents/:id/unlock. The worker checks this between stages and bails on the next stage boundary.

nullable

lastOutboundMoveAt datetime optional

Timestamp of the most recent successful outbound move/push.

nullable

lastOutboundMoveJobId string optional

BullMQ jobId of the last outbound-move attempt (used for diagnostics and idempotency).

max 200 Zeichennullable

outboundMoveAttempts integer optional

Total outbound-move attempts (increments on every CAS-lock acquisition).

≥ 0Default: 0

encryptionOverride string optional

Per-document override of the document type's defaultEncryption. null = inherit from type.

Werte

nonezero-knowledge

nullable

encryption object optional

Encryption metadata for ZK-protected files. Set on upload, never mutated; rotation requires re-upload.

nullable

mode string erforderlich

Currently only zero-knowledge is supported.

Werte

zero-knowledge

alg string erforderlich

Werte

AES-256-GCM

Default: "AES-256-GCM"

iv string erforderlich

Base64-encoded 12-byte IV used to encrypt the file body.

max 32 Zeichen

keyId string optional

Optional identifier for the per-document DEK (e.g. UUIDv7 generated client-side).

max 64 Zeichennullable

wrappedKeys object[] erforderlich

Per-recipient wraps of the per-document DEK. Each entry mirrors vault_customer_keys.memberKeys.

min 1 Items

type string erforderlich

Werte

userteamrole

id string erforderlich

max 200 Zeichen

wrappedKey string erforderlich

max 1024 Zeichen

ephemeralPublicKey string optional

max 1024 Zeichennullable

addedAt datetime optional

nullable

addedBy uuid optional

nullable

notes string optional

Free-text notes

nullable

Folder

dms_folders4 Permissions

Schema for validating DMS folder entities (Ordnerstruktur)

name string erforderlich

Folder display name

1–200 Zeichen

parentId uuid optional

Parent folder ID (null = root level)

nullable

path string optional

Full materialized path (e.g. /Rechnungen/2026/)

max 2000 Zeichenread-only

description string optional

max 1000 Zeichennullable

icon string optional

Icon name for display

max 50 Zeichennullable

color string optional

Color hex for display

max 20 Zeichennullable

defaultDocumentTypeId uuid optional

Default document type for uploads into this folder

nullable

retentionPolicyId uuid optional

Retention policy inherited by documents in this folder

nullable

sortOrder number optional

Sort order among siblings

Default: 0

createdFromTemplateId uuid optional

Folder template that produced this folder (for traceability and re-apply).

nullable

linkedEntityType string optional

Entity type this folder belongs to (party, project, vehicle, …).

max 100 Zeichennullable

linkedEntityId uuid optional

Entity ID this folder belongs to.

nullable

backendId uuid optional

Storage backend that physically holds this folder (if any).

nullable

backendItemId string optional

Backend-specific folder identifier (e.g. Graph driveItem id).

max 500 Zeichennullable

resolvedPath string optional

Backend-absolute path at creation time (audit + quick display).

max 2000 Zeichennullable

sharePointChangeTag string optional

Backend eTag at last sync — used for echo-suppression and 3-way conflict detection.

nullable

sharePointLastModifiedAt datetime optional

SharePoint lastModifiedDateTime captured at last sync.

nullable

sharePointWebUrl string optional

SharePoint webUrl for direct linkback from DMS UI.

nullable

syncSource string optional

Origin of the most recent write. Drives echo-suppression in the opposite direction.

Werte

localsharepoint

nullable

lastSyncedAt datetime optional

Last successful sync timestamp (in or out).

nullable

syncError string optional

Last sync error message — cleared on successful sync.

nullable

syncState string optional

Conflict-locking state-machine for folder sync (mirrors dms_document.syncState).

Werte

cleanpending_outboundpending_inboundconflictrenamingmigrating

Default: "clean"

filingStatus string optional

Folder filing state. missing_in_backend = SharePoint counterpart no longer exists (K2 scenario).

Werte

unfiledfiledfiling_failedmissing_in_backend

nullable

originalBackendPath string optional

Path at which the folder was first discovered on the backend — source of truth for path-source: origin.

max 2000 Zeichennullable

originalBackendId uuid optional

Backend that originally delivered this folder (inbound origin). Stable across later moves.

nullable

pathSource string optional

Which path currently wins as resolvedPath: "origin" = backend, "policy" = filing policy template.

Werte

originpolicy

nullable

lastOutboundMoveAt datetime optional

Timestamp of the most recent successful outbound folder operation.

nullable

lastOutboundMoveJobId string optional

BullMQ jobId of the last outbound-folder attempt (diagnostics + idempotency).

max 200 Zeichennullable

outboundMoveAttempts integer optional

Total outbound attempts (increments on every CAS-lock acquisition).

≥ 0Default: 0

pathRewriteStatus string optional

Bulk path-rewrite progress after a folder move. null/done = idle.

Werte

pendingin_progressdone

nullable

pathRewriteCursor string optional

Cursor for chunked path-rewrite continuation (last processed _id).

max 100 Zeichennullable

pathRewriteFrom string optional

Source path prefix for the in-progress async rewrite.

max 2000 Zeichennullable

pathRewriteTo string optional

Target path prefix for the in-progress async rewrite.

max 2000 Zeichennullable

deletedInBackend boolean optional

SharePoint counterpart was deleted while DMS-side changes are still pending — needs conflict triage.

Default: false

deletedInBackendAt datetime optional

When the SP-side delete was first observed.

nullable

Document-Type

dms_document_types4 Permissions

Schema for defining DMS document types (Dokumententypen / Archive) with custom field definitions

name string erforderlich

Document type name (e.g. Eingangsrechnung, Vertrag)

1–200 Zeichen

key string optional

Stable snake_case identifier (e.g. incoming_invoice). Required + immutable for system types; optional for tenant-custom types.

1–100 ZeichenPatternread-onlynullable

isSystem boolean optional

Plattform-Seed. Nicht löschbar; key/scope/retentionMode immutable. Setzbar nur durch Seed-Service.

Default: falseread-only

scope string optional

Fachliche Gruppierung (Posteingang-Tabs, Berechtigungen, Reporting). System-Types tragen einen Scope; Custom-Types optional.

Werte

financesalesprocurementhrlegalcomplianceit_opsgeneral

read-onlynullable

description string optional

max 1000 Zeichennullable

icon string optional

Icon name from the Icons registry

max 50 Zeichennullable

color string optional

Badge color (hex or CSS variable)

max 20 Zeichennullable

fields object[] optional

Custom field definitions for this document type

Default: []

key string erforderlich

camelCase field identifier, used as key in customFields

1–100 ZeichenPatternread-only

label string erforderlich

Display label for the field

1–200 Zeichen

type string erforderlich

Field value type

Werte

texttextareanumbercurrencydatedatetimeselectmultiselectcheckboxrelation

required boolean optional

Default: false

options object[] optional

Options for select/multiselect fields

nullable

value string erforderlich

label string erforderlich

defaultValue any optional

Default value for new documents (any JSON value).

placeholder string optional

max 200 Zeichennullable

group string optional

Visual grouping label for form sections

max 100 Zeichennullable

sortOrder number optional

Display order within group

Default: 0

width number optional

Grid column width (out of 12)

Werte

346812

Default: 6

extractionHint string optional

Natural language hint for LLM extraction (e.g. "Rechnungsnummer")

max 500 Zeichennullable

extractionPath string optional

JSON path for structured data (e.g. ZUGFeRD XML)

max 200 Zeichennullable

relationConfig object optional

nullable

targetCollection string optional

Target collection (e.g. parties, contracts)

displayField string optional

Field to display from target (e.g. name)

defaultStatus string optional

Default status for new documents of this type

Werte

DRAFTNEEDS_REVIEWAPPROVEDREJECTEDBOOKEDARCHIVED

Default: "DRAFT"

autoExtract boolean optional

Auto-trigger LLM/OCR extraction on upload

Default: true

retentionDays number optional

Auto-archive after N days

≥ 1nullable

retentionPolicyId uuid optional

Linked retention policy

nullable

retentionMode string optional

S3 Object-Lock-Modus: 'compliance' für Buchhaltungs-Belege (§ 147 AO), 'governance' für HR/Verträge (DSGVO-Balance), 'none' für ephemere Dokumente.

Werte

nonegovernancecompliance

Default: "none"read-only

retentionMonths number optional

Aufbewahrungsdauer in Monaten ab retentionStartTrigger. Beispiele: 120 (10 Jahre § 147 AO), 72 (6 Jahre § 257 HGB), 12 (DSGVO-Min für Bewerbungen).

0 – 1200nullable

retentionStartTrigger string optional

Wann die Aufbewahrungsuhr startet. 'fiscalYearEnd' für Buchhaltungs-Belege (§ 147 AO startet erst mit Ende des Kalenderjahrs), 'employeeLeft' für HR-Akten, 'contractEnd' für Verträge.

Werte

createdAtfiscalYearEndcontractEndemployeeLeftmanualField

Default: "createdAt"read-only

retentionStartFieldKey string optional

Bei retentionStartTrigger='manualField': Pfad auf das Datum-Feld (z.B. 'customFields.contractEndDate').

max 100 ZeichenPatternnullable

legalBasis string optional

Rechtliche Grundlage der Aufbewahrungspflicht (z.B. "§ 147 AO", "§ 257 HGB", "Art. 6(1)(c) DSGVO"). Wird im UI als Erklärung angezeigt, warum ein Dokument nicht löschbar ist.

max 200 Zeichennullable

requireApprovalBeforeLock boolean optional

Wenn true, wird der COMPLIANCE-Lock erst nach Status-Übergang nach APPROVED gesetzt (sonst sofort nach Klassifikation). Verhindert Lock-Theater bei Falsch-Klassifikation.

Default: false

workflow object optional

Custom workflow definition for this document type. If null, default workflow is used.

nullable

statuses object[] optional

Custom status definitions (replaces default DRAFT/NEEDS_REVIEW/...)

id string erforderlich

Status identifier (e.g. DRAFT, IN_REVIEW)

1–50 ZeichenPattern

label string erforderlich

Display label (i18n key or plain text)

1–100 Zeichen

color string optional

Badge color (hex or MUI color name)

max 20 Zeichennullable

icon string optional

Icon name for this status

max 50 Zeichennullable

isFinal boolean optional

If true, no further transitions are allowed from this status

Default: false

transitions object[] optional

Allowed transitions between statuses

from string erforderlich

Source status ID

to string erforderlich

Target status ID

label string optional

Button label for this transition

max 100 Zeichennullable

requiredPermission string optional

Permission required (e.g. dms_document_approve)

max 100 Zeichennullable

requireComment boolean optional

User must provide a comment/reason for this transition

Default: false

autoAssign string optional

Auto-assign to role on transition (e.g. "accounting")

max 50 Zeichennullable

webhookUrl uri optional

Trigger webhook on transition

nullable

color string optional

Button color for this transition

Werte

primarysuccesserrorwarninginherit

nullable

initialStatus string optional

Starting status for new documents (defaults to first status in list)

nullable

formLayoutId uuid optional

Optional custom form layout (overrides auto-generated form)

nullable

defaultEncryption string optional

Default encryption mode for documents of this type. Server never sees plaintext when set to zero-knowledge.

Werte

nonezero-knowledge

Default: "none"

defaultWrapPolicy object optional

Default wrap-policy for the per-document DEK. Applied at upload time and used as starting ACL; uploaders may add or remove specific recipients per document.

nullable

includeEmployee boolean optional

Wrap the DEK for the subject employee (party-linked PERSON or employee_profile). Default true.

Default: true

includeManager boolean optional

Wrap the DEK for the employee's direct manager (auto-tracked).

Default: false

roles string[] optional

Permission strings whose holders are auto-wrapped (e.g. "dms_hr_officer", "payroll_manage").

Default: []

explicitUserIds uuid[] optional

Explicit user UUIDs to always include in the wrap list.

Default: []

isActive boolean optional

Default: true

sortOrder number optional

Default: 0

inboxFilterEnabled boolean optional

Wenn true, erscheint dieser Doktyp als eigener Filter-Tab im DMS-Posteingang (sortiert nach sortOrder).

Default: false

extractionProfile string optional

Name of the extraction profile (e.g. "invoice_v1") used to pull structured fields via OCR + LLM.

max 100 Zeichennullable

defaultFilingPolicyId uuid optional

Fallback filing policy — used when no higher-priority policy matches the upload context.

nullable

onClassificationSpawnEntity object optional

Auto-action when this document type is detected. Spawn a new entity, attach to an existing one, or both (attach-or-spawn).

nullable

mode string optional

Auto-action mode: 'spawn' creates a new entity (legacy behaviour), 'attach' only links to an existing entity, 'attach_or_spawn' tries attach first and falls back to spawn.

Werte

spawnattachattach_or_spawn

Default: "spawn"

targetEntityType string erforderlich

1–100 Zeichen

confidenceThreshold number erforderlich

0 – 1

fieldMappings object[] erforderlich

extractedField string erforderlich

1–200 Zeichen

targetField string erforderlich

1–200 Zeichen

transform string optional

Werte

parseDateparseCurrencytrimupperlowerasIs

nullable

required boolean optional

Default: false

lookupFields object[] optional

For 'attach' / 'attach_or_spawn': fields used to find the existing entity. Each row maps an extracted field to a target entity field; the lookup is an AND of all required entries.

nullable

extractedField string erforderlich

1–200 Zeichen

targetEntityField string erforderlich

1–200 Zeichen

transform string optional

Werte

parseDateparseCurrencytrimupperlowerasIs

nullable

required boolean optional

Default: true

linkRole string optional

max 100 Zeichennullable

linkBackToDocument boolean optional

Default: true

requireHumanApproval boolean optional

Default: false

dedupeBy string[] optional

nullable

postClassificationActions object[] optional

Geordnete Aktionsliste, die nach Klassifizierung sequenziell ausgeführt wird (Workflow / Entity-Spawn / Filing-Policy / Notification).

Default: []

id uuid erforderlich

type string erforderlich

Werte

workflowentity_spawnfiling_policynotification

enabled boolean erforderlich

Default: true

name string optional

max 200 Zeichennullable

confidenceThreshold number optional

0 – 1nullable

continueOnError boolean optional

Default: false

config object erforderlich

classificationRules object[] optional

Deterministic classification rules evaluated before the LLM fallback. Each rule contributes its weight to the document type score when matched.

Default: []

id uuid erforderlich

Stable rule identifier (UUIDv7).

label string optional

Optional human-readable name.

max 200 Zeichennullable

patternType string erforderlich

Werte

keywordregexbuiltin

pattern string erforderlich

Literal substring (keyword), regex source (regex) or built-in key (e.g. 'iban').

1–500 Zeichen

weight number erforderlich

Positive boosts the document type score; negative reduces it.

-10 – 10

required boolean optional

Veto rule: if true and the pattern does not match, the document type is excluded entirely.

Default: false

field string optional

Werte

ocrTextfileNamemimeTypesenderDomainfolderPathall

Default: "ocrText"

position string optional

Only meaningful when field='ocrText'.

Werte

firstPagelastPageany

Default: "any"

caseSensitive boolean optional

Default: false

classificationRuleThreshold number optional

Minimum total score (0-100) required for the rule classifier to declare a winner. Below this, the LLM fallback is used.

0 – 100Default: 30

postProcessing object optional

Workflow-Lifecycle-Hooks pro Doktyp. Jeder Slot ist optional und referenziert eine workflowDefinitionId.

nullable

onClassified object optional

nullable

workflowDefinitionId uuid erforderlich

minConfidence number optional

Workflow läuft nur, wenn classificationConfidence >= minConfidence. Default 0 (immer feuern).

0 – 1Default: 0

onExtracted object optional

nullable

workflowDefinitionId uuid erforderlich

requireFields string[] optional

Workflow läuft nur, wenn alle genannten extrahierten Felder Werte haben (verhindert leere Trigger bei OCR-Fehlern).

nullable

onFiled object optional

nullable

workflowDefinitionId uuid erforderlich

Annotation

dms_annotations4 Permissions

Schema for validating DMS PDF annotations (PDF-Annotationen)

documentId uuid erforderlich

Reference to dms_document

pageNumber number erforderlich

Page number (1-based)

≥ 1

type string erforderlich

Annotation type

Werte

HIGHLIGHTCOMMENTSTAMPSIGNATUREFREEHANDRECTANGLE

content string optional

Text content (for COMMENT type)

nullable

position object erforderlich

x number erforderlich

X position (percentage 0-100)

y number erforderlich

Y position (percentage 0-100)

width number erforderlich

Width (percentage 0-100)

height number erforderlich

Height (percentage 0-100)

color string optional

Color in hex (e.g. #FFFF00)

nullable

opacity number optional

0 – 1Default: 1nullable

stampType string optional

Stamp type (only for STAMP annotations)

Werte

APPROVEDREJECTEDDRAFTCONFIDENTIALCUSTOM

nullable

stampText string optional

Custom stamp text (only for CUSTOM stampType)

nullable

freehandPath string optional

SVG path data for FREEHAND annotations

nullable

Comment

dms_comments4 Permissions

Threaded comment on a DMS document

documentId uuid erforderlich

Reference to dms_document

parentCommentId uuid optional

Parent comment ID for threaded replies

nullable

body string erforderlich

Comment text (may contain @mentions as @[userId])

1–5000 Zeichen

mentions uuid[] optional

User IDs mentioned in this comment

Default: []

annotationId uuid optional

Linked annotation (for comments on specific PDF regions)

nullable

isResolved boolean optional

Whether this comment thread is resolved

Default: false

resolvedBy uuid optional

Who resolved this thread

read-onlynullable

resolvedAt datetime optional

read-onlynullable

Template

dms_templates4 Permissions

Schema for validating DMS PDF generation templates (PDF-Vorlagen)

name string erforderlich

Template name

1–200 Zeichen

description string optional

nullable

templateType string erforderlich

Type of document this template generates

Werte

INVOICEOFFERCONTRACTREPORTLETTERCUSTOM

engine string erforderlich

Rendering engine (Puppeteer + Handlebars)

Werte

HTML_PDF

Default: "HTML_PDF"

htmlTemplate string optional

Handlebars HTML template body

nullable

cssStyles string optional

CSS styles for the template

nullable

headerHtml string optional

HTML for page header

nullable

footerHtml string optional

HTML for page footer

nullable

variables object[] optional

Template variables with types

Default: []

name string erforderlich

type string erforderlich

Werte

stringnumberdatebooleanarrayobject

required boolean optional

Default: false

defaultValue any optional

description string optional

nullable

orientation string optional

Werte

PORTRAITLANDSCAPE

Default: "PORTRAIT"

paperSize string optional

Werte

A4A3LETTERLEGAL

Default: "A4"

margins object optional

nullable

top string optional

nullable

right string optional

nullable

bottom string optional

nullable

left string optional

nullable

sampleData object optional

Sample JSON data for template preview

nullable

thumbnailS3Key string optional

S3 key for template preview thumbnail

nullable

isActive boolean optional

Default: true

sortOrder number optional

Default: 0

Form-Layout

dms_form_layouts4 Permissions

Schema for validating form layouts used by the visual schema editor (Formular-Layouts)

schemaId string erforderlich

Link to schema_definitions (schema ID)

min 1 Zeichen

title string optional

max 200 Zeichennullable

description string optional

nullable

layout object erforderlich

sections object[] erforderlich

id string erforderlich

title string erforderlich

collapsible boolean optional

Default: false

defaultCollapsed boolean optional

Default: false

columns number erforderlich

Werte

123

Default: 1

fields object[] erforderlich

fieldKey string erforderlich

Matches the schema property name

column number erforderlich

0-based column index

≥ 0

order number erforderlich

Sort order within column

width number erforderlich

MUI Grid width units

1 – 12

widgetConfig object optional

Widget-specific config (options, relation target, etc.)

nullable

startsNewRow boolean optional

Explicit row-break marker. When true, begins a new row regardless of leftover width in the preceding row. When false/undefined, joins the previous row until cumulative width > 12.

conditionalDisplay object optional

Show/hide field based on another field value

nullable

field string optional

operator string optional

Werte

eqneqinnotInexistsnotExists

value any optional

tabs object[] optional

Optional tab grouping of sections

nullable

id string erforderlich

title string erforderlich

sectionIds string[] erforderlich

isActive boolean optional

Default: true

dms_shares4 Permissions

Document share configuration (internal user or external link)

documentId uuid erforderlich

Reference to dms_document

shareType string erforderlich

Internal (user/role) or external (public link)

Werte

INTERNALEXTERNAL_LINK

sharedWithUserId uuid optional

User this document is shared with (internal)

nullable

sharedWithRoleId uuid optional

Role this document is shared with (internal)

nullable

permission string optional

Permission level granted by this share

Werte

VIEWCOMMENTEDIT

Default: "VIEW"

token string optional

Unique token for external access (UUIDv7)

read-onlynullable

passwordHash string optional

bcrypt hash of optional access password

read-onlynullable

expiresAt datetime optional

When the share link expires

nullable

maxDownloads number optional

Maximum number of downloads allowed

≥ 1nullable

downloadCount number optional

Current download count

Default: 0read-only

allowDownload boolean optional

Whether the recipient can download the file

Default: true

message string optional

Optional message to the recipient

max 1000 Zeichennullable

isActive boolean optional

Default: true

lastAccessedAt datetime optional

read-onlynullable

accessCount number optional

Total number of times this share was accessed

Default: 0read-only

Signature

dms_signatures4 Permissions

Schema for electronic signatures on DMS documents (Elektronische Unterschriften)

documentId uuid erforderlich

Reference to dms_document

signingRequestId uuid optional

Reference to dms_signing_request (if part of a request)

nullable

documentVersion number erforderlich

Version of the document at signing time

≥ 1

documentHash string erforderlich

SHA-256 hash of the PDF at signing time

64–64 Zeichen

signatureType string erforderlich

FES = Fortgeschrittene Elektronische Signatur, QES = Qualifizierte

Werte

FESQES

status string erforderlich

Werte

PENDINGSIGNEDREJECTEDEXPIREDREVOKED

Default: "PENDING"

signerId uuid optional

Codemeta user ID (null for external signers)

nullable

signerName string erforderlich

Display name of the signer

1–200 Zeichen

signerEmail email erforderlich

Email of the signer

signerIp string optional

IP address at signing time

read-onlynullable

placement object optional

nullable

page number optional

Page number (1-based)

≥ 1

x number optional

X position (percentage)

0 – 100

y number optional

Y position (percentage)

0 – 100

width number optional

Width (percentage)

0 – 100

height number optional

Height (percentage)

0 – 100

certificate string optional

X.509 certificate (PEM) — for FES: self-signed per-tenant CA

read-onlynullable

signatureValue string optional

PKCS#7 / CMS signature (Base64)

read-onlynullable

timestampToken string optional

RFC 3161 TSA response (Base64)

read-onlynullable

signedAt datetime optional

nullable

provider string optional

Signature provider

Werte

internald-trustsign-meswisscom

Default: "internal"

providerTransactionId string optional

External provider reference

nullable

providerCertificate string optional

Provider-issued certificate

nullable

signingOrder number erforderlich

Position in multi-signer sequence (1, 2, 3...)

≥ 1

signingToken string optional

Token for email-based signing (like approval tokens)

read-onlynullable

signingTokenExpiresAt datetime optional

nullable

reminderSentAt datetime optional

nullable

rejectionReason string optional

max 2000 Zeichennullable

Signing-Request

dms_signing_requests4 Permissions

Schema for grouping multiple signatures for one document (Unterschriftenanfrage)

documentId uuid erforderlich

Reference to dms_document

title string erforderlich

Title of the signing request

1–500 Zeichen

status string erforderlich

Werte

DRAFTIN_PROGRESSCOMPLETEDCANCELLEDEXPIRED

Default: "DRAFT"

signers object[] erforderlich

min 1 Items

signerId uuid optional

Internal user ID (optional for external signers)

nullable

signerName string erforderlich

1–200 Zeichen

signerEmail email erforderlich

role string erforderlich

VIEWER gets copy but does not sign

Werte

SIGNERAPPROVERVIEWER

order number erforderlich

Sequential order (1 = first signer)

≥ 1

placement object optional

nullable

page number optional

≥ 1

x number optional

0 – 100

y number optional

0 – 100

width number optional

0 – 100

height number optional

0 – 100

sequential boolean erforderlich

true = sign in order, false = parallel signing

Default: true

message string optional

Message to signers

max 5000 Zeichennullable

expiresAt datetime optional

Deadline for all signatures

nullable

completedDocumentId uuid optional

ID of final signed PDF (new document version)

read-onlynullable

Filing-Rule

dms_filing_rules4 Permissions

rule string erforderlich

Natural language filing rule, e.g. "Rechnungen von Müller GmbH immer nach /Kunden/Müller/Rechnungen"

5–500 Zeichen

priority integer optional

1 – 100Default: 50

active boolean optional

Default: true

matchCount integer optional

Number of times this rule has been matched

≥ 0Default: 0

lastMatchedAt datetime optional

nullable

Parser

dms_parsers4 Permissions

Schema for validating DMS parser entities (Extraktionscode-Templates für Eingangsrechnungen)

name string erforderlich

Parser name

1–200 Zeichen

description string optional

Description of what this parser handles

nullable

vendorPartyId uuid optional

Vendor-specific parser (linked to CRM party)

nullable

matchCriteria object optional

Criteria for matching this parser to incoming documents

nullable

vendorTaxId string optional

Match by USt-IdNr / Steuernummer

nullable

vendorIban string optional

Match by IBAN

nullable

vendorName string optional

Match by vendor name (fuzzy)

nullable

documentPattern string optional

Regex pattern to match against first page text

nullable

parserType string erforderlich

How this parser was created

Werte

ZUGFERDXRECHNUNGLLM_GENERATEDCUSTOM

code string optional

TypeScript source code for extraction

nullable

compiledCode string optional

Transpiled JavaScript for sandboxed execution

nullable

status string erforderlich

Parser lifecycle status

Werte

DRAFTNEEDS_REVIEWAPPROVEDDISABLED

Default: "DRAFT"

approvedBy uuid optional

nullable

approvedAt datetime optional

nullable

successCount number optional

Number of successful extractions

≥ 0Default: 0read-only

failureCount number optional

Number of failed extractions

≥ 0Default: 0read-only

lastUsedAt datetime optional

read-onlynullable

llmGenerationPrompt string optional

Original prompt used to generate this parser

nullable

llmModel string optional

LLM model that generated this parser

nullable

Extraction-Feedback

dms_extraction_feedback4 Permissions

User corrections to extraction results for ML feedback loop

documentId uuid erforderlich

Reference to the DMS document

field string erforderlich

The field path that was corrected (e.g. incomingInvoice.vendorName)

max 200 Zeichen

originalValue any optional

Value before correction

correctedValue any erforderlich

User-provided correct value

extractionMethod string optional

Which extraction method produced the original value

Werte

ZUGFERDXRECHNUNGLLM_VISIONOCR_LLMPARSERMANUAL

nullable

parserId uuid optional

Which dms_parser was used (if any)

nullable

vendorPartyId uuid optional

Vendor party for vendor-specific learning

nullable

documentTypeId uuid optional

Document type for type-specific learning

nullable

applied boolean optional

Whether this feedback has been incorporated into parser/rules

Default: false

Retention

dms_retention_policies4 Permissions

Schema for validating DMS retention policies (GoBD-Aufbewahrungsrichtlinien)

name string erforderlich

Policy name

1–200 Zeichen

description string optional

nullable

documentTypes string[] optional

Which document types this policy applies to

Default: []

retentionYears number erforderlich

Retention period in years (6 for Handelsrecht, 10 for Steuerrecht)

1 – 30

action string erforderlich

Action when retention expires

Werte

ARCHIVENOTIFYDELETE_REVIEW

isGobdRelevant boolean optional

If true, documents can never be auto-deleted

Default: false

notifyBeforeDays number optional

Days before expiry to send notification

≥ 0nullable

isActive boolean optional

Default: true

Storage-Backend

dms_storage_backends4 Permissions

Registry-Eintrag für einen Byte-Speicher des Filing-Systems — S3, SharePoint, lokales Filesystem, OneDrive, Nextcloud oder SMB-Share.

name string erforderlich

1–200 Zeichen

description string optional

max 1000 Zeichennullable

kind string erforderlich

Werte

s3_primarysharepointlocal_fsonedrive_tenantnextcloudsmb_share

default boolean optional

Nur ein Backend pro Tenant darf default=true sein.

Default: false

active boolean optional

Default: true

rootPathIdentityMode string optional

Stabilitäts-Policy für Wurzelpfade. stable_only erzwingt IDs im Pfad, Display-Namen als Metadatum.

Werte

hybridstable_only

Default: "hybrid"

inboxPolicy string optional

always erzwingt Inbox-Quarantäne für alle Inbound-Items (revisionssichere Umgebungen).

Werte

defaultalways

Default: "default"

misfileMode string optional

Was passiert, wenn ein Inbound-Item nicht am Policy-konformen Pfad liegt? strict=auto-move, informational=flag only, off=ignore.

Werte

offinformationalstrict

Default: "informational"

config object erforderlich

Kind-spezifische Konfiguration (discriminated union via `kind`-Feld).

kind string erforderlich

Werte

s3_primarysharepointlocal_fsonedrive_tenantnextcloudsmb_share

bucket string optional

nullable

keyPrefix string optional

nullable

siteUrl string optional

nullable

siteId string optional

nullable

driveId string optional

nullable

libraryName string optional

nullable

rootFolderId string optional

nullable

rootFolderPath string optional

nullable

conflictStrategy string optional

Werte

codemeta_winssharepoint_winslast_write_winsprompt_user

nullable

subscriptionId string optional

read-onlynullable

subscriptionExpiresAt datetime optional

read-onlynullable

subscriptionStatus string optional

Werte

pendingactiveskippederror

nullable

subscriptionError string optional

nullable

subscriptionLastAttemptAt datetime optional

nullable

deltaToken string optional

read-onlynullable

bootstrapState string optional

Werte

pendingin_progresscompletedfailed

nullable

bootstrapStartedAt datetime optional

nullable

bootstrapCompletedAt datetime optional

nullable

bootstrapCursor string optional

nullable

bootstrapError string optional

nullable

rootPath string optional

nullable

followSymlinks boolean optional

nullable

permissionModel string optional

Werte

inherituid_gid

nullable

watchMode string optional

Werte

inotifypolling

nullable

pollingIntervalMs number optional

1000 – 3600000nullable

trashRetentionDays number optional

1 – 3650nullable

userPrincipalName string optional

nullable

baseUrl string optional

nullable

username string optional

nullable

appPasswordCipherRef string optional

read-onlynullable

unc string optional

nullable

domain string optional

nullable

passwordCipherRef string optional

read-onlynullable

lastHealthCheckAt datetime optional

read-onlynullable

lastHealthOk boolean optional

read-onlynullable

lastHealthDetails object optional

read-onlynullable

lastSyncError string optional

nullable

lastSyncAt datetime optional

nullable

lastSuccessfulOutboundAt datetime optional

nullable

DATEV-Export

dms_datev_exports4 Permissions

DATEV CSV export batch for Buchungsstapel

status string erforderlich

Export batch status

Werte

PENDINGPROCESSINGCOMPLETEFAILED

Default: "PENDING"

documentIds uuid[] optional

Document IDs included in this export

Default: []

dateFrom date optional

Start of date range filter

nullable

dateTo date optional

End of date range filter

nullable

beraterNr string optional

DATEV Beraternummer

max 10 Zeichennullable

mandantenNr string optional

DATEV Mandantennummer

max 10 Zeichennullable

wirtschaftsjahrBeginn date optional

Start of fiscal year (Wirtschaftsjahr)

nullable

sachkontenlaenge number optional

Length of general ledger account numbers (Sachkontenlänge)

Werte

45678

Default: 4

documentCount number optional

Number of documents in export

Default: 0read-only

totalNetAmount string optional

Total net amount of all exported invoices

read-onlynullable

totalGrossAmount string optional

Total gross amount of all exported invoices

read-onlynullable

s3Key string optional

S3 key of generated CSV file

read-onlynullable

fileName string optional

Generated file name (e.g. EXTF_Buchungsstapel_2026-03.csv)

read-onlynullable

errorMessage string optional

Error message if export failed

read-onlynullable

exportedAt datetime optional

When the export completed

read-onlynullable

SP-Sync-Log

dms_sharepoint_sync_logs4 Permissions

syncConfigId string erforderlich

min 1 Zeichen

direction string erforderlich

Werte

outboundinbound

operation string erforderlich

Werte

CREATEUPDATEDELETECONFLICT

status string erforderlich

Werte

successerrorconflictskipped

dmsDocumentId string optional

nullable

sharePointItemId string optional

nullable

sharePointItemName string optional

nullable

dmsFolderPath string optional

nullable

conflictDetails object optional

nullable

codemetaModifiedAt string optional

sharePointModifiedAt string optional

resolution string optional

Werte

codemeta_winssharepoint_winspending

resolvedBy string optional

nullable

resolvedAt string optional

nullable

errorMessage string optional

nullable

errorCode string optional

nullable

recordsProcessed number optional

nullable

recordsCreated number optional

nullable

recordsUpdated number optional

nullable

recordsSkipped number optional

nullable

recordsFailed number optional

nullable

durationMs number optional

nullable

startedAt datetime erforderlich

completedAt datetime optional

nullable

Sync-Conflict

dms_sync_conflicts4 Permissions

Geparkter 3-Wege-Konflikt zwischen DMS- und Backend-Seite. Sperrt das betroffene Entity (syncState=conflict), bis ein User oder eine Auto-Resolution-Policy entscheidet. Trägt sowohl Document- als auch Folder-Konflikte (ADR 0095a).

entityType string optional

Conflict target — document (default) or folder (ADR 0095a).

Werte

documentfolder

Default: "document"

documentId uuid optional

nullable

folderId uuid optional

nullable

folderPath string optional

max 2000 Zeichennullable

backendId uuid erforderlich

dmsVersionAtConflict integer optional

≥ 0read-only

backendETagAtConflict string erforderlich

1–500 Zeichenread-only

lastSyncCheckpoint object erforderlich

read-only

dmsVersion integer erforderlich

≥ 0

backendETag string erforderlich

max 500 Zeichen

timestamp datetime erforderlich

dmsMeta object optional

nullable

size integer optional

≥ 0nullable

hash string optional

max 200 Zeichennullable

mtime datetime optional

nullable

mimeType string optional

max 200 Zeichennullable

fileName string optional

max 500 Zeichennullable

path string optional

max 2000 Zeichennullable

backendMeta object optional

nullable

size integer optional

≥ 0nullable

hash string optional

max 200 Zeichennullable

mtime datetime optional

nullable

mimeType string optional

max 200 Zeichennullable

fileName string optional

max 500 Zeichennullable

path string optional

max 2000 Zeichennullable

resolution string erforderlich

Werte

pendingkeep_dmskeep_backendstack_versionsauto_last_write_wins

Default: "pending"

resolvedAt datetime optional

nullable

resolvedBy uuid optional

nullable

resolutionNote string optional

max 2000 Zeichennullable

Datei-Upload

Dateien werden über die separate File-API hochgeladen, nicht über den Standard-CRUD-Endpoint. Der Flow:

POST /files/v1/uploads — initiiert einen Upload, gibt eine signierte Pre-Sign-URL zurück.
Sie laden die Datei direkt zur Storage-Schicht (PUT).
POST /files/v1/uploads/<id>/finalize — bestätigt den Upload.
POST /api/v1/dms_documents — verknüpft das Dokument mit der Datei.

Versionierung

Versionen liegen als typisierte Liste am Dokument-Datensatz. Eine neue Version laden Sie über die File-API hoch und ergänzen sie über ein PATCH /api/v1/dms_documents/<id> an die Versions-Liste.

Public-Links für externe Zugriffe (z. B. eine Rechnung an einen Kunden):

POST /api/v1/dms_shares
{
  "documentId": "0193…",
  "expiresAt": "2026-06-01T00:00:00Z",
  "passwordProtected": true,
  "downloadAllowed": true
}

Die Antwort enthält einen Slug. Der Empfänger ruft den Link unter /api/v1/public/sharing/<slug> auf.

Signatur-Anfragen

Innerhalb des DMS lassen sich Signatur-Anfragen direkt am Dokument auslösen — dms_signing_requests. Für komplexere Workflows mit mehreren Unterzeichnern, Templates und PAdES-konformer Signatur nutzen Sie das eSign-Modul.

Verwandt

Konventionen
eSign — Dokumente unterschreiben lassen
Public Endpoints — Share-Link-Resolution

DMS

Resources – Inhalte

Resources – Verarbeitung & Storage

Schemas

Datei-Upload

Versionierung

Sharing-Links

Signatur-Anfragen

Verwandt