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

Compliance Report Schema

Schema-ID
compliance_report
Collection
compliance_reports
Permissions
  • Lesencompliance_report_view
  • Anlegencompliance_report_create
  • Änderncompliance_report_edit
  • Löschencompliance_report_delete

Felder

Compliance Report Schema

compliance_reports4 Permissions

Schema for GoBD compliance reports and Verfahrensdokumentation

reportTypestringerforderlich

Type of compliance report

Werte
GOBD_STATUSVERFAHRENSDOKUMENTATIONHASH_CHAIN_VERIFICATIONRETENTION_ADHERENCEACCESS_AUDITSIGNATURE_STATUSTAX_AUDITOR_EXPORT
titlestringoptional
max 500 Zeichennullable
statusstringerforderlich
Werte
PENDINGGENERATINGCOMPLETEDFAILED
Default: "PENDING"
dateFromdatetimeoptional

Report period start

nullable
dateTodatetimeoptional

Report period end

nullable
summaryobjectoptional

Report summary metrics

nullable
findingsobject[]optional
Default: []
severitystringoptional
Werte
INFOWARNINGCRITICAL
codestringoptional

Finding code (e.g. GOBD_001)

messagestringoptional
documentIdstringoptional
nullable
detailsobjectoptional
nullable
documentCountnumberoptional

Number of documents included in this report

nullable
hashChainValidbooleanoptional

Whether the hash chain is intact

read-onlynullable
lastVerifiedHashstringoptional

Last verified hash in the chain

read-onlynullable
brokenChainAtstringoptional

Document ID where chain broke (if any)

read-onlynullable
s3Keystringoptional

S3 key for exported report/archive

read-onlynullable
fileNamestringoptional
nullable
fileSizeBytesnumberoptional
nullable
startedAtdatetimeoptional
nullable
completedAtdatetimeoptional
nullable
errorMessagestringoptional
nullable

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

Suche