Pleaxy

Emite órdenes de compra, aprueba y paga facturas, y configura tu espacio de trabajo.

Referencia de la API

Reglas de automatización

Reglas que aprueban automáticamente, o envían siempre a aprobación, los documentos que coinciden.

Más sobre este recurso

Excepciones condicionales sobre la configuración de autonomía de Liquidación, por proceso (purchase_order, invoice_payment): una regla coincide por cuenta de proveedor (o, para un proveedor sin cuenta en Pleaxy, por nombre) e importe, y aprueba automáticamente una coincidencia sin que nadie intervenga o fuerza la cadena de aprobación completa. Una regla de aprobación automática necesita el plan Autonomous y nunca se aplica a una factura que tampoco podría aprobar la autonomía (una que registró un comprador, una en otra moneda o una no conciliada con una factura de AWS emitida), ni a una orden de compra que supere un límite de gasto. Las reglas se evalúan en orden, y gana la primera coincidencia activada.

Endpoints

Obtener reglas de automatización

Devuelve las reglas de automatización de un proceso.

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

Parámetros

  • process"purchase_order" | "invoice_payment"Obligatorio

    De qué flujo se obtienen las reglas.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve las reglas de automatización de un proceso en orden de prioridad, o { process, rules: [] } si no hay ninguna configurada, y si el plan del espacio de trabajo permite que se ejecuten las reglas de aprobación automática.

Campos de la respuesta

  • autoApproveAllowedboolean

    Si el plan permite la autonomía (Autonomous o Enterprise). Cuando es false, las reglas con autoApprove true se conservan pero se omiten al evaluar órdenes y facturas, de modo que una regla posterior aún puede coincidir; al mejorar el plan vuelven a ejecutarse. Se calcula en cada lectura y nunca se guarda.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/automation-rules/{process}
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/automation-rules/{process}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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
}

Actualizar reglas de automatización

Reemplaza las reglas de automatización de un proceso.

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

Parámetros

  • process"purchase_order" | "invoice_payment"Obligatorio

    De qué flujo se reemplazan las reglas.

Cuerpo

  • rulesarrayObligatorio

    Cada una { id?, label, conditions: { supplierWorkspaceId?, supplierContains?, maxAmount? }, autoApprove, enabled }. supplierWorkspaceId es la cuenta de proveedor a la que se aplica la regla (su ID del espacio de trabajo, p. ej. reg_….supplier) y debe ser uno de tus proveedores conectados; los proveedores se identifican por cuenta, nunca por nombre. supplierContains es heredado y solo coincide con proveedores sin cuenta en Pleaxy. autoApprove true omite la aprobación para una coincidencia; false fuerza la cadena completa.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Reemplaza las reglas de automatización de un proceso, en orden de prioridad. Una regla que conserva su id conserva su createdAt.

Cambiado el 2026-09-27, una corrección de seguridad dentro de v1: solo sesión iniciada, para todos los procesos: una regla de aprobación automática aprueba órdenes de compra o facturas sin que nadie intervenga, así que una clave de API recibe 403 HUMAN_SESSION_REQUIRED sea cual sea su rol de compras. Para leer las reglas se sigue aceptando una clave de API de comprador.

Errores

  • 400 Bad Request - AUTONOMY_PLAN_REQUIRED: una regla nueva, o un cambio en una existente, define autoApprove true en un plan sin autonomía ("Auto-approve rules need the Autonomous plan - the {Plan} plan allows rules that require approval only. Upgrade to Autonomous to use auto-approve rules."). No se guarda nada. Una regla ya guardada con autoApprove true se puede reenviar con sus condiciones sin cambios (su etiqueta y su interruptor de activación pueden cambiar), para que el resto de la lista siga siendo editable; cambiar sus condiciones se rechaza.
  • 400 Bad Request - DUPLICATE_RULE_ID: la lista contiene el mismo id de regla más de una vez ("Rule '{id}' is in the list more than once. Send each rule once."). No se guarda nada.
  • 403 Forbidden - Código HUMAN_SESSION_REQUIRED. El llamador no es una persona con sesión iniciada (por ejemplo, una clave de API), para cualquier proceso ("Automation rules can only be changed by a signed-in person. Change them in Pleaxy."). No se guarda nada.
  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
PATCH /v1/workspaces/{regionId}/automation-rules/{process}
Solicitud
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 }
   ]
}
Respuesta · 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" }
   ]
}
Habla con nosotros