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

Party Document Rule Schema

Schema-ID
party_document_rule
Collection
party_document_rules
Permissions
  • Lesenparty_document_rule_view
  • Anlegenparty_document_rule_create
  • Ändernparty_document_rule_edit
  • Löschenparty_document_rule_delete

Felder

Party Document Rule Schema

party_document_rules4 Permissions

Customer-scoped declaration of a document that must be on file for a party (ADR 0349)

documentTypeIduuiderforderlich

FK to dms_document_type — the kind of document required.

documentTypeNamestringerforderlich

Snapshot of dms_document_type.name at rule creation time. Cached for display so a deleted document type does not blank-out the UI.

1–200 Zeichen
scopeobjecterforderlich
kindstringerforderlich
Werte
ALL_CUSTOMERSPARTY_TAGPARTY
tagstringoptional

Required when kind='PARTY_TAG' — matched against party.tags.

max 100 Zeichennullable
partyIduuidoptional

Required when kind='PARTY'.

nullable
mandatorybooleanoptional

When true, a missing document flags the customer red. False = nice-to-have, surfaced but not counted as a gap.

Default: true
renewalIntervalMonthsintegeroptional

Document must be renewed after this many months (evaluated against the matched document’s expiresAt, else its createdAt). Null = once, no renewal.

1 – 240nullable
validFromdateoptional

Optional: rule only takes effect from this date.

nullable
validTodateoptional

Optional: rule expires on this date.

nullable
descriptionstringoptional

Free-text note for admins, shown in the rule editor.

max 1000 Zeichennullable

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

Suche