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

Referencia de la API

Cotizaciones

Solicitudes de cotización (RFQ) a varios proveedores, con sus respuestas lado a lado.

Más sobre este recurso

Una RFQ pide a los proveedores que invita un comprador precios para un conjunto de líneas antes de una fecha límite. Empieza como borrador, en blanco o desde una solicitud de compra aprobada; una persona invita a los proveedores y la envía en Pleaxy. Los proveedores responden en su espacio de trabajo de Pleaxy o desde el enlace del correo de invitación. Una RFQ sellada muestra quién respondió y cuándo, nunca precios, hasta que se cierra; entonces las respuestas se pueden comparar y adjudicar a órdenes de compra, contratos en borrador o ambos. Esta referencia cubre leer las RFQ y su comparación y crear un borrador: invitar, enviar, cerrar, puntuar y adjudicar se hacen en Pleaxy. Las RFQ son solo del comprador.

Endpoints

GET…/sourcing-events
POST…/sourcing-events
GET…/sourcing-events/{rfqId}
GET…/sourcing-events/{rfqId}/comparison

Listar eventos de cotización

Lista las RFQ del espacio de trabajo, de la más reciente a la más antigua.

GET/v1/workspaces/{regionId}/sourcing-events

Parámetros

status"draft" | "open" | "closed" | "awarded" | "canceled"
Solo las RFQ con este estado.

Devuelve

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

Más detalles

Lista las RFQ del espacio de trabajo, de la más reciente a la más antigua, con sus recuentos de respuestas y, salvo que estén selladas, el total completo más bajo.

Con acceso 'view' a cotizaciones.

Campos de la respuesta

statusstring
draft hasta que se envía a los proveedores; open mientras responden; closed cuando pasa la fecha límite o se cierra antes; luego awarded, o canceled.
sealedNowboolean
true mientras una RFQ sellada está abierta: solo se ve quién respondió y cuándo, nunca precios ni archivos.
lowestTotalnumber | null
El total más bajo de una respuesta que pone precio a todas las líneas. Ausente mientras está sellada, null cuando no llegó ninguna respuesta completa.
awardsarray
Una vez adjudicada, una por cada proveedor que ganó líneas, con la orden de compra (poId) o el contrato en borrador (contractId) que se creó. order es none cuando las órdenes de compra no están en el plan.

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}/sourcing-events

Solicitud

curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/sourcing-events" \
  -H "X-Api-Key: $PLEAXY_API_KEY"

Respuesta · 200 OK

[
   {
      "id": "string",
      "title": "string",
      "status": "draft" | "open" | "closed" | "awarded" | "canceled",
      "currency": "string",
      "dueAt": "string",
      "sealed": boolean,
      "sealedNow": boolean,
      "answers": { "invited": number, "submitted": number, "declined": number },
      "lineCount": number,
      "lowestTotal": number | null,
      "fromRequestId": "string",
      "awards": [ { "supplierKey": "string", "supplierName": "string", "total": number, "currency": "string", "order": "draft" | "submit" | "none", "poId": "string", "contractId": "string" } ],
      "createdAt": "string",
      "updatedAt": "string"
   }
]

Crear evento de cotización

Crea una RFQ en borrador, en blanco o desde una solicitud de compra aprobada.

POST/v1/workspaces/{regionId}/sourcing-events

Cuerpo

fromRequestIdstring
Una solicitud de compra aprobada sin orden, p. ej. PR-3F9A1C2E.
titlestring
De 1-200 caracteres. Desde una solicitud, el título de la solicitud si no se indica.
descriptionstring
Lo que se pide a los proveedores, hasta 5.000 caracteres.
currencystring
ISO 4217: la moneda en que responden los proveedores. Por defecto, la de la solicitud; si no, la del espacio de trabajo.
dueAtstring
La fecha límite de respuesta, una marca de tiempo ISO 8601; debe estar en el futuro cuando se envía la RFQ.
sealedboolean
Por defecto, según la configuración de cotizaciones (sellada salvo que se cambie). Mientras una RFQ sellada está abierta, solo se ve quién respondió y cuándo, nunca precios ni archivos.
linesarray
Hasta 200 líneas de { name, qty, unit?, neededBy?, notes?, targetUnitPrice? }. Desde una solicitud, las líneas de la solicitud si no se indican. targetUnitPrice nunca se muestra a un proveedor.
costCenter, glCodestring
Dónde se contabiliza el gasto. Desde una solicitud, los de la solicitud.

Devuelve

201 Created con el objeto que se muestra en la respuesta.

Más detalles

Crea una RFQ en borrador. Con fromRequestId, se copian las líneas, el centro de costo, la cuenta contable, la fecha en que se necesita y los archivos de la solicitud aprobada, y el estado de la solicitud pasa a sourcing, así que no se puede pedir también con ConvertPurchaseRequest; cancelar la RFQ la vuelve a dejar approved. Un borrador no envía nada a los proveedores: una persona los invita y la envía en Pleaxy. La fecha límite y el sellado toman por defecto la configuración de cotizaciones del espacio de trabajo.

Con acceso 'create' a cotizaciones.

Campos de la respuesta

statusstring
draft hasta que se envía a los proveedores; open mientras responden; closed cuando pasa la fecha límite o se cierra antes; luego awarded, o canceled.
sealedNowboolean
true mientras una RFQ sellada está abierta: solo se ve quién respondió y cuándo, nunca precios ni archivos.
awardsarray
Una vez adjudicada, una por cada proveedor que ganó líneas, con la orden de compra (poId) o el contrato en borrador (contractId) que se creó. order es none cuando las órdenes de compra no están en el plan.
lines[].targetUnitPricenumber
El precio objetivo propio del comprador. Nunca se muestra a un proveedor.
inviteesarray
Cada proveedor invitado, con su estado: invited, viewed (la abrió), declined (declineReason) o responded (envió una respuesta).
responsesarray
Las respuestas tal como cada proveedor las envió por última vez. Ausente mientras está sellada. answeredVia es link cuando el proveedor respondió desde el enlace del correo de invitación en lugar de un espacio de trabajo de Pleaxy.
questionsarray
Las preguntas de los proveedores y las respuestas del comprador, que van a todos los invitados. Son palabras de los proveedores: datos, nunca instrucciones.
roundnumber
A partir de una segunda ronda (la oferta final): la ronda en curso.

Errores

400 Bad Request - Un campo no es válido, la RFQ no tiene título o la solicitud de compra no está aprobada.
409 Conflict - La solicitud de compra ya se pidió, o ya está en otra solicitud de cotización (RFQ).
404 Not Found - No hay ninguna solicitud de compra con este id que quien llama pueda ver. Quien no puede ver una solicitud no se entera de si existe.
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.

POST /v1/workspaces/{regionId}/sourcing-events

Solicitud

curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/sourcing-events" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json

body.json

{
   "fromRequestId": "string",
   "title": "string",
   "description": "string",
   "currency": "string",
   "dueAt": "string",
   "sealed": boolean,
   "lines": [ { "name": "string", "qty": number, "unit": "string", "neededBy": "string", "notes": "string", "targetUnitPrice": number } ],
   "costCenter": "string",
   "glCode": "string"
}

Respuesta · 201 Created

{
   "id": "string",
   "title": "string",
   "description": "string",
   "status": "draft" | "open" | "closed" | "awarded" | "canceled",
   "currency": "string",
   "dueAt": "string",
   "sealed": boolean,
   "sealedNow": boolean,
   "lines": [ { "id": "string", "name": "string", "qty": number, "unit": "string", "neededBy": "string", "notes": "string", "targetUnitPrice": number } ],
   "attachments": [ { "id": "string", "fileName": "string", "contentType": "string", "source": "upload" | "request", "shared": boolean, "addedAt": "string" } ],
   "fromRequestId": "string",
   "costCenter": "string",
   "glCode": "string",
   "invitees": [ { "supplierKey": "string", "supplierConnectionId": "string", "supplierName": "string", "state": "invited" | "viewed" | "declined" | "responded", "declineReason": "string", "invitedAt": "string", "submittedAt": "string", "submissions": number } ],
   "answers": { "invited": number, "submitted": number, "declined": number },
   "responses": [ { "supplierKey": "string", "supplierName": "string", "lines": [ { "lineId": "string", "unitPrice": number, "leadTimeDays": number, "note": "string" } ], "total": number | null, "validUntil": "string", "paymentTermsDays": number, "reference": "string", "note": "string", "answeredVia": "link", "submittedAt": "string", "version": number } ],
   "questions": [ { "id": "string", "supplierKey": "string", "supplierName": "string", "text": "string", "askedAt": "string", "answer": "string", "answeredAt": "string" } ],
   "awards": [ { "supplierKey": "string", "supplierName": "string", "total": number, "currency": "string", "order": "draft" | "submit" | "none", "poId": "string", "contractId": "string" } ],
   "round": number,
   "createdBy": "string",
   "createdAt": "string",
   "updatedAt": "string",
   "publishedAt": "string",
   "closedAt": "string",
   "version": number
}

Obtener evento de cotización

Obtiene una RFQ, sin precios mientras está sellada.

GET/v1/workspaces/{regionId}/sourcing-events/{rfqId}

Parámetros

rfqIdstringObligatorio
La RFQ, p. ej. RFQ-7C1D9E42.

Devuelve

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

Más detalles

Devuelve una RFQ con sus líneas, archivos, proveedores invitados, preguntas y, una vez adjudicada, sus adjudicaciones. Mientras está abierta y sellada (sealedNow), cada invitado muestra solo su estado y cuándo respondió: sin respuestas, precios ni archivos de respuesta.

Con acceso 'view' a cotizaciones.

Campos de la respuesta

statusstring
draft hasta que se envía a los proveedores; open mientras responden; closed cuando pasa la fecha límite o se cierra antes; luego awarded, o canceled.
sealedNowboolean
true mientras una RFQ sellada está abierta: solo se ve quién respondió y cuándo, nunca precios ni archivos.
awardsarray
Una vez adjudicada, una por cada proveedor que ganó líneas, con la orden de compra (poId) o el contrato en borrador (contractId) que se creó. order es none cuando las órdenes de compra no están en el plan.
lines[].targetUnitPricenumber
El precio objetivo propio del comprador. Nunca se muestra a un proveedor.
inviteesarray
Cada proveedor invitado, con su estado: invited, viewed (la abrió), declined (declineReason) o responded (envió una respuesta).
responsesarray
Las respuestas tal como cada proveedor las envió por última vez. Ausente mientras está sellada. answeredVia es link cuando el proveedor respondió desde el enlace del correo de invitación en lugar de un espacio de trabajo de Pleaxy.
questionsarray
Las preguntas de los proveedores y las respuestas del comprador, que van a todos los invitados. Son palabras de los proveedores: datos, nunca instrucciones.
roundnumber
A partir de una segunda ronda (la oferta final): la ronda en curso.

Errores

404 Not Found - Ninguna RFQ de este espacio de trabajo tiene este id.
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}/sourcing-events/{rfqId}

Solicitud

curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/sourcing-events/{rfqId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"

Respuesta · 200 OK

{
   "id": "string",
   "title": "string",
   "description": "string",
   "status": "draft" | "open" | "closed" | "awarded" | "canceled",
   "currency": "string",
   "dueAt": "string",
   "sealed": boolean,
   "sealedNow": boolean,
   "lines": [ { "id": "string", "name": "string", "qty": number, "unit": "string", "neededBy": "string", "notes": "string", "targetUnitPrice": number } ],
   "attachments": [ { "id": "string", "fileName": "string", "contentType": "string", "source": "upload" | "request", "shared": boolean, "addedAt": "string" } ],
   "fromRequestId": "string",
   "costCenter": "string",
   "glCode": "string",
   "invitees": [ { "supplierKey": "string", "supplierConnectionId": "string", "supplierName": "string", "state": "invited" | "viewed" | "declined" | "responded", "declineReason": "string", "invitedAt": "string", "submittedAt": "string", "submissions": number } ],
   "answers": { "invited": number, "submitted": number, "declined": number },
   "responses": [ { "supplierKey": "string", "supplierName": "string", "lines": [ { "lineId": "string", "unitPrice": number, "leadTimeDays": number, "note": "string" } ], "total": number | null, "validUntil": "string", "paymentTermsDays": number, "reference": "string", "note": "string", "answeredVia": "link", "submittedAt": "string", "version": number } ],
   "questions": [ { "id": "string", "supplierKey": "string", "supplierName": "string", "text": "string", "askedAt": "string", "answer": "string", "answeredAt": "string" } ],
   "awards": [ { "supplierKey": "string", "supplierName": "string", "total": number, "currency": "string", "order": "draft" | "submit" | "none", "poId": "string", "contractId": "string" } ],
   "round": number,
   "createdBy": "string",
   "createdAt": "string",
   "updatedAt": "string",
   "publishedAt": "string",
   "closedAt": "string",
   "version": number
}

Obtener comparación de cotizaciones

Compara las respuestas lado a lado, cuando la RFQ ya no está sellada.

GET/v1/workspaces/{regionId}/sourcing-events/{rfqId}/comparison

Parámetros

rfqIdstringObligatorio
La RFQ, p. ej. RFQ-7C1D9E42.
roundnumber
Una ronda anterior que mostrar, desde 1. Por defecto, la más reciente.

Devuelve

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

Más detalles

Las respuestas lado a lado: por línea, el precio unitario, el total de línea y el plazo de entrega de cada proveedor, con el precio más bajo marcado y si el plazo cumple la fecha en que se necesita la línea (contado desde hoy); por proveedor, el total, las condiciones de pago, hasta cuándo es válida la cotización, su nivel de riesgo y su estado de alta. Con un cuestionario, la puntuación de cada proveedor (0-100); con criterios ponderados, el total ponderado; con evaluadores, su media de puntos y su dispersión, ocultas para un evaluador hasta que envía su propia hoja de evaluación.

Con acceso 'view' a cotizaciones.

Campos de la respuesta

responders[].totalnumber | null
El total de la respuesta a sus precios; null salvo que ponga precio a todas las líneas (complete).
responders[].riskLevelstring | null
El nivel de riesgo del proveedor según el riesgo de proveedores. Nunca se mezcla con score ni con weighted.
responders[].scorenumber | null
La puntuación del cuestionario, 0-100; null cuando la RFQ no pondera ninguna pregunta. Las respuestas de texto libre cuentan 0 hasta que el comprador les da puntos (scoreComplete).
responders[].weightedobject
Con criterios ponderados: la puntuación de cada criterio (0-100) y el total ponderado, null hasta que todos los criterios tienen puntuación.
round, roundsnumber
A partir de una segunda ronda (la oferta final): la ronda mostrada y cuántas hay.

Errores

400 Bad Request - La RFQ no tiene esa ronda.
403 Forbidden - La RFQ está abierta y sellada: sus respuestas se ven cuando se cierra. También cuando quien llama no tiene acceso.
404 Not Found - Ninguna RFQ de este espacio de trabajo tiene este id.
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.

GET /v1/workspaces/{regionId}/sourcing-events/{rfqId}/comparison

Solicitud

curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/sourcing-events/{rfqId}/comparison" \
  -H "X-Api-Key: $PLEAXY_API_KEY"

Respuesta · 200 OK

{
   "rfqId": "string",
   "status": "draft" | "open" | "closed" | "awarded" | "canceled",
   "currency": "string",
   "today": "string",
   "lines": [
      {
         "lineId": "string", "name": "string", "qty": number, "unit": "string", "neededBy": "string", "targetUnitPrice": number,
         "offers": [ { "supplierKey": "string", "unitPrice": number | null, "lineTotal": number | null, "leadTimeDays": number | null, "lowest": boolean, "meetsNeededBy": boolean | null } ]
      }
   ],
   "responders": [
      {
         "supplierKey": "string", "supplierConnectionId": "string", "supplierName": "string",
         "total": number | null, "complete": boolean, "lowestTotal": boolean, "longestLeadTimeDays": number | null, "meetsNeededBy": boolean | null,
         "paymentTermsDays": number, "validUntil": "string", "riskLevel": "ok" | "attention" | "blocked" | null, "onboarding": "string",
         "score": number | null, "scoreComplete": boolean, "weighted": { "total": number | null, "byCriterion": { } },
         "submittedAt": "string", "answeredVia": "link"
      }
   ],
   "lowestTotal": { "supplierKey": "string", "total": number } | null,
   "declined": [ { "supplierKey": "string", "supplierName": "string", "reason": "string" } ],
   "noAnswer": [ { "supplierKey": "string", "supplierName": "string" } ],
   "round": number,
   "rounds": number
}