Web Service - MDFeConsNaoEnc
Os Web Services do MDF-e utilizam mensagens nos padrões XML e SOAP, por protocolo TLS com autenticação mútua. O envio da solicitação e a obtenção do retorno ocorrem na mesma conexão, em processo síncrono.
- Função: serviço destinado à consulta de MDF-e não encerrados na base de dados do Ambiente Autorizador.
- Processo: síncrono.
- Nome do Serviço:
MDFeConsNaoEnc. - Método:
mdfeConsNaoEnc. - Parâmetro da mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML contendo a consulta de MDF-e não encerrados do emitente.
Schema XML: consMDFeNaoEnc_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| EP01 | consMDFeNaoEnc | Raiz | - | - | - | - | TAG raiz. |
| EP02 | versao | A | EP01 | N | 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 | 24 | Serviço solicitado: “CONSULTAR NÃO ENCERRADOS”. |
| EP05 | CNPJ | CE | EP01 | N | 1-1 | 14 | Informar zeros não significativos. |
| EP06 | CPF | CE | EP01 | N | 1-1 | 11 | Informar zeros não significativos. Apenas para emitente pessoa física com inscrição estadual. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado da consulta.
Schema XML: retConsMDFeNaoEnc_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| ER01 | retConsMDFeNaoEnc | Raiz | - | - | - | - | TAG raiz da resposta. |
| ER02 | versao | A | ER01 | N | 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. |
| 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 à solicitação. |
| ER08 | infMDFe | G | ER01 | - | 0-N | - | Grupo da relação de MDF-e não encerrados. |
| ER09 | chMDFe | E | ER08 | N | 1-1 | 44 | Chave de acesso do MDF-e não encerrado. |
| ER10 | nProt | E | ER08 | N | 1-1 | 15 | Protocolo de autorização do MDF-e não encerrado. |
3. Descrição do Processo de Web Service
Este método recebe as solicitações de consulta de MDF-e não encerrados pelo emitente, em situação Autorizado. Seu acesso é permitido apenas pelo CNPJ ou CPF do emitente.
O aplicativo do contribuinte envia a solicitação ao Web Service. O Ambiente Autorizador valida o CNPJ ou CPF e retorna a relação de chaves de acesso e números de protocolo dos MDF-e não encerrados na Base de Dados.
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 Não Encerrados
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| H01 | Tipo do ambiente informado difere do ambiente do Web Service. | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento. |
| H02 | Se informado CNPJ do emitente: validar CNPJ Emitente (dígito controle, zeros ou nulo). | Obrig. | 207 | Rej. | Rejeição: CNPJ do emitente inválido. |
| H03 | Se informado CPF do emitente: validar CPF Emitente (dígito controle, zeros ou nulo). | Obrig. | 210 | Rej. | Rejeição: CPF do emitente inválido. |
| H04 | Se o Certificado contiver CNPJ do emitente: CNPJ-Base do Emitente difere do CNPJ-Base do Certificado Digital. Exceção: esta regra não se aplica a CNPJ Emitente que possui vínculo ativo no cadastro de PAA da SVRS. | Obrig. | 213 | Rej. | Rejeição: CNPJ-Base do Emitente difere do CNPJ-Base do Certificado Digital. |
| H05 | Se o Certificado contiver CPF do emitente: CPF do Emitente difere do CPF do Certificado Digital. | Obrig. | 202 | Rej. | Rejeição: CPF do Emitente difere do CPF do Certificado Digital. |
| H06 | Emitente não credenciado à emissão de MDF-e. Exceção: esta regra não se aplica a CNPJ Emitente que possui vínculo ativo no cadastro de PAA da SVRS. | Obrig. | 203 | Rej. | Rejeição: Emissor não habilitado para emissão do MDF-e. |
A regra H06 foi desativada pela NT 2023.001 v.1.00 e, por isso, permanece integralmente tachada na tabela original.
6. Final do Processamento
A mensagem de retorno poderá ser:
- cStat 111: MDF-e não encerrados localizados, com a relação de chaves de acesso e protocolos de autorização.
- cStat 112: MDF-e não encerrados não localizados.