Através do serviço de Consulta Situação de MDF-e é possível obter a informação de qual o estado atual do MDF-e no banco de dados da Sefaz.
Esta funcionalidade é muito utilizada em casos onde é necessário verificar a existência e validade de um MDF-e, assim como obter informações sobre os eventos ocorridos com o mesmo (ex.: alteração de valores por Cartão de Correção Eletrônica).
URL
Produção: POST https://mdfe.ns.eti.br/mdfe/stats
Dados de entrada
Campo | Descrição | Tipo | Ocorrência | Observação |
---|---|---|---|---|
X-AUTH-TOKEN | Token de acesso do usuário | A | 0-1 | |
licencaCnpj | CNPJ da licença interessada em consultar a situação do MDF-e | N | 0-1 | Utilizado para identificar o certificado digital que deverá ser utilizado Se não for enviado, o CNPJ será extraído da chave enviada no campo chMDFe |
chMDFe | Chave de acesso do MDF-e | N | 1-1 | |
tpAmb | Tipo do ambiente de autorização do MDF-e | N | 1-1 | 1 - Produção; 2 - Homologação |
Exemplo de requisição
Consulta de situação
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"licencaCnpj": "07364617000135",
"chMDFe": "43161107364617000135580000000099461000094833",
"tpAmb": "2"
}'\
https://mdfe.ns.eti.br/mdfe/stats
Dados retornados
Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
---|---|---|---|---|---|
status | Código de status do processamento | 1-1 | N | ||
motivo | Descrição literal do status de processamento | 1-1 | A | ||
retConsSitMDFe | Objeto contendo os dados do protocolo de autorização do MDF-e e todos os eventos vinculados. | 0-1 | O | Somente em status = 200 | |
erro | Objeto contendo os dados de erro ocorrido durante o processamento | 0-1 | O | Somente em status != 200 | |
cStat | Código de status do erro | 1-1 | |||
xMotivo | Descrição literal do erro | 1-1 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retConsSitMDFe": {
"tpAmb": "1",
"verAplic": "RS20170524131932",
"cStat": "100",
"xMotivo": "Autorizado o uso do MDF-e",
"cUF": "43",
"protMDFe": {
"infProt": {
"Id": "MDFe943190000293404",
"tpAmb": "1",
"verAplic": "RS20181016150131",
"chMDFe": "43161107364617000135580000000099461000094833",
"dhRecbto": "2019-01-11T09:20:46-02:00",
"nProt": "943190000293405",
"digVal": "nzZFry3yOgdHeHZbIyunlbYIamA=",
"cStat": "100",
"xMotivo": "Autorizado o uso do MDF-e"
},
"versao": "3.00"
},
"versao": "3.00"
}
}
cStats Retornados
De acordo com o código de cStat principal, que é retornado no objeto retConsSitMDFe, é possível definir a situação do documento.
Abaixo segue uma tabela com os valores que podem ser retornados, podendo haver outros retornos conforme a necessidade da sefaz.
Código | Retorno |
---|---|
100 | Documento autorizado |
101 | Documento cancelado |
110 | Documento denegado |
132 | Documento encerrado |
Códigos de retorno
Código | Descrição |
---|---|
200 | Consulta realizada com sucesso |
-400 | Chave do MDF-e ou Tipo do Ambiente não informados |
-3 | Chave de acesso inválida |
-6 | Erro ao realizar a consulta. Verifique o objeto erro para identificar o motivo. |