Exibir origem

Função: Método destinado ao retorno dos eventos da nota fiscal eletrônica. A tag <XML_SIG> foi incluída para atender a obrigatoriedade do item 4.9. Armazenamento e Disponibilização, conforme descrito na Nota Técnica 2011/003.

Uso do Banco de dados: Persistente.

<soapenv:Body>

<nfs:USERTOKEN>STRING</nfs:USERTOKEN>

<nfs:ID_ENT>STRING</nfs:ID_ENT>

<nfs:ID_EVENTO>STRING</nfs:ID_EVENTO>

<nfs:EVENCHVNFE>STRING</nfs:EVENCHVNFE>

</soapenv:Body>

Parâmetro	Tipo	Tam	Pai	Observação
USERTOKEN	Alfanumérico	006	-	Token de bilhetagem para execução do serviço.
ID_ENT	Alfanumérico	006	-	Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.
ID_EVENTO	Alfanumérico	054	-	Identificador do Evento. A regra de formação do Id é: ID+Código do Evento+Chave da NF-e+Sequência do Evento (Opcional, é utilizado no caso de retornar apenas um evento).
EVENCHVNFE	Alfanumérico	044	-	Chave da NF-e (Opcional, é utilizado no caso de retornar todos os eventos de uma NF-e).

<soap:Body>

<NFERETORNAEVENTORESULT>

<NFERETORNAEVENTO>

<ID_ENT>STRING</ID_ENT>

<LOTE>INTEGER</LOTE>

<ID_EVENTO>STRING</ID_EVENTO>

<VERSAO>INTEGER</VERSAO>

<AMBIENTE>INTEGER</AMBIENTE>

<CORGAO>INTEGER</CORGAO>

<CSTAT>INTEGER</CSTAT>

<STATUS>INTEGER</STATUS>

<XML_RET>STRING</XML_RET>

<XML_SIG>STRING</XML_SIG>

<XMOTIVO>STRING</XMOTIVO>

<OBSERVACAO>STRING</OBSERVACAO>

<TENTATIVAS>STRING</TENTATIVAS>

</WS01CONSUMOINDEVIDO>

</NFERETORNAEVENTO>

</NFERETORNAEVENTORESULT>

</soap:Body>

Parâmetro	Tipo	Tam	Pai	Observação
NFERETORNAEVENTORESULT	Estrutura	-	-	-
NFERETORNAEVENTO	Estrutura	-	NFERETORNAEVENTORESULT	-
ID_ENT	Alfanumérico	006	NFERETORNAEVENTO	Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.
LOTE	Numérico	008	NFERETORNAEVENTO	Lote de envio do Evento.
ID_EVENTO	Alfanumérico	054	NFERETORNAEVENTO	Identificador do Evento. A regra de formação do Id é: ID+Código do Evento+Chave da NF-e+Sequência do Evento.
VERSAO	Numérico	003	NFERETORNAEVENTO	Versão do Layout.
AMBIENTE	Numérico	001	NFERETORNAEVENTO	Identificação do ambiente: 1 – Produção / 2 – Homologação.
CORGAO	Numérico	002	NFERETORNAEVENTO	Código da UF que registrou o evento. Utilize 90 para o ambiente nacional.
CSTAT	Numérico	008	NFERETORNAEVENTO	Código do status da resposta do envio do evento, conforme tabela de códigos de erros e descrições de mensagens de erros.
STATUS	Numérico	008	NFERETORNAEVENTO	Status do Evento.
XML_RET	Binário	1-500k	NFERETORNAEVENTO	XML de retorno da mensagem de registro de Eventos (Layout Mensagem de Retorno), conforme Layout definido na Nota Técnica 2011/003. XML apresentado será o correspondente ao último evento encaminhado.* Exemplo .: caso foi realizado cancelamento do evento, o XML do cancelamento que constará nessa tag.
XML_SIG	Binário	1-500k	NFERETORNAEVENTO	XML de envio da mensagem de registro de Eventos (Layout Mensagem Entrada), conforme Layout definido na Nota Técnica 2011/003. XML apresentado será o correspondente ao último evento encaminhado.* Exemplo .: caso foi realizado cancelamento do evento, o XML do cancelamento que constará nessa tag.
XMOTIVO	Alfanumérico	1-250	NFERETORNAEVENTO	Descrição do status da resposta do envio do evento, conforme tabela de códigos de erros e descrições de mensagens de erros.
WS01CONSUMOINDEVIDO	Estrutura	-	NFERETORNAEVENTO	Estrutura referente a Consumo Indevido.
OBSERVACAO	Alfanumérico	200	WS01CONSUMOINDEVIDO	Mensagem de retorno do TSS caso ocorra o atingimento do máximo de tentativas de execução do método em questão.
TENTATIVAS	Alfanumérico	5	WS01CONSUMOINDEVIDO	Retorna a contagem de tentativas de execução do método em questão.

O ajuste que apresenta o protocolo de cancelamento foi realizado no dia 30/09/2022, dessa forma requisições anteriores a essa data não irão apresentar o protocolo de cancelamento.

Fault	Descrição
Invalid Token	O parâmetro USERTOKEN foi passado incorretamente.
001	Código da entidade inválida.
002	Código da entidade em branco.
003	ID do evento incorreto.