Enviar Consulta Chave MDF-e Não Encerrada
POST /api/MDFeEmissao/ConsultaChaveNaoEncerrada
O endpoint de consultar chave de MDF-e não encerrada, permite o envio de consulta da lista de chaves não encerradas para determinado cenário, conforme layouts de consulta disponibilizado pela Sefaz.
O layout da string de “Conteudo” deve seguir o layout padrão conforme a documentação fornecida pela Secretaria de Fazenda (Sefaz), através dos Schemas XSD distribuídos com os pacotes de liberação (PL).
A seguir, link para arquivo tipo XML MDF-e: Portal do Manifesto Eletrônico de Documentos Fiscais
Após acessar o portal, clique no menu Documentos, e na opção Esquemas XML.
Exemplo de Requisição:
{
"Header": {
"CNPJEmpresa": "99999999999999",
"TipoEnvio": 1
},
"Body": {
"Conteudo": "{\"versao\":\"1.00\",\"tpAmb\":\"2\",\"xServ\":\"CONSULTAR NÃO ENCERRADOS\",\"CNPJ\":\"99999999999999\"}"
}
}
Exemplo de Retorno:
{
"tipoRetorno": 11,
"processamento": {
"message": "Documento enviado para processamento",
"protocolo": "5ceaefd3-6464-46ca-8582-d7d761854737"
}
}
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}}