Web Service - NFAgConsulta
Função: serviço destinado ao atendimento de solicitações de consulta da situação atual da NFAg na Base de Dados do Ambiente Autorizador.
Processo: síncrono.
Nome Serviço: NFAgConsulta.
Método: NFAgConsultaNF.
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 NFAg.
Schema XML: consSitNFAg_v9.99.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DP01 | consSitNFAg | 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 | chNFAg | E | DP01 | N | 1-1 | 44 | Chave de acesso da NFAg |
2. Leiaute da Mensagem de Retorno
Retorno: Estrutura XML com o resultado da consulta situação.
Schema XML: retConsSitNFAg_v9.99.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DR01 | retConsSitNFAg | 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 | protNFAg | G | DR01 | XML | 0-1 | - | Protocolo de autorização de uso da NFAg |
| DR09 | procEventoNFAg | 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 será responsável por receber as solicitações referentes à consulta de situação da NFAg enviadas para o Ambiente Autorizador. Seu acesso é permitido apenas pela chave única de identificação da NFAg.
O aplicativo do contribuinte envia a solicitação para o Web Service do Ambiente Autorizador. Ao receber a solicitação, a aplicação processará a consulta validando a Chave de Acesso da NFAg e retornará mensagem contendo a situação atual da NFAg na Base de Dados, o respectivo Protocolo (mensagem de Autorização de uso) e os eventos associados à NFAg (informações do evento e protocolo de registro de evento).
O processamento da requisição das consultas deste Web Service será limitado ao período de consulta de até 180 dias da data de emissão da NFAg.
4. Regras de Validaçã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 |
4.1. 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 < 2025 ou maior que atual, Mês inválido (0 ou > 12), Modelo diferente de 75, Número zerado, Tipo de emissão inválido, Site de Autorizaçã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 NFAG 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. | 418 | Rej. | Rejeição: Site de autorização inválido |
| I06 | Acesso BD NFAg (Chave: CNPJ Emit, Modelo, Série, Nro): - Verificar se NFAg não existe | Obrig. | 217 | Rej. | Rejeição: NFAg 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, 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 |
5. Final do Processamento
O processamento do pedido de consulta situação de NFAg pode resultar em uma mensagem de erro, caso a NFAg não seja localizada. Caso seja localizada, retorna a situação atual da NFAg consultada, devolvendo o cStat com um dos valores: 100 (“Autorizado o Uso da NFAg”), 101 (“Cancelamento de NFAg homologado”), 102 (“Substituição da NFAg homologado”) ou 150 (“Autorizado o Uso da NFAg, autorização fora de prazo”), e o respectivo protocolo de autorização de uso e registro de eventos.