Skip to main content
O módulo de Compras segue um fluxo em três etapas: uma área solicita a compra (Requisição), a compra é aprovada e organizada internamente (Ordem) e, por fim, é formalizada junto ao fornecedor (Pedido). Fluxo de Compras: Requisição → Ordem → Pedido

Requisição de Compra

Use /compras/requisicao/create para abrir uma requisição. O número é gerado automaticamente.

Campos obrigatórios

codigoDaFilial, codigoDoTipoDeCompra, codigoDoColaborador e itens (com ao menos 1 item).
Exemplo:
Resposta:
Campos obrigatórios ausentes ou inválidos retornam 400 com o detalhe em notifications/errors.

Ordem de Compra

Depois de aprovada, a requisição dá origem a uma Ordem de Compra (POST /v2/compras/ordem), com a mesma estrutura de cabeçalho e itens da Requisição. É nesta etapa que a compra é organizada internamente antes de ser enviada a um fornecedor.

Pedido de Compra

O POST /v2/compras/pedido formaliza a compra junto a um fornecedor específico.
Diferente dos demais endpoints de escrita da API, este sempre responde 200, mesmo quando a operação falha por regra de negócio. Verifique data.notifications: vazio indica sucesso (com o pedido em data.payload); não vazio indica falha.
O data.payload de retorno usa um formato diferente do retornado nas rotas de consulta (GET) — não assuma a mesma estrutura.
Exemplo:
Resposta (sucesso):
Resposta (falha de regra de negócio, ainda com HTTP 200):

Planejamento orçamentário e cadastros de apoio

O Planejamento Orçamentário (/v2/compras/planejamento) permite definir limites de gasto por filial, centro de custo, item de lançamento e projeto em um dado período (ano/mês), servindo de referência para aprovação de requisições e ordens. Os Tipos e Motivos de Compra (/v2/compras/gerenciamento/*) são cadastros de apoio consultados ao abrir uma Requisição ou Ordem.