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

DMS Parser Schema

Schema-ID
dms_parser
Collection
dms_parsers
Permissions
  • Lesendms_parser_view
  • Anlegendms_parser_create
  • Änderndms_parser_edit
  • Löschendms_parser_delete

Felder

DMS Parser Schema

dms_parsers4 Permissions

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

namestringerforderlich

Parser name

1–200 Zeichen
descriptionstringoptional

Description of what this parser handles

nullable
vendorPartyIduuidoptional

Vendor-specific parser (linked to CRM party)

nullable
matchCriteriaobjectoptional

Criteria for matching this parser to incoming documents

nullable
vendorTaxIdstringoptional

Match by USt-IdNr / Steuernummer

nullable
vendorIbanstringoptional

Match by IBAN

nullable
vendorNamestringoptional

Match by vendor name (fuzzy)

nullable
documentPatternstringoptional

Regex pattern to match against first page text

nullable
parserTypestringerforderlich

How this parser was created

Werte
ZUGFERDXRECHNUNGLLM_GENERATEDCUSTOM
codestringoptional

TypeScript source code for extraction

nullable
compiledCodestringoptional

Transpiled JavaScript for sandboxed execution

nullable
statusstringerforderlich

Parser lifecycle status

Werte
DRAFTNEEDS_REVIEWAPPROVEDDISABLED
Default: "DRAFT"
approvedByuuidoptional
nullable
approvedAtdatetimeoptional
nullable
successCountnumberoptional

Number of successful extractions

≥ 0Default: 0read-only
failureCountnumberoptional

Number of failed extractions

≥ 0Default: 0read-only
lastUsedAtdatetimeoptional
read-onlynullable
llmGenerationPromptstringoptional

Original prompt used to generate this parser

nullable
llmModelstringoptional

LLM model that generated this parser

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

Suche