Ir para o conteúdo principal

Consultar Chave MDF-e Não Encerrada

GET /api/MDFeEmissao/buscarConsultaChaveNaoEncerradaPorCNPJ 

O endpoint de consultar chave de MDF-e não encerrada, permite a consulta da lista de chaves não encerradas para determinado cenário, conforme layouts consulta disponibilizado pela Sefaz. 

Após enviar um manifesto para emissão, é possível realizar a consulta do status do processamento do mesmo através do protocolo, que foi gerado na emissão. 

Para realizar a consulta, basta passar o parâmetro “CNPJ”. 

Exemplo de Requisição:  

CODE
api/MDFeEmissao/buscarConsultaChaveNaoEncerradaPorCNPJ?CNPJ=99999999999999 

Exemplo de Retorno:

CODE
[ 

  { 

    "Outros": { 

      "NumeroProtocolo": "string", 

      "Documento": "string", 

      "ChaveDocumento": "string", 

      "Numero": 0, 

      "Serie": "string", 

      "ProtocoloSefaz": "string", 

      "CStat": "string", 

      "Motivo": "string" 

    } 

  } 

]

Observação

A estrutura de retorno a API V1 possui particularidades de parâmetros no retorno conforme natureza do tipo de documentos.

Exemplo

Com os tipos de documentos NF-e/CT-e/MDF-e/CTeOS (SEFAZ), usando os modelos de consulta GET, você terá o retorno com os documentos apresentando os seguintes campos:

  • tipoRetorno: Código que indica o tipo de documento retornado (Envio = 1, Evento = 2, Inutilização = 3, Outro = 10, EmProcessamento = 11, Erro = 99).

  • NumeroProtocolo: GUID gerado aleatoriamente, que realiza o vínculo do processo com a nota de envio, sendo único para cada envio 1 - 1, não importando se é autorizado/cancelado/rejeitado/invalido é gerado um novo para cada processamento.

  • Documento: XML Retornado do Processamento.

  • chaveDocumento: Código único utilizado para identificar o documento fiscal. Geralmente é composto por informações como CNPJ do emitente, data de emissão, tipo de documento, entre outros.

  • Número: Número sequencial que identifica o documento fiscal de forma única. Este número é atribuído pelo emissor do documento.

  • Serie: Indica a série do documento fiscal, que é uma sequência numérica ou alfanumérica utilizada para controlar a emissão de documentos fiscais.

  • Dataemissão: Data em que o documento fiscal foi emitido.

  • ProtocoloSefaz: Número de protocolo gerado pela SEFAZ, que identifica a comunicação ou transação realizada com o órgão.

  • Cstat: Código que indica o status da comunicação ou transação com a SEFAZ, como "autorizado", "rejeitado", "pendente", etc.

  • Motivo: Informação adicional que indica o motivo de um determinado status, como motivo da rejeição de um documento.

  • Evento: Indica o tipo de evento relacionado ao documento fiscal, como "autorização de uso", "cancelamento", etc.

  • Outros: Se refere a informações adicionais que não se enquadram em nenhum dos campos padrão de um documento fiscal.

Em caso de dúvidas sobre algum termo utilizado, acesse o nosso Glossário.

{{component-feedback-article}}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.