Listar pedidos de compra
Lista os pedidos de compra do espaço de trabalho, opcionalmente dentro de um intervalo de datas.
GET/v1/workspaces/{regionId}/purchase-orders
Parâmetros
fromstringData/timestamp ISO 8601 - só são retornados os itens criados nessa data ou depois dela.
tostringData/timestamp ISO 8601 - só são retornados os itens criados nessa data ou antes dela.
Retorna
200 OK com o objeto mostrado na resposta.
Mais detalhes
Lista todos os pedidos de compra do espaço de trabalho, sem ordem definida. Opcionalmente restrito a um intervalo de createdAt via from/to - passe os limites de um mês do calendário para ter uma visão por mês. Quem chama como Fornecedor recebe uma visão reduzida de cada pedido (veja GetPurchaseOrder) - a contabilidade interna do comprador e o fluxo de aprovação completo ficam ocultos.
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}/purchase-orders
Requisição
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/purchase-orders" \
-H "X-Api-Key: $PLEAXY_API_KEY"Resposta · 200 OK
[
{
"id": "string",
"buyerOrgId": "string",
"supplierOrgId": "string",
"supplier": "string",
"amount": number,
"currency": "string",
"status": "draft" | "pending_approval" | "rejected" | "awaiting_fulfillment" | "invoiced" | "paid" | "canceled" | "closed" | "expired",
"invoiceId": "string",
"provider": "aws" | "gcp" | "azure" | "oci",
"payerAccounts": [
{ "id": "string", "label": "string", "detail": "string" }
],
"billToParty": {
"source": "company_profile" | "custom",
"companyName": "string",
"address": { "line1": "string", "line2": "string", "city": "string", "region": "string", "postalCode": "string", "country": "string" },
"addressText": "string",
"taxId": "string"
},
"costCenter": "string",
"costCenterChanges": [ { "from": "string", "to": "string", "reason": "string", "by": "string", "byName": "string", "at": "string" } ],
"budgetOwner": "string",
"buyerName": "string",
"supplierSite": "string",
"notes": "string",
"requestId": "string",
"lineItems": [
{
"lineNo": number,
"scopeType": "sku" | "service" | "account" | "custom",
"scopeId": "string" | null,
"name": "string",
"ruleType": "quantity" | "amount",
"unit": "string",
"unitPrice": number,
"qty": number,
"nteAmount": number,
"lineType": "goods" | "service",
"currency": "string",
"paymentTerms": "string",
"validFrom": "string",
"validUntil": "string",
"consumed": number,
"customerLineNo": "string",
"supplierSku": "string",
"priceSource": "contract" | "list" | "manual"
}
],
"approval": {
"requester": "string",
"requesterEmployeeKey": "string",
"groups": [
{
"id": "string",
"mode": "sequential" | "parallel",
"label": "string",
"status": "pending" | "approved" | "rejected",
"stages": [
{ "id": "string", "label": "string", "approverEmployeeKey": "string", "approverName": "string", "status": "pending" | "approved" | "rejected" }
]
}
],
"groupIndex": number,
"status": "pending" | "approved" | "rejected",
"history": [
{ "stage": "string", "by": "string", "at": "string", "action": "approved" | "rejected" | "limit_exceeded" | "reassigned" | "skipped" }
],
"autonomy": boolean,
"selfApproved": boolean
},
"supplierEmail": { "to": "string", "at": "string" },
"priorInvoiced": { "amount": number, "currency": "string", "basis": "invoiced" | "remaining", "sourceSystem": "sap_ariba" | "coupa" | "oracle", "importId": "string", "fileName": "string", "importedAt": "string", "importedBy": "string" },
"createdAt": "string"
}
]