Web Service NfeStatusServico

Consulta Status do Serviço

Ret

Contribuinte

Client NFe

Secretaria de Fazenda Estadual

Aplicação NF-e Consulta Status Consulta Status Retorno nfeStatusServicoNF Web Service: NfeStatusServico Proc.

Pág. 67 / 236

Função: serviço destinado à consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

Processo: síncrono.

Método: nfeStatusServicoNF

4.6.1

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

Schema XML: consStatServ_v99.99.xsd

# Campo Ele Pai Tipo Ocor. Tam. Dec. Descrição/Observação

FP01 consStatServ Raiz - - - - TAG raiz

FP02 versao A FP01 N 1-1 1-4 2 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‟

4.6.2

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

Schema XML: retConsStatServ_v99.99.xsd

# Campo Ele Pai Tipo Ocor. Tam. Dec. Descrição/Observação

FR01 retConsStatServ Raiz - - - - TAG raiz da Resposta FR02 versao A FR01 N 1-1 1-4 2 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 - Data e hora de recebimento

Formato = AAAA-MM-DDTHH:MM:SS Preenchido com data e hora do recebimento do Pedido.

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 - 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 Contribuinte

4.6.3

Este método será responsável por receber as solicitações referentes à consulta do status do serviço do Portal da Secretaria de Fazenda Estadual.

Pág. 68 / 236

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 retornará 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.

Deverão ser realizadas as validações e procedimentos que seguem.

4.6.4

Validação do Certificado Digital do Transmissor (protocolo SSL)

# Regra de Validação Crítica Msg Efeito

A01 Certificado de Transmissor Inválido:

- Certificado de Transmissor inexistente na mensagem - Versão difere "3"

- Basic Constraint = true (não pode ser Certificado de AC) - KeyUsage não define "Autenticação Cliente"

Obrig. 280 Rej.

A02 Validade do Certificado (data início e data fim) Obrig. 281 Rej.

A03 Verifica a Cadeia de Certificação:

- Certificado da AC emissora não cadastrado na SEFAZ - Certificado de AC revogado

- Certificado não assinado pela AC emissora do Certificado

Obrig. 283 Rej.

A04 LCR do Certificado de Transmissor

- Falta o endereço da LCR (CRL DistributionPoint) - LCR indisponível

- LCR inválida

Obrig. 286 Rej.

A05 Certificado do Transmissor revogado Obrig. 284 Rej.

A06 Certificado Raiz difere da "ICP-Brasil" Obrig. 285 Rej.

A07 Falta a extensão de CNPJ no Certificado (OtherName - OID=2.16.76.1.3.3)

Obrig. 282 Rej.

As validações de A01, A02, A03, A04 e A05 são realizadas pelo protocolo SSL e não precisam ser implementadas. A validação A06 também pode ser realizada pelo protocolo SSL, mas pode falhar se existirem outros certificados digitais de Autoridade Certificadora Raiz que não sejam “ICP-BR” no repositório de certificados digitais do servidor de Web

Service da SEFAZ.

4.6.5

Validação Inicial da Mensagem no Web Service

# Regra de Validação Aplic. Msg Efeito

B01 Tamanho do XML de Dados superior a 500 Kbytes Obrig. 214 Rej.

B02 XML de Dados Mal Formado Facult. 243 Rej.

B03 Verifica se o Serviço está Paralisado Momentaneamente Obrig. 108 Rej. B04 Verifica se o Serviço está Paralisado sem Previsão Obrig. 109 Rej.

Pág. 69 / 236

A mensagem será descartada se o tamanho exceder o limite previsto (500 KB) A aplicação do contribuinte não poderá permitir a geração de mensagem com tamanho superior a 500 KB. Caso isto ocorra, a conexão poderá ser interrompida sem mensagem de erro se o controle do tamanho da mensagem for implementado por configurações do ambiente de rede da SEFAZ (ex.: controle no firewall). No caso do controle de tamanho ser implementado por aplicativo teremos a devolução da mensagem de erro 214.

A critério de cada unidade federada poderá ser verificado se o XML de dados está bem formado, no momento do recebimento da mensagem no Web Service. Esta verificação é útil para as UF que desejarem armazenar o XML de dados em estrutura XML de banco de dados.

As unidades federadas que mantêm o Web Service disponível, mesmo quando o serviço estiver paralisado, deverão implementar as verificações 108 e 109. Estas validações poderão ser dispensadas se o Web Service não ficar disponível quando o serviço estiver paralisado.

4.6.6

Validação do Cabeçalho da Mensagem

# Regra de Validação Aplic. Msg Efeito

C01 Verificar Schema do XML da Área de Cabeçalho Obrig. 242 Rej.

C01a XML utiliza codificação diferente de UTF-8 Obrig. 299 Rej.

C02 Versão dos Dados informada na Área de Cabeçalho é superior à versão vigente

Facult. 238 Rej.

C03 Versão dos Dados não suportada Obrig. 239 Rej.

O cabeçalho contém a versão do Schema XML da mensagem contida na área de dados que será utilizado pelo Web Service.

A ocorrência de qualquer erro na validação da área de cabeçalho da mensagem impossibilita o processamento da mensagem contida na área de dados.

4.6.7

a) Validação da Forma da Área de Dados

Validação da Mensagem da Consulta de Status de Serviço

# Regra de Validação Aplic. Msg Efeito

D01 Verifica Schema XML da Área de Dados Obrig. 215 Rej.

D02 Verifica o uso de prefixo no namespace Obrig. 404 Rej.

D03 XML utiliza codificação diferente de UTF-8 Obrig. 402 Rej.

b) Validação das Regras de Negócios da Consulta Status de Serviço da NF-e

Validação do Pedido de Consulta de Status de Serviço – Regras de Negócios

# Regra de Validação Aplic. Msg Efeito

Pág. 70 / 236 K02 Código da UF consultada difere da UF do Web Service Obrig. 289 Rej. K03 Verifica se o Servidor de Processamento está Paralisado

Momentaneamente

Obrig. 108 -

K04 Verifica se o Servidor de Processamento está Paralisado sem Previsão

Obrig. 109 -

4.6.8

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, 108 e 109. 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.

Pág. 71 / 236