VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

NF-e (nota fiscal)

O que é a NF-e, como a loja a emite pela FocusNFe e quais operações o painel oferece.

A NF-e (nota fiscal eletrônica) é o documento fiscal que o vendedor brasileiro precisa emitir em uma venda de mercadoria. Ela é enviada à SEFAZ (a Secretaria da Fazenda do estado), que a autoriza e devolve uma chave de acesso de 44 dígitos. A Venddor não fala direto com a SEFAZ: usa a FocusNFe, um provedor que faz a emissão e devolve o resultado. O DANFE é a versão em PDF da nota, entregue ao cliente junto com o XML.

Pontos principais
  • Tudo fica atrás do módulo focusnfe e do privilégio manage_nfe ou manage_settings.
  • A emissão é assíncrona: a resposta volta com status: processando e o resultado final chega por webhook da FocusNFe ou por consulta (check-status).
  • Valores são inteiros em centavos; alíquotas em pontos-base (1800 = 18,00%).
  • Cancelar só é possível dentro de 24 horas após a autorização (regra da SEFAZ), com justificativa de 15 a 255 caracteres.
  • Uma nota autorizada não pode ser editada: erros de texto se corrigem com carta de correção (CC-e); erros de valor ou de destinatário exigem cancelar e emitir de novo.
  • Mês contábil fechado bloqueia a emissão (423 period_closed).

Como funciona

  1. O módulo focusnfe precisa estar ligado e com token, CNPJ e certificado digital A1 configurados na tela de módulos. Consulte o certificado.
  2. Você emite a nota de um pedido. Com auto_issue_on_complete ligado, a plataforma também emite sozinha quando o pedido é concluído.
  3. A nota entra como processando. Quando a SEFAZ responde, passa a autorizado, erro ou denegado.
  4. Com a nota autorizado, baixe o XML e o DANFE.
  5. Se algo estiver errado, cancele, corrija ou inutilize.
processando→autorizado→cancelado

Status (status)

ValorSignificado
processandoEnviada, aguardando a SEFAZ.
autorizadoAceita. chave_nfe, xml_url e danfe_url existem.
erroRejeitada. Veja error_msg e error_message.
denegadoA SEFAZ negou o uso. O número não pode ser reaproveitado.
canceladoCancelada dentro do prazo.
inutilizadoFaixa de números declarada como não usada.

Conceitos

Inutilização

Quando a numeração pula (por exemplo, uma emissão falhou antes de chegar à SEFAZ), a lei exige avisar a SEFAZ que aqueles números não serão usados. É a inutilização, de uma faixa de números dentro de uma série.

Modo de simulação

Lojas de demonstração podem ligar simulation_mode: nada vai à SEFAZ e os registros servem só como exemplo. O cancelamento nesse modo é gravado só localmente.

Pedido de seller

Em pedidos com vários sellers, cada seller pode ter a própria nota (vendor_id). Sellers com configuração fiscal própria usam o token deles.

Endpoints

MétodoCaminhoPara quê
POST/api/v1/admin/nfe/issueEmite a partir do pedido
POST/api/v1/admin/nfeEmite com dados manuais
GET/api/v1/admin/nfeLista notas
GET/api/v1/admin/nfe/{id}Consulta uma nota
POST/api/v1/admin/nfe/{id}/check-statusConsulta o status na FocusNFe
GET/api/v1/admin/nfe/certificate-statusSituação do certificado
GET/api/v1/admin/nfe/{id}/xmlBaixa o XML
GET/api/v1/admin/nfe/{id}/danfeBaixa o DANFE
POST/api/v1/admin/nfe/{id}/cancelCancela
DELETE/api/v1/admin/nfe/{id}Cancela (rota antiga)
POST/api/v1/admin/nfe/{id}/cceCarta de correção
POST/api/v1/admin/nfe/inutilizeInutiliza números

Erros comuns

  • Emitir de novo achando que duplica. POST /nfe/issue é idempotente por pedido: se já existe nota, devolve a existente com 200.
  • Cliente sem documento. Pedido sem CPF/CNPJ do cliente volta 422 customer_document_missing.
  • Quantidade fracionada. Linhas em kg ou litros com quantidade decimal são recusadas (422 fractional_quantity_not_supported): a NF-e só aceita quantidade inteira aqui.
  • Token da FocusNFe recusado. Volta 422; corrija o token em Módulos, FocusNFe.
  • Cancelar fora do prazo. Depois de 24 horas a FocusNFe recusa (502 com a mensagem do provedor).
  • Baixar XML de nota não autorizada. Volta 500, pois não há arquivo.
  • Usar CC-e para corrigir valor. A carta nunca corrige valores, impostos nem dados do destinatário.

Próximos passos

Emitir
Gere a nota de um pedido.
Consultar
Acompanhe o status e o certificado.
Cancelar e corrigir
Cancelamento, CC-e e inutilização.
Anterior
Consultas: CNPJ, CNAE e UFs
Próxima
Emitir NF-e
Nesta página
  • Como funciona
  • Status (status)
  • Conceitos
  • Inutilização
  • Modo de simulação
  • Pedido de seller
  • Endpoints
  • Erros comuns
  • Próximos passos