Como consultar eventos de um DFe?
Há algumas formas de consultar eventos fiscais via API REST Oobj. Neste artigo você encontra o passo a passo para:
- Consultar todos os eventos;
- Consultar os detalhes de um tipo específico de evento;
- Consultar eventos em um determinado intervalo de datas.
Consultar todos os eventos de um DFe
Para consultar todos os eventos associados a um DFe, sendo a relação do DFe como o CNPJ da empresa, siga estes passos:
Para começar, faça uma requisição tipo GET ao endpoint de consultar eventos de um DFe;
[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}/eventos/{relacao}Preencha as seguintes informações (
path parameters):{empresa}*: CNPJ da empresa;{ambiente}*: hom ou prod;{codModelo}*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe), 66 (NF3e), 67 (CTeOS) ou 99 (NFSe);{ano}*: ano de emissão no formato AAAA (quatro dígitos);{serie}*: série do DFe;{numero}*: número do DFe;{relacao}*: relação do cliente com o documento
Informe o x-auth-token no cabeçalho (
header parameters) da requisição.
No campo conteudo do retorno 200 você encontra o XML Proc de todos os eventos relacionados ao DFe. Esse XML é idêntico ao armazenado pela Sefaz e deve ser guardado pelo contribuinte por no mínimo cinco anos.
Exemplo de requisição
Exemplo de retorno
Consultar detalhes de um tipo específico de evento
Para consultar os detalhes de um tipo específico de evento a partir de uma chave de acesso, siga estes passos:
Faça uma requisição tipo GET ao endpoint de consultar detalhes de um evento;
[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{chaveAcesso}/eventos/{tipoEvento}/{relacao}Preencha as seguintes informações (
path parameters):{empresa}*: CNPJ da empresa;{ambiente}*: hom ou prod;{chaveAcesso}*: chave de acesso do documento;{tipoEvento}*: código do tipo do evento. Exemplo: 110110 (carta de correção), 110111 (cancelamento) ou 110140 (EPEC);
Informe o x-auth-token no cabeçalho (
header parameters) da requisição.
Exemplo de requisição
Exemplo de retorno
Consultar eventos em um intervalo de datas
Para consultar todos os eventos cuja data esteja entre dataEventoInicial e dataEventoFinal, com a relação do DFe como o CNPJ dos eventos, siga estes passos:
Serão considerados eventos entre 00:00:00h da data inicial e 23:59:59h da data final.
Faça uma requisição tipo GET ao endpoint de consultar todos os eventos em um intervalo de datas;
[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/eventos/data-inicial/{dataEventoInicial}/data-final/{dataEventoFinal}/{relacao}Preencha as seguintes informações (
path parameters):{empresa}*: CNPJ da empresa;{ambiente}*: hom ou prod;{codModelo}*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe), 66 (NF3e), 67 (CTeOS) ou 99 (NFSe);{dataEventoInicial}*: data inicial para pesquisa, no formato aaaa-mm-dd. Exemplo: '2018-03-26';{dataEventoFinal}*: data final para pesquisa, no formato aaaa-mm-dd. Exemplo: '2018-03-26';{relacao}*: relação do cliente com o documento
Informe o x-auth-token no cabeçalho (
header parameters) da requisição.
Exemplo de requisição
Exemplo de retorno
Pronto! Você acaba de completar a consulta de um evento fiscal de três formas diferentes.
