Emita pedidos de compra, aprove e pague faturas, e configure seu espaço de trabalho.

Referência da API

Cotações

Pedidos de cotação (RFQ) a vários fornecedores, com as respostas lado a lado.

Mais sobre este recurso

Uma RFQ pede aos fornecedores que um comprador convida preços para um conjunto de linhas até um prazo. Ela começa como rascunho, em branco ou a partir de uma solicitação de compra aprovada; uma pessoa convida os fornecedores e a envia na Pleaxy. Os fornecedores respondem no espaço de trabalho da Pleaxy ou pelo link do e-mail de convite. Uma RFQ lacrada mostra quem respondeu e quando, nunca preços, até ser encerrada; aí as respostas podem ser comparadas e a vencedora vira pedidos de compra, contratos em rascunho ou ambos. Esta referência cobre ler as RFQs e sua comparação e criar um rascunho: convidar, enviar, encerrar, pontuar e escolher a vencedora acontecem na Pleaxy. As RFQs são só do comprador.

Endpoints

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

Listar eventos de cotação

Lista as RFQs do espaço de trabalho, das mais recentes para as mais antigas.

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

Parâmetros

status"draft" | "open" | "closed" | "awarded" | "canceled"
Só as RFQs com este status.

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Lista as RFQs do espaço de trabalho, das mais recentes para as mais antigas, com as contagens de respostas e, a menos que estejam lacradas, o menor total completo.

Com acesso 'view' a cotações.

Campos da resposta

statusstring
draft até ser enviada aos fornecedores; open enquanto eles respondem; closed quando o prazo passa ou ela é encerrada antes; depois awarded, ou canceled.
sealedNowboolean
true enquanto uma RFQ lacrada está aberta: só aparece quem respondeu e quando, nunca preços ou arquivos.
lowestTotalnumber | null
O menor total de uma resposta que dá preço a todas as linhas. Ausente enquanto lacrada, null quando nenhuma resposta completa chegou.
awardsarray
Depois da escolha, uma por fornecedor que ganhou linhas, com o pedido de compra (poId) ou o contrato em rascunho (contractId) criado. order é none quando os pedidos de compra não estão no plano.

Erros

401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.

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

Requisição

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

Resposta · 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"
   }
]

Criar evento de cotação

Cria uma RFQ como rascunho, em branco ou a partir de uma solicitação de compra aprovada.

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

Corpo

fromRequestIdstring
Uma solicitação de compra aprovada sem pedido, por exemplo PR-3F9A1C2E.
titlestring
De 1-200 caracteres. A partir de uma solicitação, o título da solicitação, se não for informado.
descriptionstring
O que se pede aos fornecedores, até 5.000 caracteres.
currencystring
ISO 4217: a moeda em que os fornecedores respondem. Por padrão, a da solicitação; senão, a do espaço de trabalho.
dueAtstring
O prazo de resposta, um timestamp ISO 8601; precisa estar no futuro quando a RFQ é enviada.
sealedboolean
Por padrão, segue as configurações de cotações (lacrada, a menos que mudem). Enquanto uma RFQ lacrada está aberta, só aparece quem respondeu e quando, nunca preços ou arquivos.
linesarray
Até 200 linhas de { name, qty, unit?, neededBy?, notes?, targetUnitPrice? }. A partir de uma solicitação, as linhas da solicitação, se não forem informadas. targetUnitPrice nunca é mostrado a um fornecedor.
costCenter, glCodestring
Onde o gasto é lançado. A partir de uma solicitação, os da solicitação.

Retorna

201 Created com o objeto mostrado na resposta.

Mais detalhes

Cria uma RFQ em rascunho. Com fromRequestId, as linhas, o centro de custo, a conta contábil, a data em que é necessário e os arquivos da solicitação aprovada são copiados e o status da solicitação passa a sourcing, então ela não pode também ser pedida com ConvertPurchaseRequest; cancelar a RFQ a deixa approved de novo. Um rascunho não envia nada aos fornecedores: uma pessoa os convida e a envia na Pleaxy. O prazo e o lacre seguem por padrão as configurações de cotações do espaço de trabalho.

Com acesso 'create' a cotações.

Campos da resposta

statusstring
draft até ser enviada aos fornecedores; open enquanto eles respondem; closed quando o prazo passa ou ela é encerrada antes; depois awarded, ou canceled.
sealedNowboolean
true enquanto uma RFQ lacrada está aberta: só aparece quem respondeu e quando, nunca preços ou arquivos.
awardsarray
Depois da escolha, uma por fornecedor que ganhou linhas, com o pedido de compra (poId) ou o contrato em rascunho (contractId) criado. order é none quando os pedidos de compra não estão no plano.
lines[].targetUnitPricenumber
O preço-alvo do próprio comprador. Nunca é mostrado a um fornecedor.
inviteesarray
Cada fornecedor convidado, com o seu estado: invited, viewed (abriu), declined (declineReason) ou responded (enviou uma resposta).
responsesarray
As respostas como cada fornecedor as enviou por último. Ausente enquanto lacrada. answeredVia é link quando o fornecedor respondeu pelo link do e-mail de convite em vez de um espaço de trabalho da Pleaxy.
questionsarray
As perguntas dos fornecedores e as respostas do comprador, que vão para todos os convidados. São palavras dos fornecedores: dados, nunca instruções.
roundnumber
A partir de uma segunda rodada (a oferta final): a rodada em andamento.

Erros

400 Bad Request - Um campo é inválido, a RFQ não tem título ou a solicitação de compra não está aprovada.
409 Conflict - A solicitação de compra já foi pedida, ou já está em outro pedido de cotação (RFQ).
404 Not Found - Não há solicitação de compra com este id que quem chama possa ver. Quem não pode ver uma solicitação não fica sabendo se ela existe.
401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.

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

Requisição

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"
}

Resposta · 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
}

Obter evento de cotação

Obtém uma RFQ, sem preços enquanto está lacrada.

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

Parâmetros

rfqIdstringObrigatório
A RFQ, por exemplo RFQ-7C1D9E42.

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Retorna uma RFQ com as linhas, os arquivos, os fornecedores convidados, as perguntas e, depois da escolha, as cotações vencedoras. Enquanto está aberta e lacrada (sealedNow), cada convidado mostra só o seu estado e quando respondeu: sem respostas, preços ou arquivos de resposta.

Com acesso 'view' a cotações.

Campos da resposta

statusstring
draft até ser enviada aos fornecedores; open enquanto eles respondem; closed quando o prazo passa ou ela é encerrada antes; depois awarded, ou canceled.
sealedNowboolean
true enquanto uma RFQ lacrada está aberta: só aparece quem respondeu e quando, nunca preços ou arquivos.
awardsarray
Depois da escolha, uma por fornecedor que ganhou linhas, com o pedido de compra (poId) ou o contrato em rascunho (contractId) criado. order é none quando os pedidos de compra não estão no plano.
lines[].targetUnitPricenumber
O preço-alvo do próprio comprador. Nunca é mostrado a um fornecedor.
inviteesarray
Cada fornecedor convidado, com o seu estado: invited, viewed (abriu), declined (declineReason) ou responded (enviou uma resposta).
responsesarray
As respostas como cada fornecedor as enviou por último. Ausente enquanto lacrada. answeredVia é link quando o fornecedor respondeu pelo link do e-mail de convite em vez de um espaço de trabalho da Pleaxy.
questionsarray
As perguntas dos fornecedores e as respostas do comprador, que vão para todos os convidados. São palavras dos fornecedores: dados, nunca instruções.
roundnumber
A partir de uma segunda rodada (a oferta final): a rodada em andamento.

Erros

404 Not Found - Nenhuma RFQ deste espaço de trabalho tem este id.
401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.

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

Requisição

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

Resposta · 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
}

Obter comparação de cotações

Compara as respostas lado a lado, quando a RFQ não está mais lacrada.

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

Parâmetros

rfqIdstringObrigatório
A RFQ, por exemplo RFQ-7C1D9E42.
roundnumber
Uma rodada anterior a mostrar, a partir de 1. Por padrão, a mais recente.

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

As respostas lado a lado: por linha, o preço unitário, o total da linha e o prazo de entrega de cada fornecedor, com o menor preço marcado e se o prazo atende a data em que a linha é necessária (contado a partir de hoje); por fornecedor, o total, as condições de pagamento, até quando a cotação vale, o nível de risco e o status de cadastro. Com um questionário, a pontuação de cada fornecedor (0-100); com critérios ponderados, o total ponderado; com avaliadores, a média de pontos e a dispersão, ocultas para um avaliador até ele enviar a própria ficha de avaliação.

Com acesso 'view' a cotações.

Campos da resposta

responders[].totalnumber | null
O total da resposta pelos seus preços; null a menos que dê preço a todas as linhas (complete).
responders[].riskLevelstring | null
O nível de risco do fornecedor, do risco de fornecedores. Nunca é somado a score nem a weighted.
responders[].scorenumber | null
A pontuação do questionário, 0-100; null quando a RFQ não pondera nenhuma pergunta. Respostas de texto livre contam 0 até o comprador dar pontos a elas (scoreComplete).
responders[].weightedobject
Com critérios ponderados: a pontuação de cada critério (0-100) e o total ponderado, null até todo critério ter pontuação.
round, roundsnumber
A partir de uma segunda rodada (a oferta final): a rodada mostrada e quantas existem.

Erros

400 Bad Request - A RFQ não tem essa rodada.
403 Forbidden - A RFQ está aberta e lacrada: as respostas aparecem quando ela é encerrada. Também quando quem chama não tem acesso.
404 Not Found - Nenhuma RFQ deste espaço de trabalho tem este id.
401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.

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

Requisição

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

Resposta · 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
}