Web Service - NFeConsultaProtocolo
Função: serviço destinado ao atendimento de solicitações de consulta da situação atual da NF-e ABI na Base de Dados do Portal da Administração Tributária.
Processo: síncrono.
Método: nfeConsulta.
1. Leiaute da Mensagem de Entrada
Entrada: Estrutura XML contendo a chave de acesso da NF-e.
Schema XML: consSitNFeABI_v1.00.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| EP01 | consSitNFeABI | Raiz | - | - | - | - | TAG raiz |
| EP02 | versao | A | EP01 | N | 1-1 | 1-2v2 | Versão do leiaute |
| EP03 | tpAmb | E | EP01 | N | 1-1 | 1 | Identificação do Ambiente: 1=Produção/2=Homologação |
| EP04 | xServ | E | EP01 | C | 1-1 | 9 | Serviço solicitado ‘CONSULTAR’ |
| EP05 | chNFe | E | EP01 | C | 1-1 | 44 | Chave de Acesso da NF-e ABI. |
2. Leiaute da Mensagem de Retorno
Retorno: Estrutura XML contendo a mensagem do resultado da consulta de protocolo.
Schema XML: retConsSitNFeABI_v1.00.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| ER01 | retConsSitNFeABI | Raiz | - | - | - | - | TAG raiz da Resposta |
| ER02 | versao | A | ER01 | N | 1-1 | 1-2v2 | Versão do leiaute |
| ER03 | tpAmb | E | ER01 | N | 1-1 | 1 | Identificação do Ambiente: 1=Produção/2=Homologação |
| ER04 | verAplic | E | ER01 | C | 1-1 | 1-20 | Versão do Aplicativo que processou 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. |
| ER05 | cStat | E | ER01 | N | 1-1 | 3 | Código do status da resposta |
| ER06 | xMotivo | E | ER01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| ER07 | cUF | E | ER01 | N | 1-1 | 2 | Código da UF que atendeu a solicitação. |
| ER07a | dhRecbto | E | ER01 | D | 1-1 | Preenchido com a data e hora do processamento. Formato: “AAAA-MM-DDThh:mm:ssTZD” (UTC – Universal Coordinated Time). |
|
| ER07b | chNFeABI | E | ER01 | C | 1-1 | 44 | Chave de Acesso da NF-e ABI consultada. |
| ER08 | protNFeABI | G | ER01 | xml | 0-1 | - | Protocolo de autorização. • Informar se localizada uma NF-e com cStat = 100- uso autorizado, 150-uso autorizado fora de prazo ou 110-uso denegado. |
| ER10 | procEventoNFeABI | G | ER01 | xml | 0-N | - | Informação do evento e respectivo Protocolo de registro de Evento |
3. Descrição do Processo de Web Service
Este método será responsável por receber as solicitações referentes à consulta de situação de notas fiscais eletrônicas enviadas. Seu acesso é permitido apenas pela chave única de identificação da nota fiscal.
O aplicativo do emitente envia a solicitação para o Web Service. Ao receber a solicitação, a aplicação processará a consulta, validando a Chave de Acesso da NF-e ABI, e retornará mensagem contendo a situação atual da NF-e ABI na Base de Dados.
O processamento das consultas deste Web Service será limitado ao período de 180 dias da data de emissão.
4. Regras de Validação
Serão aplicadas as regras de validação genéricas.
| 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 |
| E | Validação do Certificado Digital de Assinatura |
| F | Validação da Assinatura Digital |
As regras de validação específicas deste Web Service são apresentadas a seguir.
| # | Regra de Validação | Aplic. | Msg | Efeito | Descrição Erro |
|---|---|---|---|---|---|
| J01 | Tipo do ambiente da NF-e difere do ambiente do Web Service | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento |
| J02 | 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 |
| J02a | Chave de Acesso com dígito verificador inválido | Obrig. | 236 | Rej. | Rejeição: Chave de Acesso com dígito verificador inválido |
| J02b | Chave de Acesso inválida (Código UF inválido) | Obrig. | 614 | Rej. | Rejeição: Chave de Acesso inválida (Código UF inválido) |
| J02c | Chave de Acesso inválida (Ano < 06 ou Ano maior que Ano corrente) | Obrig. | 615 | Rej. | Rejeição: Chave de Acesso inválida (Ano menor que 06 ou Ano maior que Ano corrente) |
| J02d | Chave de Acesso inválida (Mês < 1 ou Mês > 12) | Obrig. | 616 | Rej. | Rejeição: Chave de Acesso inválida (Mês menor que 1 ou Mês maior que 12) |
| J02f | Chave de Acesso inválida (modelo diferente 77) | Obrig. | 618 | Rej. | Rejeição: Chave de Acesso inválida (modelo diferente de 77) |
| J02g | Chave de Acesso inválida (número NF = 0) | Obrig. | 619 | Rej. | Rejeição: Chave de Acesso inválida (número NF = 0) |
| J02k | Ano-Mês da Chave de Acesso com atraso superior a 6 meses em relação ao Ano-Mês atual Observação: Eventualmente a Autorizadora poderá não implementar esta validação, conforme seu critério. |
Obrig. | 526 | Rej. | Rejeição: Consulta a uma Chave de Acesso muito antiga |
| J03 | Acesso BD NFE (Chave: CNPJ/CPF Emit, Modelo, Série, Número): | Obrig. | 217 | Rej. | Rejeição: NF-e não consta na base de dados da SEFAZ |
| J04 | - Verificar se campo “Código Numérico” informado na Chave de Acesso é diferente do existente no BD Observação: Opcionalmente, concatenar na mensagem de erro a Chave de Acesso da NF-e existente no BD nas situações de: • CNPJ base do certificado digital de transmissão igual ao CNPJ base do emitente ou do destinatário da NF-e • CNPJ base do certificado digital de transmissão igual ao CNPJ base do transmissor da NF-e • CPF do certificado digital de transmissão igual ao CPF do emitente da NF-e. |
Obrig. | 562 | Rej. | Rejeição: Código Numérico informado na Chave de Acesso difere do Código Numérico da NF-e [chNFe:9999999999999999999999999999999 9999999999999 |
| J05 | • Verificar se campo MM (mês) informado na Chave de Acesso é diferente do existente no BD | Obrig. | 561 | Rej. | Rejeição: Mês de Emissão informado na Chave de Acesso difere do Mês de Emissão da NF-e |
| J06 | Chave de Acesso difere da existente em BD | Obrig. | 613 | Rej. | Rejeição: Chave de Acesso difere da existente em BD |
5. Final do Processamento
O processamento do pedido de consulta de status de NF-e ABI pode resultar em uma mensagem de erro ou retornar a situação atual da NF-e ABI consultada.
No caso de localização da NF-e ABI, será retornado o cStat com os valores “100 - Autorizado o Uso” ou “101 - Cancelamento de NF-e ABI Homologado”.