Web Service - NF3eConsulta
- Função: serviço destinado ao atendimento de solicitações de consulta da situação atual da NF3e na Base de Dados do Ambiente Autorizador.
- Processo: síncrono.
- Nome do Serviço:
NF3eConsulta. - Método:
nf3eConsultaNF. - Parâmetro da mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML contendo a consulta por chave de acesso da NF3e.
Schema XML: consSitNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DP01 | consSitNF3e | Raiz | - | - | - | - | TAG raiz. |
| DP02 | versao | A | DP01 | N | 1-1 | 2v2 | Versão do leiaute. |
| DP03 | tpAmb | E | DP01 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| DP04 | xServ | E | DP01 | C | 1-1 | 9 | Serviço solicitado: “CONSULTAR”. |
| DP05 | chNF3e | E | DP01 | N | 1-1 | 44 | Chave de acesso da NF3e. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado da consulta da situação.
Schema XML: retConsSitNF3e_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DR01 | retConsSitNF3e | Raiz | - | - | - | - | TAG raiz da resposta. |
| DR02 | versao | A | DR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| DR03 | tpAmb | E | DR01 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| DR04 | verAplic | E | DR01 | C | 1-1 | 1-20 | Versão do Aplicativo que processou a consulta. |
| DR05 | cStat | E | DR01 | N | 1-1 | 3 | Código do status da resposta. |
| DR06 | xMotivo | E | DR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| DR07 | cUF | E | DR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| DR08 | protNF3e | G | DR01 | XML | 0-1 | - | Protocolo de autorização de uso da NF3e. |
| DR09 | procEventoNF3e | G | DR01 | XML | 0-N | - | Informações dos eventos e respectivo protocolo de registro de evento. |
3. Descrição do Processo de Web Service
Este método recebe as solicitações referentes à consulta de situação de NF3e enviadas para o Ambiente Autorizador. Seu acesso é permitido apenas pela chave única de identificação da Nota Fiscal de Energia Elétrica Eletrônica.
O aplicativo do contribuinte envia a solicitação para o Web Service do Ambiente Autorizador. A aplicação valida a Chave de Acesso e retorna a situação atual da NF3e na Base de Dados, o respectivo Protocolo de Autorização de uso e os eventos associados à NF3e, com as informações do evento e o protocolo de registro.
O processamento das requisições deste Web Service é limitado ao período de 180 dias contado da data de emissão da NF3e.
4. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão (protocolo TLS). |
| B | Validação Inicial da Mensagem no Web Service. |
| C | Validação da Área de Dados da mensagem. |
5. Validação das Regras de Negócio da Consulta Situação
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| I01 | Tipo do ambiente informado difere do ambiente do Web Service. | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento. |
| I02 | UF da chave de acesso difere da UF do Web Service. | Obrig. | 226 | Rej. | Rejeição: Código da UF do Emitente diverge da UF autorizadora. |
| I03 | Verificar se o ano-mês da chave de acesso está com atraso superior a 6 meses em relação ao ano-mês atual. | Obrig. | 478 | Rej. | Rejeição: Consulta a uma Chave de Acesso muito antiga. |
| I04 | Validar chave de acesso. Retornar motivo da rejeição da Chave de Acesso: CNPJ zerado ou inválido, Ano < 2019 ou maior que atual, Mês inválido (0 ou > 12), Modelo diferente de 66, Número zerado, Tipo de emissão inválido, UF inválida ou DV inválido. [Motivo: XXXXXXXXXXXX] | Obrig. | 236 | Rej. | Rejeição: Chave de Acesso inválida. [Motivo: XXXXXXXXX] |
| I05 | Site de autorização da chave de acesso da NF3e difere do Site de Recebimento. Observação: o número do Site só deve ser diferente de zero para ambientes de autorização em múltiplos Sites; a relação do número identificador de cada Site deverá ser disponibilizada pelo Autorizador. | Obrig. | 482 | Rej. | Rejeição: Site de autorização inválido. |
| I06 | Acesso BD NF3e (Chave: CNPJ Emit, Modelo, Série, Nro): verificar se NF3e não existe. | Obrig. | 217 | Rej. | Rejeição: NF3e não consta na base de dados da SEFAZ. |
| I07 | Verificar se campo “Código Numérico” informado na Chave de Acesso é diferente do existente no BD. | Obrig. | 216 | Rej. | Rejeição: Chave de Acesso difere da cadastrada. |
| I08 | Chave de Acesso difere da existente em BD. Opcionalmente, a descrição do erro no campo xMotivo tem concatenada a Chave de Acesso, quando o autor da consulta for o emissor. | Obrig. | 600 | Rej. | Rejeição: Chave de Acesso difere da existente em BD. |
6. Final do Processamento
O processamento do pedido de consulta da situação da NF3e pode resultar em uma mensagem de erro, caso a NF3e não seja localizada. Quando localizada, a consulta retorna a situação atual, o respectivo protocolo de autorização de uso e o registro de eventos.
| cStat | Situação |
|---|---|
| 100 | Autorizado o Uso da NF3e. |
| 101 | Cancelamento de NF3e homologado. |
| 102 | Substituição da NF3e homologado. |
| 110 | Ajuste de NF3e homologado. |
| 150 | Autorizado o Uso da NF3e, autorização fora de prazo. |