Emite órdenes de compra, aprueba y paga facturas, y configura tu espacio de trabajo.
Búsqueda de endpoints
Busca en la API de comprador
146 endpoints en 19 recursos. Busca por ruta, método o lo que quieras hacer: pega una URL real y sus ids coinciden con los parámetros de la ruta.
Prueba
Referencia de la API
La API de Pleaxy es una API REST con solicitudes y respuestas en JSON. Úsala para leer y crear órdenes de compra y facturas, y para seguirlas durante la aprobación y el pago. Para conceptos y guías, consulta la documentación.
Autenticación
Envía uno de estos dos encabezados en cada solicitud:
X-Api-Key: <keyId>.<secret>: una clave de API, para tus propios sistemas y agentes.Authorization: Bearer <accessToken>: la sesión de una persona que ha iniciado sesión, necesaria para algunas acciones, como aprobar y gestionar claves de API.
Una credencial funciona en un espacio de trabajo, como comprador o como proveedor. Cada ruta incluye el id de ese espacio de trabajo como regionId; cópialo desde Perfil de la empresa → ID del espacio de trabajo en Pleaxy.
Errores
Los errores usan códigos de estado 4xx y un cuerpo JSON. Decide según code, no según el message en inglés; messageId y params te permiten mostrar el mensaje en tu propio idioma.
Versionado
Las rutas empiezan por la versión, /v1. Dentro de ella se añaden endpoints, campos y valores nuevos, así que ignora los campos que no reconozcas y ten un valor por defecto para valores desconocidos, como los estados. Los cambios incompatibles llegan como una versión nueva.
https://api.pleaxy.aicurl "$PLEAXY_API_BASE_URL/v1/workspaces/$WORKSPACE_ID/purchase-orders" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"statusCode": 404,
"error": "Not Found",
"message": "Invoice INV-7F3A9C21 not found.",
"code": "string",
"messageId": "string",
"params": { ... }
}Recursos
- Órdenes de compraÓrdenes que un comprador emite a un proveedor: sus líneas, importes, estado y aprobación.15 endpoints
- Solicitudes de compraLo que las personas piden comprar antes de que exista una orden: aprobación, control de presupuesto y luego una orden.9 endpoints
- FacturasFacturas de proveedores a compradores, desde su llegada hasta la conciliación, la aprobación y el pago.34 endpoints
- Notas de créditoNotas de crédito que reducen lo que debe un comprador, y su aplicación a facturas.11 endpoints
- Conexiones de nubeVínculos de solo lectura a la facturación de tus cuentas de proveedores de nube.8 endpoints
- Gasto en IAGasto en modelos de IA por facturador, proveedor del modelo, modelo y medidor, frente a tus órdenes de compra.21 endpoints
- Proveedores de IAProveedores de IA conectados directamente con una clave de solo lectura, y los facturadores de IA que puedes agregar como proveedores.6 endpoints
- LiquidaciónCuándo las órdenes de compra y las facturas pueden saltarse la aprobación manual, y el plan del espacio de trabajo.3 endpoints
- Cadenas de aprobaciónQuién aprueba las órdenes de compra y los pagos de facturas.2 endpoints
- Reglas de automatizaciónReglas que aprueban automáticamente, o envían siempre a aprobación, los documentos que coinciden.2 endpoints
- AprobacionesLas órdenes de compra y facturas que esperan tu decisión.1 endpoint
- EmpleadosLas personas de un espacio de trabajo.1 endpoint
- Espacios de trabajoResúmenes del panel con la actividad de un comprador o un proveedor.1 endpoint
- Perfiles de organizaciónEl perfil comercial y los datos de facturación de tu empresa.2 endpoints
- NotificacionesNotificaciones en la aplicación y configuración de recordatorios.6 endpoints
- Claves de APIClaves que permiten a tus sistemas llamar a la API sin una persona con sesión iniciada.3 endpoints
- Sincronización de documentosMantén tu propio sistema al día: qué cambió y cada documento en JSON, cXML o UBL.8 endpoints
- Cumplimiento de pedidosLos proveedores confirman órdenes y anuncian envíos; los compradores ven ambos en la orden.6 endpoints
- WebhooksHaz que Pleaxy envíe cada cambio a tu endpoint HTTPS en cuanto ocurre.7 endpoints