Skip to main content
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.

Authorizations

​
X-API-Key
string
header
required

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

Erforderliche Berechtigungen:

  • deliveries:read - Lieferdaten lesen
  • deliveries:write - Lieferungen erstellen und ändern
  • invoices:read - Rechnungsdaten lesen
  • invoices:write - Rechnungen erstellen und ändern
  • projects:read - Projektdaten lesen
  • projects:write - Projekte erstellen und ändern
  • project_regions:read - Projektregionsdaten lesen
  • project_regions:write - Projektregionen erstellen und ändern
  • accounts:read - Kontodaten lesen
  • accounts:write - Konten erstellen und ändern
  • payment_terms:read - Zahlungsbedingungsdaten lesen
  • payment_terms:write - Zahlungsbedingungen erstellen und ändern
  • tax_codes:read - Steuercodedaten lesen
  • tax_codes:write - Steuercodes erstellen und ändern
  • users:read - Benutzerdaten lesen (erforderlich für Projekt-Benutzerverwaltung)
  • roles:read - Rollendaten lesen (erforderlich für Projekt-Rollenzuweisung)
  • tenant_settings:read - Mandanteneinstellungen lesen (erforderlich für Projekterstellung)
  • suppliers:write - Lieferanten erstellen und ändern
  • purchase_orders:write - Bestellungen erstellen

Path Parameters

​
external_id
string
required

Die externe Kennung der Rechnung/des Workflows

Response

Workflow-Status erfolgreich abgerufen

​
success
boolean

Gibt an, ob die Statusabfrage erfolgreich war

Example:

true

​
status
enum<string>

Aktueller Rechnungsstatus

Available options:
NEW,
PROCESSING,
FACTUAL_CHECKING,
PRICE_CHECKING,
CHECKED,
CANCELLED,
ERROR,
OPEN
Example:

"FACTUAL_CHECKING"

​
url
string<uri>

URL zur Anzeige der Rechnung in comstruct

Example:

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

​
history
object[]

Verlauf der Statusänderungen