Como gerar relatório de todos os eventos?

Neste artigo você encontra o passo a passo sobre como obter os dados todos os eventos relacionados a um DFe, de uma ou mais empresas, em um determinado período. Além disso, poderá escolher se o relatório deverá ou não retornar o XML dos eventos.

---

Consultar todos os eventos

1. Para começar, faça uma requisição tipo POST ao endpoint de consultar todos os eventos;

   [URL_BASE]/api/relatorios/eventos

2. No corpo da requisição (request body) preencha os seguintes parâmetros:

   • {cnpj}: CNPJ interessado, pode ser mais de um;
     ATENÇÃO

     Se mais de um CNPJ, separe-os com ponto, vírgula, ponto e vírgula, quebra de linha ou caractere de espaço | . | , | ; | \n |.

   • {comXml}: se deve retornar ou não os XML's. Valores aceitos: true ou false;
   • {dataFinal}*: data final no formato aaaa-mm-dd;
   • {dataInicial}*: data inicial no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2023-01-26T12:25:59-03:00';
   • {modelo}*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe), 66 (NF3e) ou 99 (NFSe);
   • {pagina}: número da página. Caso não seja preenchido, retornará o valor padrão: 1 (página número um) ;
   • {tipoAmbiente}*: hom ou prod.

3. Informe o x-auth-token no cabeçalho (header parameters) da requisição.

Exemplo de requisição

O exemplo abaixo traz um modelo de requisição preenchido para consulta de eventos, sem XML.

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X POST 'https://rest-teste.oobj.com.br/api/relatorios/eventos' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '{
  "cnpj": "07385111000102",
  "comXml": false,
  "dataFinal": "2023-01-26T12:25:59-03:00",
  "dataInicial": "2023-01-27T12:25:59-03:00",
  "modelo": 55,
  "pagina": 0,
  "tipoAmbiente": "hom"
}'

Exemplo de retorno

{
  "registros": [
      {
          "sequencial": 1,
          "chaveAcesso": "43230107385111000102555030007383471314477461",
          "dataEvento": "2023-01-04T10:58:40-03:00",
          "codigoEvento": 110110,
          "descricaoEvento": "Carta de Correção",
          "status": "Homologado",
          "cStat": 135,
          "retornoSefaz": "Evento registrado e vinculado a NF-e",
          "conteudo": null
      },
      {
          "sequencial": 1,
          "chaveAcesso": "43230107385111000102555030007384651314477465",
          "dataEvento": "2023-01-04T14:35:25-03:00",
          "codigoEvento": 210210,
          "descricaoEvento": "Ciência da Operação",
          "status": "Homologado",
          "cStat": 135,
          "retornoSefaz": "Evento registrado e vinculado a NF-e",
          "conteudo": null
      }
  ]
}

Pronto! Você acaba de completar a consulta de relatório dos eventos.