Web Service - NFeStatusServico

Conteúdo técnico da Visão Geral da NF-e ABI, versão 1.00 e, quando indicado, do Anexo I - Leiaute e Regras de Validação, versão 1.00. O MOC Online é material de apoio e não substitui os documentos oficiais.

Função: serviço destinado à consulta do status do serviço prestado pela Administração Tributária.

Processo: síncrono.

Método: nfeStatusServico.

1. Leiaute da Mensagem de Entrada

Entrada: Estrutura XML para a consulta do status do serviço.

Schema XML: consStatServNFeABI_v1.00.xsd.

Tabela 1-1 - Leiaute Mensagem de Entrada do Web Service nfeStatusServico

#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
FP01	consStatServ	Raiz	-	-	-	-	TAG raiz
FP02	versao	A	FP01	N	1-1	1-2v2	Versão do leiaute
FP03	tpAmb	E	FP01	N	1-1	1	Identificação do Ambiente: 1=Produção/2=Homologação
FP04	cUF	E	FP01	N	1-1	2	Código da UF consultada
FP05	xServ	E	FP01	C	1-1	6	Serviço solicitado ‘STATUS’

2. Leiaute da Mensagem de Retorno

Retorno: Estrutura XML contendo a mensagem do resultado da consulta do status do serviço.

Schema XML: retConsStatServNFeABI_v1.00.xsd.

Tabela 2-1 - Leiaute Mensagem de Retorno do Web Service nfeStatusServico

#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
FR01	retConsStatServNFeABI	Raiz	-	-	-	-	TAG raiz da Resposta
FR02	versao	A	FR01	N	1-1	1-2v2	Versão do leiaute
FR03	tpAmb	E	FR01	N	1-1	1	Identificação do Ambiente: 1=Produção/2=Homologação
FR04	verAplic	E	FR01	C	1-1	1-20	Versão do Aplicativo que processou a consulta.
FR05	cStat	E	FR01	N	1-1	3	Código do status da resposta
FR06	xMotivo	E	FR01	C	1-1	1-60	Descrição literal do status da resposta.
FR07	cUF	E	FR01	N	1-1	2	Código da UF que atendeu a solicitação
FR08	dhRecbto	E	FR01	D	1-1	-	Preenchido com a data e hora do processamento. Formato: “AAAA-MM-DDThh:mm:ssTZD” (UTC – Universal Coordinated Time).
FR09	tMed	E	FR01	N	0-1	1-4	Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos
FR10	dhRetorno	E	FR01	D	0-1	-	Preencher com data e hora previstas para o retorno do Web Service, no formato AAA-MM-DDTHH:MM:SS
FR11	xObs	E	FR01	C	0-1	1-255	Informações adicionais para o emitente

3. Descrição do Processo de Web Service

Este método é responsável por receber as solicitações referentes à consulta do status do serviço.

O aplicativo do emitente envia a solicitação para o Web Service da Administração Tributária. Ao receber a solicitação, a aplicação a processa e retorna mensagem contendo o status do serviço.

As empresas que construírem um aplicativo que se mantenha em loop permanente de consulta a este Web Service devem aguardar um tempo mínimo de 3 minutos entre cada consulta, evitando sobrecarregar desnecessariamente os servidores da SEFAZ.

Figura 3-1 - Fluxo do Web Service nfeStatusServico

4. Regras de Validação

Serão aplicadas as regras de validação genéricas.

Tabela 4-1 - Regras de Validação Genéricas do Web Service nfeStatusServico

Grupo	Descrição
A	Validação do Certificado de Transmissão (protocolo TLS)
B	Validação Inicial da Mensagem no Web Service
D	Validação da Área de Dados

As regras de validação específicas deste Web Service são apresentadas a seguir.

Tabela 4-2 - Regras de Validação Específicas do Web Service nfeStatusServico

#	Regra de Validação	Aplic.	Msg	Efeito	Descrição Erro
K01	Tipo do ambiente da NF-e difere do ambiente do Web Service	Obrig.	252	Rej.	Rejeição: Ambiente informado diverge do Ambiente de recebimento
K02	Código da UF consultada difere da UF do Web Service	Obrig.	289	Rej.	Rejeição: Código da UF informada diverge da UF solicitada
K03	Verifica se o Servidor de Processamento está Paralisado Momentaneamente	Obrig.	108	-	Rejeição: Serviço Paralisado Momentaneamente (curto prazo)
K04	Verifica se o Servidor de Processamento está Paralisado sem Previsão	Obrig.	109	-	Rejeição: Serviço Paralisado sem Previsão

5. Final do Processamento

O processamento do pedido de consulta de status de serviço pode resultar em uma mensagem de erro ou retornar a situação atual do Servidor de Processamento: “107 - Serviço em Operação”, “108 - Serviço Paralisado Temporariamente” ou “109 - Serviço Paralisado sem Previsão”.

O campo xObs pode ser utilizado para fornecer maiores informações ao emitente, como “manutenção programada”, “modificação de versão do aplicativo” e “previsão de retorno”.