API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · dms_retention_policies

DMS Retention Policy Schema

Schema-ID
dms_retention_policy
Collection
dms_retention_policies
Permissions
  • Lesendms_retention_policy_view
  • Anlegendms_retention_policy_create
  • Änderndms_retention_policy_edit
  • Löschendms_retention_policy_delete

Felder

DMS Retention Policy Schema

dms_retention_policies4 Permissions

Schema for validating DMS retention policies (GoBD-Aufbewahrungsrichtlinien)

namestringerforderlich

Policy name

1–200 Zeichen
descriptionstringoptional
nullable
documentTypesstring[]optional

Which document types this policy applies to

Default: []
retentionYearsnumbererforderlich

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

1 – 30
actionstringerforderlich

Action when retention expires

Werte
ARCHIVENOTIFYDELETE_REVIEW
isGobdRelevantbooleanoptional

If true, documents can never be auto-deleted

Default: false
notifyBeforeDaysnumberoptional

Days before expiry to send notification

≥ 0nullable
isActivebooleanoptional
Default: true

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/dms_retention_policies — Liste, paginiert + filterbar
  • GET /api/v1/dms_retention_policies/<id> — Einzelne Entity
  • POST /api/v1/dms_retention_policies — Anlegen
  • PATCH /api/v1/dms_retention_policies/<id> — Teil-Update
  • DELETE /api/v1/dms_retention_policies/<id> — Soft-Delete
  • GET /api/v1/dms_retention_policies/<id>/timeline — Audit + Aktivitäten

Suche