Home » Categorias » Soluções Oobj » API Rest

Relatórios na API Rest

Nº do Artigo: 1142 | Avaliação: Não Avaliado | Última atualização: 23/09/2021 13:58:28

É possível gerar relatórios com alguns dados básico, para melhor acompanhamento dos documentos emitidos e/ou recebidos através da aplicação da Oobj. Para utilizar a solução através da API REST, é necessário ter um usuário para acessar a API(x-auth-token). No artigo Autenticação na API Rest  você encontra mais detalhes sobre o x-auth-token.

Existem vários Endpoints para gerar um relatório e para cada um, há uma URL e função específica.
Sempre que essas requisições forem executadas, retornará os dados de acordo com a função da requisição, e será de forma paginada com 20 elementos. Ou seja, ao realizar o primeiro acesso a esse Endpoint você poderá informar a página que deseja consultar na URL, ou poderá deixar em branco, assim virá a primeira página.

Na resposta de sua consulta, será informado no final a quantidade de itens que há na página, e qual o Total de itens que pode ser obtidos em todas as outras páginas. Dessa forma, basta realizar uma iteração, passando por cada página até que não hajam mais elementos, caso queira obter todos os XML's Proc da sua empresa.

 

Listar documentos Emitidos (POST)

O usuário poderá realizar uma consulta resumida de todos os documentos emitidos, da empresa que tenha permissão, dentro do período desejado. Poderá também, escolher se deseja o XML completo dos documentos que serão retornados na consulta. 

 

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/relatorios/emitidos

 

Exemplo:

http://rest.oobj-dfe.com.br/api/relatorios/emitidos

 

Os parâmetros a serem enviados junto com a requisição são:

  • {cnpj} : CNPJ da Empresa emitente
  • {comXml} : true (trará o XML) / false (apresentará apenas um resumo)
  • {dataFinal} : Data final da pesquisa (2021-08-19T23:00:16.221Z)
  • {dataInicial} : Data inicial da pesquisa (2021-08-01T23:00:16.221Z)
  • {modelo}: modelo do documento (55, 65, 57 etc)
  • {pagina}: página a ser visualizada
  • {tipoAmbiente}: ambiente de consulta (hom ou prod)

 

Abaixo um exemplo de retorno da requisição sem as informações do XML:

 

{
  "registros": [
    {
      "idLote": 690373,
      "timestamp": 1629203958000,
      "conteudo": null,
      "status": "Autorizada",
      "chaveAcesso": "43210807385111000102555030006903731678924922",
      "cStat": 100,
      "xMotivo": "Autorizado o uso da NF-e",
      "codigoUF": 43,
      "numeroProtocolo": "143210000572778",
      "dataRecebimento": 1629203958000,
      "permiteImpressao": null,
      "tipoEmissao": {
        "codigo": 1,
        "descricao": "Normal"
      }
    },
    {
      "idLote": 690290,
      "timestamp": 1629115147000,
      "conteudo": null,
      "status": "Autorizada",
      "chaveAcesso": "43210807385111000102555030006902901414699288",
      "cStat": 100,
      "xMotivo": "Autorizado o uso da NF-e",
      "codigoUF": 43,
      "numeroProtocolo": "143210000570609",
      "dataRecebimento": 1629115147000,
      "permiteImpressao": null,
      "tipoEmissao": {
        "codigo": 1,
        "descricao": "Normal"
      }
    },
    {
      "idLote": 690080,
      "timestamp": 1628768264000,
      "conteudo": null,
      "status": "Autorizada",
      "chaveAcesso": "43210807385111000102555030006900801942526750",
      "cStat": 100,
      "xMotivo": "Autorizado o uso da NF-e",
      "codigoUF": 43,
      "numeroProtocolo": "143210000564607",
      "dataRecebimento": 1628768264000,
      "permiteImpressao": null,
      "tipoEmissao": {
        "codigo": 1,
        "descricao": "Normal"
      }
    }
  ],
  "pagina": 1,
  "numeroTotal": 3,
  "numeroElementos": 3,
  "maximoPorPagina": 20
}

 

Listar os Eventos (POST)

O usuário poderá realizar uma consulta resumida de todos os eventos relacionados à um DF-e (Documento Fiscal Eletrônico) da empresa que tenha permissão, dentro de um determinado período.
Poderá também, escolher se deseja o XML completo dos eventos que serão retornados na consulta. 

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/relatorios/eventos

 

Exemplo:

http://rest.oobj-dfe.com.br/api/relatorios/eventos

 

Os parâmetros a serem enviados junto com a requisição são:

  • {cnpj} : CNPJ da Empresa emitente
  • {comXml} : true (trará o XML) / false (apresentará apenas um resumo)
  • {dataFinal} : Data final da pesquisa (2021-08-19T23:00:16.221Z)
  • {dataInicial} : Data inicial da pesquisa (2021-08-01T23:00:16.221Z)
  • {modelo}: modelo do documento (55, 65, 57 etc)
  • {pagina}: página a ser visualizada
  • {tipoAmbiente}: ambiente de consulta (hom ou prod)

 

Abaixo um exemplo de retorno da requisição sem as informações do XML:

 

{
  "registros": [
    {
      "sequencial": 1,
      "chaveAcesso": "43210807385111000102555030006903731678924922",
      "dataEvento": "2021-08-19T20:19:22-03:00",
      "codigoEvento": 110110,
      "descricaoEvento": "Carta de Correção",
      "status": "Homologado",
      "cStat": 135,
      "retornoSefaz": "Evento registrado e vinculado a NF-e",
      "conteudo": null
    }
  ],
  "pagina": 1,
  "numeroTotal": 1,
  "numeroElementos": 1,
  "maximoPorPagina": 20
}

 

Listar inutilizações (POST)

Por esse Endpoint é possível buscar as inutilizações dentro do período desejado, com a opção de trazer apenas o resumo ou retornar também o XML da inutilização.
Importante lembrar que as inutilizações são possíveis apenas para NF-e, NFC-e e CT-e.

A URL é construída da seguinte forma:

/http:// ou https:// + /endereço da API Rest + /api/relatorios/inutilizacao

 

Exemplo

http://rest.oobj-dfe.com.br/api/relatorios/inutilizacao

 

Os parâmetros a serem enviados junto com a requisição são:

  • {cnpj} : CNPJ da Empresa emitente
  • {comXml} : true (trará o XML) / false (apresentará apenas um resumo)
  • {dataFinal} : Data final da pesquisa (2021-08-19T23:00:16.221Z)
  • {dataInicial} : Data inicial da pesquisa (2021-08-01T23:00:16.221Z)
  • {modelo}: modelo do documento (55, 65 ou 57)
  • {pagina}: página a ser visualizada
  • {tipoAmbiente}: ambiente de consulta (hom ou prod) 

 

Abaixo um exemplo de retorno da requisição sem as informações do XML:

 

{
  "registros": [
    {
      "ambiente": "Homologação",
      "uf": "RS",
      "ano": 2021,
      "cnpjEmitente": "07385111000102",
      "modelo": 55,
      "serie": 503,
      "numeroInicial": 690644,
      "numeroFinal": 690644,
      "protocolo": 143210000582107,
      "justificativa": "Teste de inutilizacao para Documentacao de sistema",
      "dataRecebimento": 1629461209000,
      "conteudo": null,
      "status": "HOM"
    }
  ],
  "pagina": 1,
  "numeroTotal": 1,
  "numeroElementos": 1,
  "maximoPorPagina": 20
}

 

Listar os documentos recebidos (POST)

O usuário poderá realizar uma consulta resumida de todos os documentos recebidos, da empresa que tenha permissão e dentro do período desejado. Poderá também, escolher se o retorno apresentará o XML completo dos documentos que serão retornados na consulta. 

A URL é construída da seguinte forma:

/http:// ou https:// + /endereço da API Rest + /api/relatorios/recebidos

 

Exemplo:

 

http://rest.oobj-dfe.com.br/api/relatorios/recebidos

 

Os parâmetros a serem enviados junto com a requisição são:

  • {cnpj} : CNPJ da Empresa emitente
  • {comXml} : true (trará o XML) / false (apresentará apenas um resumo)
  • {dataFinal} : Data de processamento do documento para fim da pesquisa (2021-08-19T23:00:16.221Z)
  • {dataInicial} : Data de processamento do documento para inicio da pesquisa (2021-08-01T23:00:16.221Z)
  • {modelo}: modelo do documento (55, 65 ou 57)
  • {pagina}: página a ser visualizada
  • {tipoAmbiente}: ambiente de consulta (hom ou prod)

 

Abaixo um exemplo de retorno da requisição sem as informações do XML:

 

[...]  

{
      "idLote": 171686,
      "timestamp": 1629458904000,
      "conteudo": null,
      "status": "Autorizada",
      "chaveAcesso": "25210803755215000534550030001234567804003838",
      "cStat": 100,
      "xMotivo": "Autorizado o uso da NF-e",
      "codigoUF": 25,
      "numeroProtocolo": "325210023408792",
      "dataRecebimento": 1629459086000,
      "permiteImpressao": null,
      "tipoEmissao": {
        "codigo": 1,
        "descricao": "Normal"
      }
    },
    {
      "idLote": 34,
      "timestamp": 1629458588000,
      "conteudo": null,
      "status": "Autorizada",
      "chaveAcesso": "42210803755215000534550030001234567804003838",
      "cStat": 100,
      "xMotivo": "Autorizado o uso da NF-e",
      "codigoUF": 42,
      "numeroProtocolo": "342210154409366",
      "dataRecebimento": 1629463014308,
      "permiteImpressao": null,
      "tipoEmissao": {
        "codigo": 1,
        "descricao": "Normal"
      }
    }
  ],
  "pagina": 1,
  "numeroTotal": 30,
  "numeroElementos": 20,
  "maximoPorPagina": 20
}

 

Observação: Nos retornos das requisições, as informações relacionadas à datas, estão no formato data unix. Caso venha utilizar em sua aplicação, é necessário a conversão destas informações.

 

Para realizar testes com a API Rest, e ter mais detalhes com os Relatórios de Documentos Fiscais, acesse a documentação completa através do link: http://rest.oobj-dfe.com.br/swagger-ui.html#/Documento32Fiscal
0 (0)
Avaliação do Artigo (Nenhum voto)
Avaliar esse artigo
Anexos
Não há anexos para este artigo.
Artigos Relacionados RSS Feed
Integração API Rest
Visualizado 622 vezes desde 09/03/2018
Consultar MDF-e não encerrado via API Rest
Visualizado 315 vezes desde 23/08/2021
Recebimento de Documentos Fiscais via API Rest
Visualizado 614 vezes desde 16/03/2018
Configurar MDe na Api Rest
Visualizado 375 vezes desde 27/09/2018
Geração de DADFe sem valor fiscal na API Rest
Visualizado 394 vezes desde 25/05/2020
Como funciona o processo de emissão na API Rest?
Visualizado 250 vezes desde 06/08/2019
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 309 vezes desde 16/03/2018
Gerenciamento de Empresas na API Rest
Visualizado 405 vezes desde 16/03/2018
Consulta Cadastro Centralizado de Contribuinte - Consulta Cadastro API Rest
Visualizado 743 vezes desde 14/01/2021
Criar Aplicativo no Monitor Oobj
Visualizado 268 vezes desde 12/04/2018
Materiais