Visão Geral
A API de Notas Fiscais de Saída do WMS foi desenvolvida para receber de sistemas externos as notas fiscais emitidas após a conclusão do processo de separação e conferência no armazém. Seu objetivo é concluir o fluxo de expedição iniciado anteriormente por meio da API de Documentos de Saída. O fluxo esperado é:- O sistema externo consulta a disponibilidade de estoque.
- O pedido é enviado ao WMS através da API de Documentos de Saída.
- O WMS realiza o processo de separação e conferência.
- Após a conclusão da operação, o pedido é disponibilizado para faturamento.
- O sistema externo realiza o faturamento.
- A Nota Fiscal emitida é enviada ao WMS através desta API.
- O WMS valida a Nota Fiscal contra os documentos e quantidades efetivamente conferidas.
- Após a validação, a Nota Fiscal é vinculada aos documentos e ao romaneio correspondente.
- produto;
- lote;
- unidade de medida;
- quantidade conferida.
/v1/expedicao
Headers
Campos
Nota Fiscal
Quando os totais não forem informados, o WMS poderá calculá-los a partir dos itens e dos dados cadastrados dos produtos.
Expedição
Todos os documentos informados devem pertencer ao mesmo romaneio.
Documentos da Expedição
Quando
origem_id for informado, o WMS também valida se o valor corresponde ao identificador recebido anteriormente na criação do Documento de Saída.
Emitente
Destinatário
Itens [array]
Caso
valor_total não seja informado e valor_unitario seja enviado, o WMS calcula:
quantidade × valor_unitario
Quando os pesos totais do item não forem informados, poderão ser calculados através da quantidade e dos pesos unitários cadastrados no produto.
Produto
Validações da Expedição
Antes de concluir o faturamento, o WMS realiza as seguintes validações:- o romaneio precisa existir e pertencer à empresa autenticada;
- todos os Documentos de Saída precisam existir;
- todos os documentos precisam pertencer ao romaneio informado;
- quando informado, o
origem_idprecisa corresponder ao Documento de Saída; - um Documento de Saída não pode estar vinculado a outra Nota Fiscal;
- os documentos precisam possuir itens efetivamente conferidos;
- os itens da Nota Fiscal precisam corresponder à soma dos itens conferidos dos documentos informados;
- a comparação é realizada por produto, lote e unidade;
- a quantidade faturada precisa corresponder à quantidade efetivamente conferida.
Uma Nota Fiscal para vários pedidos
É permitido que vários Documentos de Saída sejam faturados em uma única Nota Fiscal.Exemplo
Erros comuns
- Se o produto, emitente ou destinatário ainda não existir, será criado automaticamente vinculado à empresa.
- A função respeita as RLS policies para garantir que o usuário só altere dados da empresa à qual está vinculado.

