Web Service - MDFeConsulta
- Função: serviço destinado ao atendimento de solicitações de consulta da situação atual do MDF-e na Base de Dados do Ambiente Autorizador.
- Processo: síncrono.
- Nome do Serviço:
MDFeConsulta. - Método:
mdfeConsultaMDF. - 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 do MDF-e.
Schema XML: consSitMDFe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DP01 | consSitMDFe | 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 | chMDFe | E | DP01 | N | 1-1 | 44 | Chave de acesso do MDF-e. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado da consulta da situação.
Schema XML: retConsSitMDFe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DR01 | retConsSitMDFe | 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 | protMDFe | G | DR01 | XML | 0-1 | - | Protocolo de autorização de uso do MDF-e. |
| DR09 | procEventoMDFe | G | DR01 | XML | 0-N | - | Informações dos eventos e respectivo protocolo de registro de evento. |
| DR10 | procInfraSA | G | DR01 | G | 0-1 | - | Grupo de informações do compartilhamento do MDF-e com InfraSA para geração do DTe. |
| DR11 | nProtDTe | E | DR10 | N | 1-1 | 15 | Número do Protocolo de Geração do DTe. |
| DR12 | dhProt | E | DR10 | D | 1-1 | - | Data e hora de geração do protocolo, no formato AAAA-MM-DDTHH:MM:SS TZD. |
Observação: os campos DR10, DR11 e DR12, introduzidos pela NT 2023.002 v.1.00, são alimentados somente para MDF-e dos modais ferroviário e rodoviário e somente após a disponibilização para a InfraSA.
3. Descrição do Processo de Web Service
Este método recebe as solicitações referentes à consulta de situação de MDF-e enviados para o Ambiente Autorizador. Seu acesso é permitido apenas pela chave única de identificação do Manifesto Eletrônico de Documentos Fiscais.
O aplicativo do contribuinte envia a solicitação ao Web Service. O Ambiente Autorizador valida a Chave de Acesso e retorna a situação atual do MDF-e na Base de Dados, o respectivo Protocolo de autorização de uso e os eventos associados, 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 da data de emissão do MDF-e.
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 |
|---|---|---|---|---|---|
| G01 | Tipo do ambiente informado difere do ambiente do Web Service. | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento. |
| G02 | 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. | 460 | Rej. | Rejeição: Consulta a uma Chave de Acesso muito antiga. |
| G03 | Validar chave de acesso. Retornar motivo da rejeição da Chave de Acesso: CNPJ / CPF zerado ou inválido, Ano < 2012 ou maior que atual, Mês inválido (0 ou > 12), Modelo diferente de 58, 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] |
| G04 | Acesso BD MDF-e (Chave: CNPJ / CPF Emit, Modelo, Série, Nro): verificar se MDF-e não existe. | Obrig. | 217 | Rej. | Rejeição: MDF-e não consta na base de dados da SEFAZ. |
| G05 | 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. |
| G06 | 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 pedido pode resultar em mensagem de erro, caso o MDF-e não seja localizado. Quando localizado, 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 do MDF-e. |
| 101 | Cancelamento de MDF-e homologado. |
| 132 | Encerramento de MDF-e homologado. |