xMotivo
Descrição literal do status da NFGas
Onde fica no arquivo
No documento
-
nfgasProc/protNFGas/infProt/xMotivo
Obrigatório, uma vez
Na resposta do web service
-
retConsSitNFGas/xMotivo
Obrigatório, uma vez
Descrição literal do status do serviço solicitado.
-
retConsStatServNFGas/xMotivo
Obrigatório, uma vez
Descrição literal do status do serviço solicitado.
-
retNFGas/xMotivo
Obrigatório, uma vez
Descrição literal do status do do retorno da consulta.
-
retEventoNFGas/infEvento/xMotivo
Obrigatório, uma vez
Descrição literal do status do registro do Evento
-
retNFGas/protNFGas/infProt/xMotivo
Obrigatório, uma vez
No arquivo distribuído (documento + protocolo)
-
procEventoNFGas/retEventoNFGas/infEvento/xMotivo
Obrigatório, uma vez
Descrição literal do status do registro do Evento
O caminho até aqui, nível a nível
Dentro do grupo infProt , dados do protocolo de status
O que o arquivo aceita neste campo
- Ocorrência
- 1-1
- Tamanho
- 1 a 255
- Tipo no esquema
- TMotivo
- Formato base
- TString
Formato exigido: [!-ÿ]{1}[ -ÿ]{0,}[!-ÿ]{1}|[!-ÿ]{1} Texto livre que não pode começar nem terminar com espaço. O esquema aceita acento e cedilha; caractere de controle é recusado. Expressão do próprio esquema. Valor que não casar com ela é recusado na validação do arquivo, antes de qualquer regra de negócio. ⚠ A leitura acima sai da EXPRESSÃO, não do nome do tipo: nome de tipo se expande por palpite e palpite publica regra errada.
O mesmo nome em outros documentos fiscais — 10
xMotivo aparece no leiaute de outros documentos, e isso não quer dizer que seja o mesmo campo: cada um tem manual, regra e às vezes tipo próprios. Aplicar a regra de
um documento no outro é o erro que esta lista existe para evitar. Cada linha traz o caminho no arquivo daquele
documento, que é onde a diferença aparece primeiro.
| Documento | O que o leiaute dele diz | Caminho lá |
|---|---|---|
| BP-e | Descrição literal do status do BP-e. | bpeTMProc/protBPe/infProt/xMotivo |
| CT-e | Descrição literal do status do CT-e. | cteSimpProc/protCTe/infProt/xMotivo |
| CT-e OS | Descrição literal do status do CT-e. | cteOSProc/protCTe/infProt/xMotivo |
| DC-e | Descrição literal do status da DCe | dceProc/protDCe/infProt/xMotivo |
| GTV-e | Descrição literal do status da GTV-e. | GTVeProc/protCTe/infProt/xMotivo |
| MDF-e | Descrição literal do status do registro do Evento | procEventoMDFe/retEventoMDFe/infEvento/xMotivo |
| NF3e | Descrição literal do status do registro do Evento | procEventoNF3e/retEventoNF3e/infEvento/xMotivo |
| NFAg | Descrição literal do status do registro do Evento | procEventoNFAg/retEventoNFAg/infEvento/xMotivo |
| NFCom | Descrição literal do status do registro do Evento | procEventoNFCom/retEventoNFCom/infEvento/xMotivo |
| NFS-e Via | Descrição para explicitar o motivo indicado neste evento | evento/infEventoVia/e101101/xMotivo |
Campos do mesmo grupo — 8
São os campos que ficam ao lado deste no arquivo, dentro de nfgasProc/protNFGas/infProt. Quem
preenche um costuma precisar dos outros na mesma passada.
Perguntas frequentes
O que é o campo xMotivo da NFGas?
Descrição literal do status da NFGas No XML ele fica em nfgasProc/protNFGas/infProt/xMotivo. Obrigatório, uma vez, com tamanho 1 a 255.
xMotivo aparece em quantos lugares da NFGas?
Em 7 posições do esquema oficial: nfgasProc/protNFGas/infProt/xMotivo, retConsSitNFGas/xMotivo, retConsStatServNFGas/xMotivo, retNFGas/xMotivo, retEventoNFGas/infEvento/xMotivo, retNFGas/protNFGas/infProt/xMotivo e outras. A mesma tag em posições diferentes tem ocorrência própria em cada lugar — o que vale no grupo do emitente não vale automaticamente no do destinatário.
Que formato o campo xMotivo exige na NFGas?
Texto livre que não pode começar nem terminar com espaço. O esquema aceita acento e cedilha; caractere de controle é recusado. A regra é a expressão do próprio esquema ([!-ÿ]{1}[ -ÿ]{0,}[!-ÿ]{1}|[!-ÿ]{1}), e ela é verificada antes de qualquer regra de negócio: valor fora do formato faz o arquivo ser recusado na validação, com rejeição genérica de schema — que é a mais difícil de diagnosticar justamente por não citar o campo.
xMotivo na NFGas é o mesmo campo dos outros documentos fiscais?
O nome se repete no leiaute de 10 outros documentos (BP-e, CT-e, CT-e OS, DC-e, GTV-e, MDF-e, NF3e, NFAg, NFCom, NFS-e Via), e isso não quer dizer que seja o mesmo campo: cada documento tem manual próprio, regra própria e às vezes tipo diferente. Aplicar a regra de um no outro é erro comum e caro.
De onde vem esta descrição da NFGas?
Do esquema XML oficial (PL_NFGas_NT2026.004_RTC_1.00). O Buscador NCM lê a árvore do próprio arquivo: tipo, tamanho, ocorrência e domínio saem sem interpretação. O manual manda na REGRA de validação; o esquema manda no CAMPO.