Web Service - NFComConsulta
- Função: serviço destinado ao atendimento de solicitações de consulta da situação atual da NFCom na base de dados do Ambiente Autorizador;
- Processo: síncrono;
- Nome do serviço:
NFComConsulta; - Método:
nfcomConsultaNF; - 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 NFCom.
Schema XML: consSitNFCom_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DP01 | consSitNFCom | 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 | chNFCom | E | DP01 | C | 1-1 | 44 | Chave de acesso da NFCom. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado da consulta da situação.
Schema XML: retConsSitNFCom_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DR01 | retConsSitNFCom | 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-4 | 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 | protNFCom | G | DR01 | XML | 0-1 | - | Protocolo de autorização de uso da NFCom. |
| DR09 | procEventoNFCom | 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 da situação de NFCom enviadas para o Ambiente Autorizador. Seu acesso é permitido apenas pela chave única de identificação da NFCom.
O aplicativo do contribuinte envia a solicitação ao Web Service do Ambiente Autorizador. A aplicação valida a chave de acesso e retorna a situação atual da NFCom na base de dados, o respectivo protocolo de autorização de uso e os eventos associados à NFCom, com as informações e os protocolos de registro.
O processamento das consultas deste Web Service será limitado ao período de 180 dias da data de emissão da NFCom.
4. Regras de Validação Básicas do Serviço
Deverão ser aplicadas as validações gerais conforme o quadro abaixo:
| 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 o motivo da rejeição da chave de acesso: CNPJ zerado ou inválido; ano menor que 2021 ou maior que o atual; mês inválido (0 ou maior que 12); modelo diferente de 62; 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 NFCom difere do site de recebimento. Observação: o número do site somente 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 ao banco de dados da NFCom (chave: CNPJ Emit., Modelo, Série, Nro.): verificar se a NFCom não existe. | Obrig. | 217 | Rej. | Rejeição: NFCom não consta na base de dados da SEFAZ. |
| I07 | Verificar se o campo “Código Numérico” informado na chave de acesso é diferente do existente no banco de dados. | Obrig. | 216 | Rej. | Rejeição: Chave de Acesso difere da cadastrada. |
| I08 | Chave de acesso difere da existente no banco de dados. 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. |
6. Final do Processamento
O processamento do pedido de consulta da situação da NFCom pode resultar em uma mensagem de erro, caso a NFCom não seja localizada. Caso seja localizada, retorna sua situação atual e o respectivo protocolo de autorização de uso e de registro de eventos.
| cStat | Situação |
|---|---|
| 100 | Autorizado o Uso da NFCom. |
| 101 | Cancelamento de NFCom homologado. |
| 102 | Substituição da NFCom homologado. |
| 150 | Autorizado o Uso da NFCom, autorização fora de prazo. |