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

Acceptance Protocol Schema

Schema-ID
acceptance_protocol
Collection
acceptance_protocols
Permissions
  • Lesenacceptance_protocol_view
  • Anlegenacceptance_protocol_create
  • Ändernacceptance_protocol_edit
  • Löschenacceptance_protocol_delete
Beziehungen

Felder

Acceptance Protocol Schema

acceptance_protocols4 Permissions

Schema for validating project acceptance protocol (Abnahmeprotokoll) entities

projectIduuiderforderlich→ project

Project this acceptance protocol belongs to

read-only
protocolNumberstringoptional

Human-readable sequence number (e.g. ABN-2026-00042). Assigned server-side; protected.

max 100 Zeichenread-onlynullable
titlestringerforderlich

Protocol title (defaults to "Abnahmeprotokoll – <project title>")

1–200 Zeichen
statusstringoptional

Lifecycle status. DRAFT = editable; SENT = envelope dispatched/awaiting signature; SIGNED = customer accepted; REJECTED = customer declined; CANCELLED = voided. Protected.

DRAFTSENTSIGNEDREJECTEDCANCELLED
Default: "DRAFT"read-only
introTextstringoptional

Editable protocol body / project description shown to the customer.

max 5000 Zeichennullable
scopeItemsobject[]optional

Structured list of accepted deliverables / scope of work.

Default: []nullable
labelstringerforderlich
1–500 Zeichen
donebooleanoptional
Default: false
notestringoptional
max 1000 Zeichennullable
projectSnapshotobjectoptional

Immutable copy of the relevant project fields at protocol creation time, so the protocol stays stable even if the project changes afterwards. Protected.

read-onlynullable
projectNumberstringoptional
nullable
titlestringoptional
nullable
descriptionstringoptional
nullable
startDatestringoptional
nullable
endDatestringoptional
nullable
managerNamestringoptional
nullable
partyNamestringoptional
nullable
partyAddressstringoptional
nullable
signerNamestringoptional

Name of the customer signer.

max 200 Zeichennullable
signerEmailstringoptional

Email of the customer signer (used for the magic-link flow).

max 320 Zeichennullable
signerPartyIduuidoptional

Customer party/contact UUID of the signer.

nullable
coSignerUserIduuidoptional

Optional internal user (e.g. project manager) who co-signs.

nullable
feedbackstringoptional

Free-text feedback the customer enters during acceptance.

max 5000 Zeichennullable
envelopeIduuidoptional

Linked sign_envelope that drives the signature workflow. Protected.

read-onlynullable
unsignedPdfFileIduuidoptional

Generated, not-yet-signed protocol PDF (files collection). Protected.

read-onlynullable
signedPdfFileIduuidoptional

Final signed protocol PDF (files collection). Protected.

read-onlynullable
sentAtdatetimeoptional

When the protocol was sent for signature. Protected.

read-onlynullable
acceptedAtdatetimeoptional

When the customer signed. Protected.

read-onlynullable
acceptedViastringoptional

How the signature was collected. Protected.

IN_PERSONMAGIC_LINKnull
read-onlynullable
ipAddressstringoptional

Forensic: signer IP at acceptance time. Protected.

max 64 Zeichenread-onlynullable
userAgentstringoptional

Forensic: signer user-agent at acceptance time. Protected.

max 512 Zeichenread-onlynullable
rejectionReasonstringoptional

Reason given when the customer rejects the protocol. Protected.

max 2000 Zeichenread-onlynullable

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

Suche