Projeto Nota Fiscal Eletrônica

Manual de Orientação ao Contribuinte

Atualizado até a NT 2023.005 v.1.02 publicada em 26/04/2024

NFC-e NF-e
Visão Geral

Web Service – NfeStatusServico

    Função:
    serviço destinado à consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.
    Processo:
    síncrono.
    Método: nfeStatusServico

Fluxo do Web Service nfeStatusServico

1.1. Leiaute Mensagem de Entrada
    Entrada:
    Estrutura XML para a consulta do status do serviço.
    Schema XML: consStatServ_v4.00.xsd

# 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'


1.2. Leiaute Mensagem de Retorno
    Retorno:
    Estrutura XML contendo a mensagem do resultado da consulta do status do serviço:
    Schema XML: retConsStatServ_4.00.xsd


# Campo Ele Pai Tipo Ocor. Tam. Descrição/Observação
FR01 retConsStatServ 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 recebeu a Consulta.

A versão deve ser iniciada com a sigla da UF nos casos de WS próprio ou a sigla SVAN ou SVRS nos demais casos.
FR05 cStat E FR01 N 1-1 3 Código do status da resposta para o Lote (conforme item 4.1 do Anexo Regras de Validação).
FR06 xMotivo E FR01 C 1-1 1-255 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 dhRecebto E FR01 D 1-1 - Preenchido com a data e hora do processamento (informado também no caso de rejeição).
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 (item 5.7).
FR10 dhRetorno E FR01 D 0-1 - Preenchido com a data e hora previstas para o retorno do Web Service, no formato “AAAA-MM-DDThh:mm:ss”


1.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 do Portal da Secretaria de Fazenda Estadual.

O aplicativo do contribuinte envia a solicitação para o Web Service da Secretaria de Fazenda Estadual.

Ao receber a solicitação a aplicação do Portal da Secretaria de Fazenda Estadual processará a solicitação de consulta, e retorna mensagem contendo a 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.


1.4. Regras de Validação

Serão aplicadas as regras de validação genéricas conforme os grupos citados na tabela abaixo, detalhados na Seção 1 do Anexo de Regras de Validação da NF-e e da NFC-e.

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 WS podem ser vistas abaixo:


# 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


1.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, códigos de situação “107-Serviço em Operação”, “108-Serviço Paralisado Temporariamente” e “109-Serviço Paralisado sem Previsão”. A critério da UF o campo xObs pode ser utilizado para fornecer maiores informações ao contribuinte, como por exemplo: “manutenção programada”, “modificação de versão do aplicativo”, “previsão de retorno”, etc.