Mensageria Outbox¶
Em uma frase. Consulta da fila de mensagens que o app NF-e deixava para outros apps da plataforma — uma por documento autorizado, cancelado, denegado ou inutilizado e uma por evento — com a situação de cada uma e o XML correspondente. Tela somente leitura.
Quem usa: suporte, analista fiscal ao investigar um documento que não chegou à escrituração · Frequência: eventual · Pré-requisitos: nenhum
Para que serve¶
Quando uma nota era autorizada, cancelada ou recebia um evento, o app NF-e gravava uma mensagem numa fila compartilhada da conta. Os outros apps, principalmente a Escrituração Fiscal, liam essa fila e davam baixa em cada mensagem. Esta tela mostra essas mensagens: o que foi colocado na fila, quando, se já foi consumido e, quando houve erro, o último erro.
A fila não recebe mais mensagens novas. Os documentos e eventos agora seguem direto para a Escrituração Fiscal, sem passar por esta fila. A tela continua útil para consultar o histórico do que foi enviado pelo caminho antigo. Por isso o período padrão (hoje) costuma voltar vazio: amplie as datas para ver o histórico.
Ela responde a perguntas como "o cancelamento desta chave chegou a ser enviado?", "quantas mensagens ficaram sem entregar?" e "qual XML foi enviado com este evento?".
Como chegar¶
- No Hub, abra o app Invent Docs Flow NF-e.
- Selecione o tile Outbox.
A tela de listagem¶
A lista abre sozinha com o período De / Até no dia de hoje e as mensagens mais recentes primeiro.
Cards de situação¶
Os cards contam as mensagens do período e dos filtros avançados. Clicar num card filtra a lista por aquela situação.
| Card | Significado |
|---|---|
| Todos | Todas as mensagens do filtro |
| Pendentes | Ainda não consumidas pelo app de destino |
| Publicados | Já consumidas |
| Mortos | O consumo falhou em todas as tentativas e a mensagem foi abandonada |
O que a lista mostra¶
O ícone de engrenagem liga e desliga colunas; a escolha fica gravada no navegador.
| Coluna | Conteúdo | Ordenável |
|---|---|---|
| Criado em | Data e hora em que a mensagem entrou na fila | sim |
| Tipo | Documento ou Evento | não |
| Evento | Tipo do evento (cancelamento, carta_correcao, manifestacao, inutilizacao…). Nos eventos da Reforma Tributária, mostra o código e a descrição do evento |
não |
| Chave | Chave de acesso do documento | sim |
| Situação | Código da situação do documento (ver abaixo) | não |
| Status | Pendente, Publicado ou Morto | sim |
| Tent. | Tentativas feitas / máximo de tentativas | sim |
| Próx. retry | Quando está prevista a próxima tentativa | não |
| Publicado em | Quando foi consumida | sim |
| Ações | Ver detalhes e, quando há XML, Baixar XML | — |
Situação do documento
| Código | Significado |
|---|---|
00 |
Documento regular (autorizado ou recebido de terceiro) |
02 |
Cancelado |
04 |
Denegado |
05 |
Numeração inutilizada |
Filtros¶
- De / Até — período de entrada na fila. Enter nas datas aplica.
- Mais filtros — Chave do documento (aceita trecho da chave), Tipo (Documento ou
Evento) e Evento (nome exato do tipo, ex.:
cancelamento). Os filtros ativos aparecem como etiquetas removíveis. - Atualizar — refaz a busca com os filtros atuais.
Sem resultado: "Nenhuma mensagem no outbox" — "Nada corresponde aos filtros (ou o produtor está desligado)." e o botão Limpar filtros.
Sub-telas¶
Detalhe da mensagem¶
Clicar na linha abre o detalhe. O título é Documento ou Evento · tipo; o cabeçalho mostra chave, modelo (55 ou 65), data de criação e o selo de status. Havendo erro, aparece em destaque "Último erro: …".
| Seção | Conteúdo |
|---|---|
| Dados da mensagem | Tipo, Evento, Modelo, Chave de acesso, Situação do documento, Criado em, Data do documento/evento, Tentativas, Próxima retentativa, Publicado em |
| Dados técnicos | Identificador da mensagem (envelope_id), Origem e versão, Account, Empresa e Sequência (seq) |
| Envelope canônico | O conteúdo completo da mensagem em JSON, aberto pelo botão Mostrar conteúdo |
Visualizar XML abre o XML autorizado do documento ou o XML do evento, com opção de download
(<chave>.xml). Voltar para Mensageria Outbox retorna à lista.
Regras de negócio¶
- RN-OUT-001 — Somente leitura. A tela não cria, reenvia, edita nem apaga mensagem.
- RN-OUT-002 — Só as mensagens do app NF-e. A fila é compartilhada pelos apps da conta; esta tela mostra apenas as mensagens de origem NF-e do tenant.
- RN-OUT-003 — Sem mensagens novas. O envio à Escrituração Fiscal passou a ser direto; a fila guarda o histórico anterior.
- RN-OUT-004 — Só estados finais viravam mensagem. Um documento entrava na fila autorizado
(
00), recebido de terceiro (00), cancelado (02), denegado (04) ou inutilizado (05). Rascunho e rejeitado nunca entravam. - RN-OUT-005 — O interruptor da empresa decidia. Só entrava na fila o documento de empresa com Usar Escrituração Fiscal ligado (em Emissão para os emitidos, em Recebimento para os recebidos).
- RN-OUT-006 — Quem consome é o app de destino. A mudança de Pendente para Publicado, as tentativas e o status Morto são registrados por quem lê a fila; o app NF-e só a preenchia. O máximo padrão é de 8 tentativas.
- RN-OUT-007 — Cards e lista usam os mesmos filtros, exceto o status, que é o próprio card.
- RN-OUT-008 — O período é do dia em UTC. As datas De/Até são comparadas com o horário universal: mensagens criadas entre 21h e meia-noite (horário de Brasília) caem no dia seguinte.
O que esta tela não faz¶
- Não reenvia nem reprocessa mensagem. Uma mensagem Morta precisa ser tratada pelo suporte.
- Não mostra mensagens de outros apps da conta.
- Não mostra o que foi enviado pelo caminho novo. Para conferir se um documento chegou à escrituração, consulte o próprio app Escrituração Fiscal.
- Não altera a nota. Status da nota e eventos ficam nas listagens de documentos.
Erros e mensagens¶
| Mensagem | Causa | O que fazer |
|---|---|---|
| Aguardando contexto do Hub… | A tela ainda não recebeu a identificação do usuário | Aguardar; persistindo, recarregar pelo Hub |
| Nenhuma mensagem no outbox | Filtro sem resultado (comum no período de hoje, ver RN-OUT-003) | Ampliar o período ou limpar filtros |
| Não foi possível carregar a mensagem. | Falha ao abrir o detalhe | Tentar de novo |
| Mensagem do outbox não encontrada. | A mensagem não existe mais ou é de outro tenant | Voltar à lista e atualizar |
| XML não disponível para esta mensagem. | O XML não pôde ser localizado (ver Perguntas frequentes) | Abrir o documento pela listagem de NF-e |
| Status inválido / message_type inválido | Filtro com valor fora do domínio | Usar os valores da tela |
Relação com a NF-e / SEFAZ / EFD¶
Cada mensagem carregava o que a Escrituração Fiscal precisa para escriturar o documento: chave, modelo (55 ou 65), situação e, nos eventos, o tipo e o protocolo.
A Situação segue a codificação do campo COD_SIT do registro C100 da EFD-ICMS/IPI
[Guia Prático EFD-ICMS/IPI 3.2.3, p. 65]. Para documento cancelado (02), denegado (04) e
numeração inutilizada (05), o C100 leva só os campos de identificação e nenhum registro filho;
na inutilização, sem a chave [Guia Prático EFD-ICMS/IPI 3.2.3, p. 63].
Perguntas frequentes¶
Abri a tela e está tudo zerado. É o esperado no período de hoje: a fila não recebe mensagens novas (RN-OUT-003). Amplie o período.
Uma mensagem está como Morta. O documento ficou fora da escrituração? Provavelmente sim, pelo caminho antigo. Confira no app Escrituração Fiscal e acione o suporte.
O botão Baixar XML aparece, mas o XML não abre. Numa mensagem de documento recebido de terceiro, a tela procura o XML entre as notas emitidas e não o encontra. Baixe o XML pela listagem de NF-e recebidas.