O manual da API de Relatórios tem como objetivo informar ao usuário como devem ser preenchidos os endpoints dos relatórios disponíveis para consulta.

A seguir, estarão disponíveis para consulta os relatórios, e será especificado cada endpoint de dados complementares que o relatório possa precisar, qual o tipo da requisição e como os campos devem ser preenchidos.
Todos os endpoints retornarão um JSON, o qual possui um formato padrão, contendo "erros", "mensagens" e "resultado".

"erros": Uma lista que armazena possíveis erros ocorridos durante a chamada da API. Se não houver erros, a lista estará vazia.
"mensagens": Uma lista que pode conter mensagens informativas ou de status relacionadas à chamada da API. Se não houver mensagens, a lista estará vazia.
"resultado": Um objeto que contém uma chave com o título do endpoint, contendo os dados principais da resposta.

Os valores nos parâmetros devem estar em codificação UTF-8.

Legenda de "Como os campos devem ser preenchidos"

Campo	Informa o nome do campo a ser preenchido
Descrição	Descreve a finalidade do campo
Preenchimento	Informa o tipo de dado do campo e como deve ser preenchido, tipos de dados: N = Numérico T = Texto D = Data, no formato aaaa-mm-dd. Exemplo: 2022-09-01 M = Mês, o campo deve ser preenchido com o número do mês. L = Lógico, campo deve ser preenchido com 'S'(Sim) ou 'N'(Não). Exemplo de preenchimento para o campo "exercicio": N - O campo deve ser preenchido com o exercício desejado e deve conter 4 dígitos.
Obrigatório?	Informa se o campo é obrigatório ou não

Legenda de "Erros que esse endpoint pode gerar"

Referente ao campo	Indica a qual campo o erro se refere
Descrição	Descreve o erro
ID do erro	Informa o ID daquele erro

Legenda de "Descrição da resposta"

Campo	Título do campo
Descrição	Descreve a finalidade do campo

Consulte como os campos devem ser preenchidos nos seguintes relatórios:

Abaixo estão disponíveis os relatórios que possuem um endpoint para consulta, selecione um relatório para visualizar como seus campos devem ser preenchidos.