Web Service - MDFeRecepcaoSinc
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.
O Serviço de Recepção de MDF-e é oferecido pelo Ambiente Autorizador para recepção dos documentos emitidos pelos contribuintes credenciados. O processamento é síncrono, sem formação de lotes: o contribuinte transmite um MDF-e e recebe o resultado na mesma conexão.
- Função: serviço destinado à recepção de mensagens de envio de MDF-e.
- Processo: síncrono.
- Nome do Serviço:
MDFeRecepcaoSinc. - Método:
mdfeRecepcao. - Parâmetro da mensagem da área de dados: compactada utilizando GZip (Base64).
1. Leiaute da Mensagem de Entrada
Entrada: a estrutura XML do MDF-e está definida no Anexo I - Manual de Orientações do Contribuinte - Leiaute e Regras de Validação.
Schema XML: MDFe_v9.99.xsd.
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com a mensagem do resultado do envio do MDF-e.
Schema XML: retMDFe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| BR01 | retMDFe | Raiz | - | - | - | - | TAG raiz da resposta. |
| BR02 | versao | A | BR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| BR03 | tpAmb | E | BR01 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| BR04 | cUF | E | BR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| BR05 | verAplic | E | BR01 | C | 1-1 | 1-20 | Versão do Aplicativo que recebeu o MDF-e. |
| BR06 | cStat | E | BR01 | N | 1-1 | 3 | Código do status da resposta. |
| BR07 | xMotivo | E | BR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| BR08 | protMDFe | E | BR01 | G | 0-1 | XML | Resposta ao processamento do MDF-e. |
3. Leiaute do MDF-e Processado
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| PR01 | protMDFe | Raiz | - | - | - | - | TAG raiz da resposta de processamento. |
| PR02 | versao | A | PR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| PR03 | infProt | G | PR01 | - | 1-1 | - | Informações do protocolo de resposta. |
| PR04 | Id | A | PR03 | C | 0-1 | - | Identificador da TAG a ser assinada, somente precisa ser informado se a UF assinar a resposta. Em caso de assinatura da resposta pela SEFAZ, preencher o campo com o número do Protocolo precedido do literal “ID”. |
| PR05 | tpAmb | E | PR03 | N | 1-1 | 1 | Identificação do Ambiente: 1 - Produção; 2 - Homologação. |
| PR06 | verAplic | E | PR03 | C | 1-1 | 1-20 | Versão do Aplicativo que recebeu o MDF-e. |
| PR07 | chMDFe | E | PR03 | N | 1-1 | 44 | Chave de acesso do MDF-e. |
| PR08 | dhRecbto | E | PR03 | D | 1-1 | - | Data e Hora do Processamento. Formato = AAAA-MM-DDTHH:MM:SS TZD. Preenchido com data e hora da gravação do MDF-e no Banco de Dados. Em caso de Rejeição, com data e hora do recebimento do arquivo de MDF-e enviado. |
| PR09 | nProt | E | PR03 | N | 0-1 | 15 | Número do protocolo de autorização do MDF-e. |
| PR10 | digVal | E | PR03 | C | 0-1 | 28 | Digest Value do MDF-e processado, utilizado para conferir a integridade com o MDF-e original. |
| PR11 | cStat | E | PR03 | N | 1-1 | 3 | Código do status da resposta para o MDF-e. |
| PR12 | xMotivo | E | PR03 | C | 1-1 | 1-255 | Descrição literal do status da resposta para o MDF-e. |
| PR13 | infFisco | G | PR01 | - | 0-1 | - | Grupo reservado para envio de mensagem do Fisco para o contribuinte. |
| PR14 | cMsg | E | PR13 | N | 1-1 | 3 | Código de status da mensagem do Fisco. |
| PR15 | xMsg | E | PR13 | C | 1-1 | 1-255 | Mensagem do Fisco para o contribuinte. |
| PR16 | Signature | G | PR01 | XML | 0-1 | - | Assinatura XML do grupo identificado pelo atributo “ID”. A decisão de assinar a mensagem fica a critério da UF interessada. |
4. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão (protocolo TLS). |
| A-1 | Validação do Certificado de Transmissão (Regime Especial NFF). |
| B-0 | Validação da Compactação da Mensagem. |
| 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 do MDF-e
As regras de negócio aplicadas ao MDF-e estão descritas no Grupo F do Anexo I - Manual de Orientações do Contribuinte - Leiaute e Regras de Validação.
6. Final do Processamento do MDF-e
A validação do MDF-e pode resultar em:
- Rejeição: o MDF-e é descartado, não é armazenado no Banco de Dados e pode ser corrigido e novamente transmitido.
- Autorização de uso: o MDF-e é armazenado no Banco de Dados.
| Validação de forma do MDF-e | Situação do MDF-e | Para o contribuinte | Banco de Dados |
|---|---|---|---|
| Inválida | Rejeição | Corrigir MDF-e | Não gravar |
| Válida | Autorização de uso | Prestação autorizada | Gravar |
Para cada MDF-e será atribuído um número de protocolo do Ambiente Autorizador.