Como gerar relatório de todos os documentos não recebidos?

Neste artigo você encontra o passo a passo sobre como obter os dados de todos os documentos não recebidos de uma ou mais empresas, em um determinado período.

Consultar todos os DFes não recebidos

1. Para começar, faça uma requisição tipo POST ao endpoint consultar documentos não recebidos;

   [URL_BASE]/api/relatorios/nao-recebidos

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

   • {cnpj}: CNPJ do 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 |.

   • {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'T'hh:mm:ssZ. Exemplo: '2023-01-26T12:25:59-03:00';
   • {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 NFes não recebidas.

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/nao-recebidos' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '{
  "cnpj": "07385111000102",
  "dataFinal": "2023-01-26T12:25:59-03:00",
  "dataInicial": "2023-01-27T12:25:59-03:00",
  "pagina": 0,
  "tipoAmbiente": "hom"
}'

Exemplo de retorno

{
  "registros": [
    {
      "chaveAcesso": "53210912769092000158550270000011301940727456",
      "cpfCnpj": "12769092000158",
      "xNome": "Invent Software LTDA",
      "dataHoraEmissao": 1648814460000,
      "tipoNfe": 1,
      "valorTotal": 500,
      "numeroProtocolo": "353210000214606",
      "status": 1,
      "statusArquivo": 30,
      "ie": "755474300104",
      "digestValue": "g0CbwmjS9LMJgLRau+JtXb4Bi40="
    }
  ],
  "pagina": 1,
  "totalPaginas": 1,
  "numeroTotal": 1,
  "numeroElementos": 1,
  "maximoPorPagina": 20
}

Pronto! Você acaba de completar a consulta de relatório de documentos não recebidos.