Demonstrativo do resultado do Exercício

Para emissão do relatório de demonstrativo do resultado do exercício, é enviado uma requisição do tipo POSTpara o endpoint {{ BASE_REPORT_API_URL }}/v1/relatorio/demonstrativo-resultado passando um objeto FiltroRelatorioDTO no corpo da requisição, com os filtros desejados.

Exemplo de payload
{
  "dataInicio": "2023-11-29", // campo opcional para filtrar por data
  "dataFim": "2023-12-01", // campo opcional para filtrar por data
  "tipoRel": "PDF", // verificar endpoints de tipagem
}

Essa requisição irá retornar um FILE com o relatório em PDF ou XLS, codificado no formato Base64, de acordo com o tipo de relatório escolhido no objeto FiltroRelatorioDTO.

Para composição desse objeto de filtro, acesse as informações abaixo:

Endpoints e documentação para tipagem dos filtros

Tipos relatórios

É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo tipoRel do objeto FiltroRelatorioDTO.

{{ BASE_API_URL }}/v1/tipos/tipos-relatorio
Exemplo de response
[
  {
    "id":"PDF",
    "descricao":"PDF"
  },
  {
    "id":"XLS",
    "descricao":"Excel"
  }
]

Para mais informações, acesse a documentação da API:


Para mais informações, acesse a documentação da API: