Configurar MDe na Api Rest

A Configuração do MDe através da API Rest será permitido para o usuário que já possuir o x-auth-token. No artigo Autenticação na API Rest damos mais detalhes sobre o x-auth-token. Existem alguns Endpoints para a configuração do serviço e para cada um, há uma URL específica.

Modulo de Consulta (MD-e)

Pela Api Rest o usuário poderá ativar, desativar e parametrizar o módulo de consulta, que é responsável por fazer buscas periódicas no Webservice do Portal Nacional.

Importante ressaltarmos que a consulta por NSU, busca apenas DFes consultados diretamente na Sefaz e poderá importar os seguintes tipos de documentos:

Resumo do DF-e
Proc DF-e
Evento do Emitente
Evento do Fisco

Consultar as configurações do MD-e (GET)

Nesse Endpoint, é possível verificar se determinada empresa já possui o modulo de consulta ativado.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/12345678912345

No retorno da requisição serão devolvidos vários dados, por exemplo se o download ou a ciência automática estão ativos, tempo de consulta etc. Abaixo um exemplo resumido do retorno de uma empresa que não possui (valor = false) a consulta ativada:

{
  "cnpj": "07385111000102",
  "ambiente": "PRODUCAO",
  "params": [
    {
      "nome": "07385111000102",
      "chave": "MDE_CONSULTA_CNPJ_ATIVO",
      "valor": "false",
      "descricao": "A consulta pelo último NSU está habilitada?"
    },
    {
      "nome": "07385111000102",
      "chave": "MDE_MODELOS_ATIVOS",
      "valor": "NFE,CTE,MDFE",
      "descricao": "Os modelos configurados para a consulta utilizando o último NSU obtido"
    },
    {
      "nome": "07385111000102",
      "chave": "MDE_CONSULTA_TEMPO_AGUARDA_MIN",
      "valor": "60",
      "descricao": "Tempo mínimo entre consultas para este CNPJ quando obter cstat 137"
    },
    {
      "nome": "07385111000102",
      "chave": "MDE_CONSULTA_LIMITE_CONSULTAS_POR_CICLO",
      "valor": "20",
      "descricao": "Limite de consultas no ciclo para o CNPJ"
    },

[...]

Recupera as informações de um parâmetro do MD-e (GET)

Nesse Endpoint, é possível verificar se determinada configuração de uma empresa está ativa ou não, usando de base o EndPoint anterior.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/{propriedade}

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

{empresa} : CNPJ da Empresa
{propriedade}: O parâmetro que deseja consultar

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/12345678912345/MDE_CONSULTA_CNPJ_ATIVO

Os parâmetros de consultas podem ser identificados na consulta da requisição acima, onde as informações da "chave" serão os parâmetros aqui.
Por exemplo, para identificar se está ativo ou não, deve procurar pela informação "MDE_CONSULTA_CNPJ_ATIVO". Abaixo um exemplo de retorno de uma empresa que possui a consulta ativa:

{
  "nome": "12345678912345",
  "chave": "MDE_CONSULTA_CNPJ_ATIVO",
  "valor": "true"
}

Ativar consulta pelo NSU (POST)

Nesse Endpoint, é possível ativar a consulta de todos os documentos emitidos contra o CNPJ da empresa, baseado no NSU.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/consultaNsu

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/12945999/consultaNsu

Desativar consulta pelo NSU (DELETE)

Nesse Endpoint, é possível desativar a consulta de todos os documentos emitidos contra o CNPJ da empresa.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/consultaNsu

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/12945999/consultaNsu

Modulo de Download

O modulo de download irá acessar a URL configurada por SEFAZ e para cada "DF-e" consultado realizará o download do mesmo seguindo as seguintes regras:

A SEFAZ somente irá disponibilizar o XML caso o DF-e esteja AUTORIZADO;
A SEFAZ limita que somente os DF-e’s emitidos em até 90 dias anteriores à primeira consulta poderão ser disponibilizadas para consulta e download;
Quando o limite é excedido, a SEFAZ retorna o código "632" (SOLICITACAO_DOWNLOAD_FORA_PRAZO);
Deverá existir obrigatoriamente o registro de um evento de destinatário (CIÊNCIA DA OPERAÇÃO) para que a SEFAZ libere o download da NFe para o destinatário;
Este EVENTO poderá ser realizado de forma automática pela aplicação SE e somente SE o parâmetro "REGISTRAR_EVENTO_CIENCIA" estiver configurado com o valor "true";

Após o download dos documentos os mesmos poderão ser consultados e baixados através dos Endpoints de recebimentos. Para mais detalhes acesse nosso artigo:

Recebimento de Documentos Fiscais via API Rest

Abaixo os dois principais Endpoints para download e registro de ciência automática.

1. Ativar download

Nesse Endpoint, é possível ativar o download de todos os documentos disponibilizados pela Sefaz contra o CNPJ da empresa.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/consultaChave

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/1294599/consultaChave

1.1 Desativar download (DELETE)

Nesse Endpoint, é possível desativar o download de todos os documentos disponibilizados pela Sefaz contra o CNPJ da empresa.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/consultaChave

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/1294599/consultaChave

2. Ativar Registro de Ciência (POST)

Nesse Endpoint, é possível ativar o registro de ciência automática para os documentos recebidos de um CNPJ da empresa.
Importante lembrar que, após a ciência de operação realizada, alguns estados obrigam que seja feito algum outro manifesto.

Para entender um pouco mais sobre documentos recebidos, leia o artigo Qual a diferença entre os Menus: Não Recebidos e NF-e Recebidas?

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/cienciaOperacao

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/12345678912345/cienciaOperacao

Abaixo um exemplo de retorno após o envio da requisição:

{
  "nome": "07385111000102",
  "chave": "REGISTRAR_EVENTO_CIENCIA",
  "valor": "true"
}

2.1 Desativar Registro de Ciência (DELETE)

Nesse Endpoint, é possível desativar o registro de ciência automática para os documentos recebidos de um CNPJ da empresa.
Importante lembrar que, a Sefaz normalmente só libera para download após algum tipo de manifesto, seja ciência ou confirmação de operação.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/mde/config/{empresa}/cienciaOperacao

{empresa} : CNPJ da Empresa

Exemplo:

http://teste.oobj.com.br/oobj-rest-service/api/mde/config/12345678912345/cienciaOperacao

Abaixo um exemplo de retorno após o envio da requisição:

{
  "nome": "07385111000102",
  "chave": "REGISTRAR_EVENTO_CIENCIA",
  "valor": "false"
}

Os Endpoints listados nesse artigo são os essenciais e para realizar a consulta e download de documentos diretamente na Sefaz. Para saber ter acesso a todos os parâmetros de configuração do MDe, acesse o seguinte link: Configuração MDe.

Configurar MDe na Api Rest

Alterações de Obrigações Fiscais e Tributárias pelo Coronavírus

Tabela NCM 2022

E-book - Como escolher um Emissor Fiscal

Ebook | Transforma obrigatoriedade em inovação

Configurar MDe na Api Rest

Alterações de Obrigações Fiscais e Tributárias pelo Coronavírus

Tabela NCM 2022

E-book - Como escolher um Emissor Fiscal

Ebook | Transforma obrigatoriedade em inovação

Conheça nossas soluções

Receba as novidades da Oobj