Tipos
Corresponde à aba Tipos, na tela Configurações do módulo Administrativo. Reúne duas listas do cliente: as categorias de arquivo e os tipos de despesa.
Os endpoints das duas listas seguem o mesmo padrão. A busca (search) procura pelo
nome do item, e per_page e page paginam a resposta, como descrito em
Convenções.
Categorias de arquivo
Cadastra os tipos de documento que podem ser anexados nas abas Arquivos dos cadastros, por exemplo Contrato, RG, Certificado ou ASO. As categorias aparecem como opção ao anexar um arquivo em Alunos, Empresas, Fornecedores, Instrutores e Colaboradores.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/file-types | Lista as categorias de arquivo |
| POST | /administrative/settings/file-types | Cadastra uma categoria de arquivo |
| PUT | /administrative/settings/file-types/{uuid} | Altera uma categoria de arquivo |
| DELETE | /administrative/settings/file-types/{uuid} | Apaga uma categoria de arquivo |
GET /administrative/settings/file-types
Lista as categorias de arquivo do cliente, em ordem alfabética, salvo se
columnName e orderData forem informados.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto livre que busca no nome da categoria |
| columnName | Coluna para ordenar |
| orderData | Sentido da ordenação: asc ou desc |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
Resposta (200): lista de categorias. Campos: id, uuid e file_type.
POST /administrative/settings/file-types
Cadastra uma categoria de arquivo. Se já existir uma categoria com o mesmo nome no cliente, ela é devolvida e não é duplicada.
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file_type | Sim | Texto | Nome da categoria |
Resposta (201): a categoria criada, ou a já existente com o mesmo nome.
Exemplo:
curl -X POST https://api.pedagogo.app/administrative/settings/file-types \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{"file_type": "Categoria exemplo"}'
PUT /administrative/settings/file-types/{uuid}
Altera uma categoria de arquivo.
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file_type | Sim | Texto | Novo nome da categoria |
Resposta (200): a categoria alterada.
DELETE /administrative/settings/file-types/{uuid}
Apaga a categoria de arquivo. A exclusão é lógica e não verifica se a categoria está em uso por algum arquivo.
Resposta (200): sem conteúdo relevante (null).
Tipos de despesa
Cadastra as naturezas de despesa de um treinamento, por exemplo Hospedagem, Almoço ou Transporte. Os tipos de despesa são usados nas despesas de cada turma e de cada proposta, e aparecem no relatório de despesas do módulo Comercial.
A lista traz os tipos padrão do sistema, comuns a todos os clientes, junto com os tipos cadastrados pelo próprio cliente. Os tipos padrão do sistema não podem ser alterados por esta rota: nesse caso a resposta traz o registro sem mudanças.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/settings/expense-types | Lista os tipos de despesa |
| POST | /administrative/settings/expense-types | Cadastra um tipo de despesa |
| GET | /administrative/settings/expense-types/{uuid} | Consulta um tipo de despesa |
| PUT | /administrative/settings/expense-types/{uuid} | Altera um tipo de despesa |
| DELETE | /administrative/settings/expense-types/{uuid} | Apaga um tipo de despesa |
GET /administrative/settings/expense-types
Lista os tipos de despesa disponíveis para o cliente, em ordem alfabética, salvo se
columnName e orderData forem informados.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto livre que busca no nome do tipo |
| columnName | Coluna para ordenar |
| orderData | Sentido da ordenação: asc ou desc |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
Resposta (200): lista de tipos. Campos: uuid e type.
POST /administrative/settings/expense-types
Cadastra um tipo de despesa do cliente.
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| type | Sim | Texto | Nome do tipo de despesa, por exemplo Hospedagem |
Resposta (201): o tipo criado, com o uuid.
Consultar, alterar e apagar
GET /administrative/settings/expense-types/{uuid} devolve um tipo de despesa
pelo uuid.
PUT /administrative/settings/expense-types/{uuid} altera o tipo. Corpo (JSON):
type (Sim, texto, novo nome). Resposta (200): o tipo alterado.
DELETE /administrative/settings/expense-types/{uuid} apaga o tipo, com exclusão
lógica. Resposta (200): sem conteúdo relevante (null).