Zum Hauptinhalt springen
POST
/
invoices
/
custom
Rechnung im benutzerdefinierten Format verarbeiten
curl --request POST \
  --url https://api.comstruct.com/v1/invoices/custom \
  --header 'Content-Type: */*' \
  --header 'X-API-Key: <api-key>' \
  --data '"<string>"'
{
  "invoiceId": "invoice-abc123def456",
  "success": true,
  "jobId": "job-789xyz012"
}

​
Übersicht

Verarbeitet Rechnungen als PDF- oder TIFF-Datei mit KI-gestützter Datenextraktion. Optionale Request-Header können vordefinierte Werte für Lieferant, Projekt und externe Dokument-ID übergeben und damit die von der KI extrahierten Felder überschreiben.

​
Berechtigungen

ScopeTenant-Typ
invoices:writeLieferant (SUPPLIER_ONLY)
Der API-Schlüssel muss mit einem Lieferanten verknüpft sein.
HeaderPflichtBeschreibung
x-api-keyJaAPI-Schlüssel mit Scope invoices:write
Content-TypeJaapplication/pdf oder application/tiff
kreditornameNeinLieferantenname; überschreibt den von der KI extrahierten Lieferantennamen
archivdocumentNeinExterne Dokument-ID für Archivierungszwecke; wird als external_id der Rechnung gespeichert
projektNeinProjektnummer; überschreibt die von der KI extrahierte Projektzuordnung
buchungskreisNeinBuchungskreis (juristische Einheit); Fallback für die Projektnummer, wenn projekt leer ist — Format HQ-{buchungskreis}

​
Verhalten der Preset-Header

  • kreditorname setzt supplier_name in der Rechnungsverarbeitung.
  • projekt setzt project_number. Wenn projekt fehlt oder leer ist, wird stattdessen HQ-{buchungskreis} verwendet (sofern buchungskreis gesetzt ist).
  • archivdocument wird als externe Rechnungs-ID (external_id) gespeichert.

​
Beispiel

curl -X POST "https://api.comstruct.com/v1/invoices/custom" \
  -H "x-api-key: IHR_API_SCHLUESSEL" \
  -H "Content-Type: application/pdf" \
  -H "kreditorname: Beispiel Lieferant GmbH" \
  -H "archivdocument: ARCH-2024-001" \
  -H "projekt: PRJ-001" \
  --data-binary @rechnung.pdf

Autorisierungen

​
X-API-Key
string
header
erforderlich

API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.

Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.

Header

​
kreditorname
string

Lieferantenname; überschreibt den von der KI extrahierten Lieferantennamen

​
archivdocument
string

Externe Dokument-ID für Archivierungszwecke; wird als external_id der Rechnung gespeichert

​
projekt
string

Projektnummer; überschreibt die von der KI extrahierte Projektzuordnung

​
buchungskreis
string

Buchungskreis (juristische Einheit); Fallback für die Projektnummer, wenn projekt leer ist (HQ-{buchungskreis})

Body

*/*

Rohe Rechnungsdaten (bis zu 32MiB)

Antwort

Rechnung erfolgreich verarbeitet und zur Hintergrundverarbeitung eingereiht

​
invoiceId
string
erforderlich

Eindeutige ID der erstellten Rechnung

Beispiel:

"invoice-abc123def456"

​
success
boolean
erforderlich
Beispiel:

true

​
jobId
string

Job-ID zur Nachverfolgung der Hintergrundverarbeitung

Beispiel:

"job-789xyz012"