Pleaxy

Bestellungen anlegen, Rechnungen freigeben und bezahlen und den Workspace einrichten.

API-Referenz

Automatisierungsregeln

Regeln, die passende Dokumente automatisch freigeben oder immer in die Freigabe schicken.

Mehr zu dieser Ressource

Bedingte Übersteuerungen zusätzlich zu den Autonomie-Einstellungen unter Abwicklung, pro Prozess (purchase_order, invoice_payment): Eine Regel greift anhand des Lieferantenkontos (oder, bei einem Lieferanten ohne Pleaxy-Konto, anhand des Namens) und des Betrags und gibt einen Treffer entweder ohne Zutun einer Person automatisch frei oder erzwingt die vollständige Freigabekette. Eine Regel zur automatischen Freigabe erfordert den Plan Autonomous und gilt nie für eine Rechnung, die auch die Autonomie nicht freigeben könnte (eine von einem Käufer erfasste, eine in einer anderen Währung oder eine nicht gegen eine ausgestellte AWS-Rechnung abgeglichene), und auch nicht für eine PO über einem Ausgabenlimit. Regeln werden der Reihe nach ausgewertet, und der erste aktivierte Treffer gilt.

Endpunkte

Automatisierungsregeln abrufen

Gibt die Automatisierungsregeln eines Prozesses zurück.

GET/v1/workspaces/{regionId}/automation-rules/{process}

Parameter

  • process"purchase_order" | "invoice_payment"Pflicht

    Die Regeln welches Ablaufs abgerufen werden.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt die Automatisierungsregeln eines Prozesses in Prioritätsreihenfolge zurück oder { process, rules: [] }, wenn keine konfiguriert sind, sowie ob der Plan des Workspace Regeln zur automatischen Freigabe ausführen lässt.

Antwortfelder

  • autoApproveAllowedboolean

    Ob der Plan Autonomie erlaubt (Autonomous oder Enterprise). Bei false bleiben Regeln mit autoApprove true erhalten, werden aber bei der Auswertung von Bestellungen und Rechnungen übersprungen, sodass eine nachfolgende Regel trotzdem greifen kann; ein Upgrade lässt sie wieder laufen. Wird bei jedem Lesen berechnet, nie gespeichert.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/automation-rules/{process}
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/automation-rules/{process}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "process": "purchase_order" | "invoice_payment",
   "rules": [
      { "id": "string", "label": "string", "conditions": { "supplierWorkspaceId": "string", "supplierContains": "string", "maxAmount": number }, "autoApprove": boolean, "enabled": boolean, "createdAt": "string" }
   ],
   "autoApproveAllowed": boolean
}

Automatisierungsregeln aktualisieren

Ersetzt die Automatisierungsregeln eines Prozesses.

PATCH/v1/workspaces/{regionId}/automation-rules/{process}

Parameter

  • process"purchase_order" | "invoice_payment"Pflicht

    Die Regeln welches Ablaufs ersetzt werden.

Body

  • rulesarrayPflicht

    Jeweils { id?, label, conditions: { supplierWorkspaceId?, supplierContains?, maxAmount? }, autoApprove, enabled }. supplierWorkspaceId ist das Lieferantenkonto, für das die Regel gilt (seine Workspace-ID, z. B. reg_….supplier), und muss einer Ihrer verbundenen Lieferanten sein; Lieferanten werden anhand des Kontos zugeordnet, nie anhand des Namens. supplierContains ist veraltet und trifft nur auf Lieferanten ohne Pleaxy-Konto zu. autoApprove true überspringt die Freigabe für einen Treffer; false erzwingt die vollständige Kette.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Ersetzt die Automatisierungsregeln eines Prozesses in Prioritätsreihenfolge. Eine Regel, die ihre id behält, behält auch ihr createdAt.

Geändert am 2026-09-27, eine Sicherheitskorrektur innerhalb von v1: Nur angemeldete Sitzung, für jeden Prozess: Eine Regel zur automatischen Freigabe gibt Bestellungen oder Rechnungen ohne Zutun einer Person frei, daher erhält ein API-Schlüssel unabhängig von seiner Einkaufsrolle 403 HUMAN_SESSION_REQUIRED. Zum Lesen der Regeln genügt weiterhin ein Käufer-API-Schlüssel.

Fehler

  • 400 Bad Request - AUTONOMY_PLAN_REQUIRED: Eine neue Regel oder eine Änderung an einer bestehenden setzt autoApprove true in einem Plan ohne Autonomie ("Auto-approve rules need the Autonomous plan - the {Plan} plan allows rules that require approval only. Upgrade to Autonomous to use auto-approve rules."). Es wird nichts gespeichert. Eine bereits mit autoApprove true gespeicherte Regel kann mit unveränderten Bedingungen zurückgesendet werden (ihr label und ihr Ein/Aus-Schalter dürfen sich ändern), damit der Rest der Liste bearbeitbar bleibt; eine Änderung ihrer Bedingungen wird abgelehnt.
  • 400 Bad Request - DUPLICATE_RULE_ID: Die Liste enthält dieselbe Regel-ID mehr als einmal ("Rule '{id}' is in the list more than once. Send each rule once."). Es wird nichts gespeichert.
  • 403 Forbidden - Code HUMAN_SESSION_REQUIRED. Der Aufrufer ist keine angemeldete Person (zum Beispiel ein API-Schlüssel), für jeden Prozess ("Automation rules can only be changed by a signed-in person. Change them in Pleaxy."). Es wird nichts gespeichert.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
PATCH /v1/workspaces/{regionId}/automation-rules/{process}
Anfrage
curl -X PATCH "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/automation-rules/{process}" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json
body.json
{
   "rules": [
      { "id": "string", "label": "string", "conditions": { "supplierWorkspaceId": "string", "supplierContains": "string", "maxAmount": number }, "autoApprove": boolean, "enabled": boolean }
   ]
}
Antwort · 200 OK
{
   "process": "purchase_order" | "invoice_payment",
   "rules": [
      { "id": "string", "label": "string", "conditions": { "supplierWorkspaceId": "string", "supplierContains": "string", "maxAmount": number }, "autoApprove": boolean, "enabled": boolean, "createdAt": "string" }
   ]
}
Kontakt aufnehmen