Referência da API

Aprovações

Os pedidos de compra e as faturas que aguardam você.

Mais sobre este recurso

A fila de aprovação de quem chama: os pedidos de compra e as faturas cuja etapa atual indica essa pessoa.

Listar aprovações

Lista os documentos que aguardam a sua aprovação.

GET/v1/workspaces/{regionId}/approvals

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Lista os pedidos de compra e as faturas deste espaço de trabalho cuja etapa de aprovação atual indica quem chama e, para um administrador, os documentos cuja etapa atual não indica ninguém e por isso precisam de um aprovador atribuído.

Alterado em 2026-09-24, uma correção de segurança dentro da v1: needsAssignment só é preenchido para um administrador conectado, o único chamador que pode reatribuir uma etapa. Para uma chave de API, qualquer que seja a função de compras dela, todas as listas vêm vazias: nenhuma etapa de aprovação pode indicar uma chave.

Campos da resposta

  • purchaseOrders / invoicesarray

    Documentos em uma etapa que indica quem chama.

  • needsAssignmentobject

    Documentos cuja etapa atual não indica ninguém. Vazio, a menos que quem chama seja um administrador conectado.

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}/approvals
Requisição
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/approvals" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Resposta · 200 OK
{
   "purchaseOrders": [ PurchaseOrder ],
   "invoices": [ Invoice ],
   "needsAssignment": { "purchaseOrders": [ PurchaseOrder ], "invoices": [ Invoice ] }
}
Fale conosco