Pleaxy

Emetti ordini d’acquisto, approva e paga le fatture e configura il tuo spazio di lavoro.

Riferimento API

Regole di automazione

Regole che approvano automaticamente i documenti corrispondenti, o li inviano sempre in approvazione.

Altro su questa risorsa

Eccezioni condizionali che si aggiungono alle impostazioni di autonomia di Liquidazione, per processo (purchase_order, invoice_payment): una regola individua i documenti per account del fornitore (o, per un fornitore senza account Pleaxy, per nome) e per importo, e approva automaticamente una corrispondenza senza l’intervento di nessuno, oppure impone l’intera catena di approvazione. Una regola di approvazione automatica richiede il piano Autonomous e non si applica mai a una fattura che nemmeno l’autonomia potrebbe approvare (una inserita da un acquirente, una in un’altra valuta o una non riconciliata con una fattura AWS emessa), né a un OdA oltre un limite di spesa. Le regole vengono valutate in ordine, e vince la prima corrispondenza attiva.

Endpoint

Recuperare le regole di automazione

Restituisce le regole di automazione di un processo.

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

Parametri

  • process"purchase_order" | "invoice_payment"Obbligatorio

    Il flusso di cui recuperare le regole.

Restituisce

200 OK con l’oggetto mostrato nella risposta.

Più dettagli

Restituisce le regole di automazione di un processo in ordine di priorità, oppure { process, rules: [] } se non ne è configurata nessuna, e se il piano del workspace consente l’esecuzione delle regole di approvazione automatica.

Campi della risposta

  • autoApproveAllowedboolean

    Se il piano consente l’autonomia (Autonomous o Enterprise). Quando è false, le regole con autoApprove true vengono mantenute ma saltate nella valutazione di ordini e fatture, così una regola successiva può comunque corrispondere; passare a un piano superiore le riattiva. Calcolato a ogni lettura, mai memorizzato.

Errori

  • 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
  • 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
GET /v1/workspaces/{regionId}/automation-rules/{process}
Richiesta
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/automation-rules/{process}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Risposta · 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
}

Aggiornare le regole di automazione

Sostituisce le regole di automazione di un processo.

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

Parametri

  • process"purchase_order" | "invoice_payment"Obbligatorio

    Il flusso di cui sostituire le regole.

Corpo

  • rulesarrayObbligatorio

    Ciascuna { id?, label, conditions: { supplierWorkspaceId?, supplierContains?, maxAmount? }, autoApprove, enabled }. supplierWorkspaceId è l’account del fornitore a cui si applica la regola (il suo ID del workspace, ad es. reg_….supplier) e deve essere uno dei tuoi fornitori collegati; i fornitori vengono individuati per account, mai per nome. supplierContains è legacy e corrisponde solo ai fornitori senza account Pleaxy. autoApprove true salta l’approvazione per una corrispondenza; false impone l’intera catena.

Restituisce

200 OK con l’oggetto mostrato nella risposta.

Più dettagli

Sostituisce le regole di automazione di un processo, in ordine di priorità. Una regola che mantiene il suo id mantiene il suo createdAt.

Modificato il 2026-09-27, una correzione di sicurezza all’interno della v1: solo sessione con accesso effettuato, per ogni processo: una regola di approvazione automatica approva ordini d’acquisto o fatture senza l’intervento di nessuno, quindi una chiave API riceve 403 HUMAN_SESSION_REQUIRED qualunque sia il suo ruolo procurement. La lettura delle regole accetta ancora una chiave API acquirente.

Errori

  • 400 Bad Request - AUTONOMY_PLAN_REQUIRED: una nuova regola, o una modifica a una esistente, imposta autoApprove true su un piano senza autonomia ("Auto-approve rules need the Autonomous plan - the {Plan} plan allows rules that require approval only. Upgrade to Autonomous to use auto-approve rules."). Nulla viene salvato. Una regola già memorizzata con autoApprove true può essere reinviata con le condizioni invariate (la sua etichetta e il suo interruttore possono cambiare), così il resto dell’elenco resta modificabile; cambiarne le condizioni viene rifiutato.
  • 400 Bad Request - DUPLICATE_RULE_ID: l’elenco contiene lo stesso id di regola più di una volta ("Rule '{id}' is in the list more than once. Send each rule once."). Nulla viene salvato.
  • 403 Forbidden - Codice HUMAN_SESSION_REQUIRED. Il chiamante non è una persona che ha effettuato l’accesso (ad esempio, una chiave API), per qualsiasi processo ("Automation rules can only be changed by a signed-in person. Change them in Pleaxy."). Nulla viene salvato.
  • 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
  • 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
PATCH /v1/workspaces/{regionId}/automation-rules/{process}
Richiesta
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 }
   ]
}
Risposta · 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" }
   ]
}
Contattaci