Skip to main content

Como gerar relatório de todos os DFes emitidos?

Neste artigo você encontra o passo a passo sobre como obter os dados de todos os documentos emitidos 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 documentos.


Consultar todos os DFes emitidos

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

    [URL_BASE]/api/relatorios/emitidos
  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'T'hh:mm:ssZ. Exemplo: '2023-01-26T12:25:59-03:00';
    • {dataInicial}*: data inicial no formato aaaa-mm-dd;
    • {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. Preencha, se necessário, os parâmetros opcionais (query parameters):

    • {listarNaoProcessados}: true ou false;
    • {listarAutorizadosOuCanceladosPorIteracao}: true ou false;
  4. 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 documentos emitidos, 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/emitidos' \
-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": 1,
"tipoAmbiente": "hom"
}'

Exemplo de retorno

{
"registros": [
{
"idLote": 741567,
"timestamp": 1676481047000,
"conteudo": null,
"status": "Autorizada",
"statusArquivo": "Válido",
"chaveAcesso": "43230207385111000102555030007415671314477460",
"cStat": 100,
"xMotivo": "Autorizado o uso da NF-e",
"codigoUF": 43,
"numeroProtocolo": "143230001247511",
"dataRecebimento": 1676481047000,
"permiteImpressao": null,
"tipoEmissao": {
"codigo": 1,
"descricao": "Normal"
}
},
{
"idLote": 741566,
"timestamp": 1676480925000,
"conteudo": null,
"status": "Autorizada",
"statusArquivo": "Válido",
"chaveAcesso": "43230207385111000102555030007415661314477463",
"cStat": 100,
"xMotivo": "Autorizado o uso da NF-e",
"codigoUF": 43,
"numeroProtocolo": "143230001247506",
"dataRecebimento": 1676480925000,
"permiteImpressao": null,
"tipoEmissao": {
"codigo": 1,
"descricao": "Normal"
}
}
]
}

Pronto! Você acaba de completar a consulta de relatório de documentos emitidos.

(62) 3086-5750

Endereço: Rua 111, nº 335, Qd. F35,

Lt. 57 (Esquina com Rua 88) - Setor Sul

Goiânia - GO

CEP: 74085-130

LIGUE

(62) 3086-5750

SUPORTE TÉCNICO

FALE COM A GENTE

LIGAMOS PARA VOCÊ

SOLICITE UM CONTATO

Você bem informado toda semana

Copyright © Oobj 2024 Built with Docusaurus.