- O WebmaniaBR NF-e emite a nota fiscal eletrônica dos pedidos da sua loja virtual, sem que você precise redigitar os dados em outro sistema.
- Os dados do pedido (cliente, endereço, produtos, frete, forma de pagamento e transportadora) são enviados para a WebmaniaBR, que se comunica com a Sefaz e devolve o DANFE e o XML da nota.
- A emissão pode ser feita manualmente, pedido a pedido, em lote pela listagem de pedidos, ou automaticamente assim que o pedido entra em Processando ou Concluído.
- Disponível para lojas Magento 2. É necessário ter uma assinatura ativa na WebmaniaBR e um certificado digital A1 válido cadastrado na conta.
Passo a Passo por Escrito
1. Acesse as configurações do módulo no painel administrativo
No menu lateral do admin, acesse Lojas → Configuração. Na coluna da esquerda, localize o grupo WebmaniaBR NF-e e clique em Configurações Gerais.
O nome do grupo no menu vem acompanhado do número da versão instalada, por exemplo WebmaniaBR NF-e - v3.1.7.4. É normal que esse número mude após uma atualização do módulo.
Resultado esperado: A tela de configuração é exibida com os blocos Credenciais de Acesso, Configuração Padrão e Informações Complementares (Opcional).
2. Ative o módulo e informe as credenciais de acesso
No bloco Credenciais de Acesso, marque Ativar Módulo como Ativado e preencha os quatro campos de credenciais fornecidos pela WebmaniaBR no momento da assinatura:
- Consumer Key
- Consumer Secret
- Access Token
- Access Token Secret
Em seguida, escolha o Ambiente Sefaz:
- Desenvolvimento — as notas são emitidas em ambiente de homologação, sem valor fiscal. Use enquanto estiver testando.
- Produção — as notas passam a ter valor fiscal real.
Clique em Salvar Configuração.
Sem as quatro credenciais preenchidas corretamente o módulo não consegue se comunicar com a WebmaniaBR e nenhuma nota é emitida. Se você não possui essas chaves, solicite-as ao suporte da WebmaniaBR.
O Ambiente Sefaz vem configurado como Desenvolvimento por padrão. Só altere para Produção quando terminar os testes — notas emitidas em produção têm valor fiscal e obrigações legais.
Resultado esperado: Uma mensagem de "A configuração foi salva" é exibida no topo da tela e os avisos de credenciais pendentes deixam de aparecer no painel.
3. Defina a configuração padrão da nota
Ainda em Configurações Gerais, abra o bloco Configuração Padrão. Os valores preenchidos aqui valem para toda a loja e são usados sempre que o produto não tiver a informação equivalente cadastrado nele.
| Campo | O que preencher |
|---|---|
| Emissão Automática | Ativado para que a nota saia sozinha quando o pedido entrar em Processando ou Concluído. Desativado para emitir manualmente. |
| Envio automático de e-mail | Ativado para que o e-mail do cliente seja enviado junto com a nota, permitindo o envio automático do DANFE pela WebmaniaBR. |
| Natureza da Operação | Descrição da operação que aparece na nota, por exemplo Venda de mercadoria. |
| Modelo | NF-e (nota fiscal eletrônica) ou NFC-e (nota fiscal de consumidor eletrônica). |
| Classe de imposto | Código da classe de imposto cadastrada na sua conta WebmaniaBR. |
| GTIN | Código de barras padrão, usado quando o produto não tiver o próprio. Antigo código EAN. |
| GTIN tributável | Código de barras da unidade tributável, quando diferente do anterior. |
| Código NCM | Classificação fiscal padrão dos seus produtos. |
| Código CEST | Código CEST padrão, quando aplicável ao seu segmento. |
| Unidade | Unidade ou Kilograma — como os itens são medidos na nota. |
| Indicador de Escala Relevante | S ou N, conforme a legislação aplicável aos seus produtos. |
| Origem do Produto | Origem padrão (nacional, importada, etc.) dos itens vendidos. |
| Modalidade do Frete Padrão | Quem contrata o frete: remetente (CIF), destinatário (FOB), terceiros, transporte próprio ou sem ocorrência de transporte. |
Clique em Salvar Configuração.
Natureza da Operação, Classe de imposto, Código NCM e Origem do Produto são cobrados pelo módulo. Enquanto algum deles estiver vazio, um aviso permanece no topo do painel administrativo e a emissão pode ser recusada.
Esses valores funcionam como padrão de segurança. Se o produto tiver o próprio NCM, CEST, GTIN, unidade, classe de imposto ou origem preenchidos, o valor do produto sempre tem prioridade sobre o valor definido aqui.
Resultado esperado: A configuração é salva e os avisos sobre Natureza da Operação, Classe de Imposto, NCM e Origem do Produto desaparecem do topo do painel.
4. Preencha as informações complementares (opcional)
No bloco Informações Complementares (Opcional) você pode incluir dois textos que serão impressos em todas as notas emitidas:
- Informações ao Fisco — observações destinadas ao órgão fiscalizador.
- Informações Complementares ao Consumidor — mensagem destinada ao cliente que recebe a nota.
Clique em Salvar Configuração.
Os dois campos são opcionais. Se ficarem vazios, a nota é emitida normalmente, apenas sem esses textos adicionais.
Resultado esperado: Os textos são salvos e passam a constar em todas as próximas notas emitidas.
5. Mapeie as formas de pagamento
Na coluna da esquerda, dentro do grupo WebmaniaBR NF-e, clique em Métodos de Pagamento.
O quadro Mapeamento dos Campos relaciona cada meio de pagamento ativo na sua loja com a forma de pagamento correspondente exigida pela nota fiscal. Para cada linha:
- Clique em Add para criar uma nova linha.
- Em Método de Pagamento, selecione o meio de pagamento da sua loja (o mesmo nome que o cliente vê no checkout).
- Em Formas de Pagamento, selecione o equivalente fiscal: Dinheiro, Cartão de Crédito, Cartão de Débito, Boleto Bancário, Pagamento Instantâneo (PIX), Transferência bancária, Carteira Digital, entre outros.
- Repita para todos os meios de pagamento ativos na loja.
Clique em Salvar Configuração.
Um pedido pago com um meio de pagamento que não foi mapeado aqui não consegue gerar nota. A emissão é interrompida com uma mensagem informando qual método precisa ser configurado.
Linhas com Selecionar em qualquer uma das duas colunas são descartadas ao salvar. Confira se todas as linhas ficaram preenchidas depois de salvar a tela.
Resultado esperado: As linhas mapeadas permanecem visíveis após salvar e o aviso sobre mapeamento de métodos de pagamento desaparece do topo do painel.
6. Configure as linhas de endereço
A nota fiscal exige o endereço do cliente separado em quatro partes: Endereço, Número, Complemento e Bairro. Na coluna da esquerda, dentro do grupo WebmaniaBR NF-e, clique em Linhas de Endereço.
Você tem dois caminhos:
- Deixar o módulo montar os campos — marque Ativar Personalização como Sim. O módulo passa a exibir os quatro campos separados no cadastro do cliente e no checkout. Para cada um deles você pode ajustar o Texto (rótulo exibido ao cliente), se o campo é Obrigatório e, nos campos de número, complemento e bairro, se ele fica ativo (Ativar Campo).
- Usar os campos que a loja já tem — marque Ativar Personalização como Não e, no bloco Mapeamento de Campos, indique qual linha de endereço da sua loja corresponde a Endereço, Número, Complemento e Bairro.
Clique em Salvar Configuração.
A loja precisa estar configurada com 4 linhas de endereço. O módulo ajusta essa configuração durante a instalação, mas se ela for reduzida depois, um aviso passa a ser exibido no topo do painel e os endereços chegam incompletos na nota.
Resultado esperado: Ao abrir o checkout da loja, o campo de endereço aparece dividido conforme a configuração escolhida, com os rótulos que você definiu.
7. Cadastre as transportadoras (opcional)
Se você despacha os pedidos por transportadora e precisa que os dados dela constem na nota, acesse Lojas → Configuração → WebmaniaBR NF-e → Transportadoras.
Clique em Add e preencha uma linha por transportadora:
- Método de Entrega — o meio de envio da sua loja que corresponde a essa transportadora.
- Nome Completo / Razão Social
- CPF / CNPJ
- Inscrição Estadual
- Endereço
- CEP
- UF
- Cidade
Clique em Salvar Configuração.
Não é necessário preencher esta tela para envios pelos Correios. O cadastro só é usado quando você marcar a opção de utilizar transportadora dentro do pedido, no passo 9.
Linhas com qualquer campo em branco são descartadas ao salvar. Preencha todos os oito campos de cada transportadora.
Resultado esperado: As transportadoras cadastradas permanecem listadas na tela após salvar.
8. Complete as informações fiscais dos produtos e das categorias
Acesse Catálogo → Produtos, abra um produto e localize a seção Informações Fiscais (NF-e). Os campos disponíveis são:
- Ignorar Produto ao Emitir NF-e — marque Sim para que o item não entre na nota.
- Classe de Imposto
- Código de Barras EAN (GTIN)
- GTIN tributável
- Código NCM
- Código CEST
- Unidade — Unidade, Kilograma ou Definir via Configurações Gerais.
- CNPJ do Fabricante
- Indicador de Escala Relevante
- Origem do Produto
Você também pode definir um NCM por categoria. Acesse Catálogo → Categorias, selecione a categoria e abra a seção Informações Fiscais (NF-e) para preencher o campo NCM.
Todo produto que entra na nota precisa ter Peso e Origem do Produto válidos. Se algum item do pedido estiver sem peso ou sem origem, a emissão é interrompida e o módulo informa exatamente qual produto precisa ser corrigido.
O NCM é buscado em três níveis, nesta ordem: primeiro no produto, depois nas categorias em que ele está cadastrado e, por último, no Código NCM definido nas Configurações Gerais.
Resultado esperado: Após salvar o produto, os dados fiscais passam a ser usados na próxima nota que incluir esse item.
9. Emita a nota fiscal dos pedidos
Com tudo configurado, existem três formas de emitir:
Pedido a pedido. Acesse Vendas → Pedidos, abra o pedido e clique no botão Emitir NF-e no topo da tela.
Vários pedidos de uma vez. Em Vendas → Pedidos, marque os pedidos desejados na listagem, abra o menu Ações e selecione Emitir NF-e.
Automaticamente. Se você marcou Emissão Automática como Ativado no passo 3, a nota é emitida sozinha assim que o pedido é salvo com o status Processando ou Concluído.
Se o pedido for despachado por transportadora, antes de emitir abra a aba Transportadoras NF-e na página do pedido, marque Utilizar transportadora e os seguintes dados e preencha Volume, Espécie, Peso Bruto e Peso Líquido. Clique em Salvar Dados.
Os quatro campos da aba Transportadoras NF-e são obrigatórios quando a opção de utilizar transportadora está marcada. Sem eles a emissão é interrompida com uma mensagem indicando o que falta.
Assim que a nota é aprovada, o módulo registra um comentário no histórico do pedido com a data da emissão e um link para visualizar o DANFE.
Resultado esperado: Uma mensagem confirma que a nota fiscal do pedido foi gerada e a coluna Status da NF-e, na listagem de pedidos, passa a exibir o andamento da nota.
Validação e Testes
Após concluir a configuração, execute os testes abaixo para confirmar o funcionamento correto.
Teste 1 — Conferir credenciais e certificado digital
Ação: acesse qualquer tela do painel administrativo e observe a área de mensagens no topo. O módulo verifica automaticamente as credenciais e a validade do certificado digital A1 cadastrado na sua conta WebmaniaBR.
Resultado esperado: Nenhum aviso do WebmaniaBR NF-e é exibido. Se aparecer um aviso de chaves inválidas, revise o passo 2; se aparecer aviso de certificado vencido ou próximo do vencimento, renove o certificado na sua conta WebmaniaBR.
Teste 2 — Emitir uma nota em ambiente de homologação
Ação: com o Ambiente Sefaz em Desenvolvimento, faça um pedido de teste na loja com um produto que tenha peso, NCM e origem preenchidos, e cujo meio de pagamento esteja mapeado. Abra o pedido em Vendas → Pedidos e clique em Emitir NF-e.
Resultado esperado: A mensagem de nota gerada com sucesso é exibida e o histórico do pedido recebe um comentário com o link para o DANFE.
Teste 3 — Acompanhar o status da nota na listagem
Ação: acesse Vendas → Pedidos e localize a coluna Status da NF-e na listagem.
Resultado esperado: O pedido do teste anterior exibe um dos status: Processamento, Aprovada, Reprovado, Cancelado ou Contingência. Pedidos ainda sem nota exibem Não Emitida.
Teste 4 — Emissão automática
Ação: com Emissão Automática em Ativado, faça um novo pedido de teste e mude o status dele para Processando.
Resultado esperado: A nota é emitida sem qualquer clique adicional, e o histórico do pedido registra um comentário identificando a emissão automática.
Se não funcionar, verifique:
- Se Ativar Módulo está marcado como Ativado e as quatro credenciais estão preenchidas sem espaços extras.
- Se o meio de pagamento do pedido está mapeado em Métodos de Pagamento.
- Se todos os produtos do pedido têm Peso e Origem do Produto preenchidos.
- Se o cliente do pedido tem CPF ou CNPJ cadastrado.
- Se o endereço do pedido tem as quatro partes preenchidas (endereço, número, complemento e bairro) e o estado informado.
- Se Natureza da Operação, Classe de imposto, Código NCM e Origem do Produto estão preenchidos nas Configurações Gerais.
- Se Modo Desenvolvedor, em Configurações Avançadas, está Desativado.
- Se, após qualquer alteração de configuração, o cache da loja foi limpo em Sistema → Gerenciamento de Cache.
Pronto! Dessa forma realizamos a configuração do WebmaniaBR NF-e em sua loja virtual Magento 2.
Observações Importantes
-
As configurações são globais. As credenciais, a configuração padrão e as informações complementares valem para toda a loja. Não é possível usar credenciais diferentes por visão de loja.
-
O módulo emite, mas não cancela notas. O cancelamento de uma nota já emitida é feito diretamente no painel da WebmaniaBR. O status Cancelado aparece na listagem de pedidos quando o cancelamento é processado por lá.
-
Nota duplicada é bloqueada. Se o pedido já tem uma nota aprovada, uma nova tentativa de emissão é recusada com o aviso de que já existe nota fiscal para aquele pedido.
-
Produtos ignorados saem do total. Ao marcar Ignorar Produto ao Emitir NF-e como Sim, o item não entra na nota e o valor dele é descontado do total informado à Sefaz.
-
Kits são detalhados na nota. Produtos do tipo kit não aparecem como um item único: cada produto que compõe o kit entra individualmente na nota, com quantidade e preço proporcionais.
-
Produtos configuráveis entram na nota pelo produto principal. Quando o cliente compra um produto configurável, a nota registra o nome, o código e o peso do produto principal, não os da variação escolhida. Por isso o produto principal também precisa ter Peso preenchido, mesmo que só as variações sejam vendidas.
-
CPF ou CNPJ é obrigatório. O documento é buscado primeiro no endereço de cobrança e, se não estiver lá, no cadastro do cliente. Sem um documento válido a emissão é interrompida.
-
Inscrição Estadual do cliente. O campo Inscrição Estadual (I.E.) é criado no cadastro do cliente e fica disponível apenas para preenchimento pelo painel administrativo, não pelo cadastro que o cliente faz na loja.
O Modo Desenvolvedor, em Lojas → Configuração → WebmaniaBR NF-e → Configurações Avançadas, existe apenas para diagnóstico junto ao suporte. Com ele ativado, a emissão é interrompida e os dados do pedido são exibidos na tela em vez de enviados. Nunca deixe essa opção ligada em uma loja em produção.
Referências e Relacionados
- Configuração de cache da loja: após qualquer alteração nas configurações do módulo é necessário limpar o cache para que as mudanças entrem em vigor.
- Atributos de produto: o módulo adiciona uma seção de informações fiscais na ficha do produto. Esta doc ajuda a entender como funcionam os campos personalizados do catálogo.
- Gerenciamento de pedidos: a emissão da nota parte da tela do pedido e do status dele. Esta doc cobre o fluxo de pedidos que antecede a emissão.
- Configuração de impostos: os dados fiscais informados na nota precisam ser coerentes com a configuração tributária da loja.
Caso tenha ficado alguma dúvida entre em contato com nosso time de suporte através do chat online dentro da sua loja virtual ou através do e-mail web@tryideas.com.br