Zum Hauptinhalt springen
GET
/
workflows
/
status
/
{external_id}
Workflow-Status nach externer ID abrufen
curl --request GET \
  --url https://api.comstruct.com/v1/workflows/status/{external_id} \
  --header 'X-API-Key: <api-key>'
{ "success": true, "status": "FACTUAL_CHECKING", "url": "https://app.comstruct.com/invoices/123", "history": [ { "created_at": "2024-01-15T10:00:00Z", "newStatus": "PROCESSING", "previousStatus": "NEW", "message": "Verarbeitung gestartet" }, { "created_at": "2024-01-15T10:05:00Z", "newStatus": "FACTUAL_CHECKING", "previousStatus": "PROCESSING", "message": "Sachliche Prüfung" } ] }
Ruft den aktuellen Verarbeitungsstatus einer Rechnung anhand ihrer externen ID ab. Die Antwort enthält den Status, eine URL zur Rechnung in comstruct und eine Historie der Statusänderungen.

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.

Pfadparameter

​
external_id
string
erforderlich

Die externe Kennung der Rechnung/des Workflows

Antwort

Workflow-Status erfolgreich abgerufen

​
success
boolean

Gibt an, ob die Statusabfrage erfolgreich war

Beispiel:

true

​
status
enum<string>

Aktueller Rechnungsstatus

Verfügbare Optionen:
NEW,
PROCESSING,
FACTUAL_CHECKING,
PRICE_CHECKING,
CHECKED,
CANCELLED,
ERROR,
OPEN
Beispiel:

"FACTUAL_CHECKING"

​
url
string<uri>

URL zur Anzeige der Rechnung in comstruct

Beispiel:

"https://app.comstruct.com/invoices/123"

​
history
object[]

Verlauf der Statusänderungen