Despesas da turma
Despesa da turma é um custo lançado para a turma ou para um aluno dela, como um gasto com fornecedor, com quantidade, valor unitário e valor total. Cada despesa tem um tipo de despesa, pode ser ligada a um fornecedor e a uma matrícula, e pode ser marcada como faturada.
No manual de usuário do módulo Operacional, esta área não tem aba na tela Turmas. Esta página documenta os endpoints de despesa de turma disponíveis na API.
As regras gerais estão em Convenções e a sessão em Autenticação. Os dados da turma estão em Turmas.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /operational/classes/{classId}/expenses | Lista as despesas, com filtro por turma |
| GET | /operational/classes/{classId}/expenses/{id} | Consulta uma despesa |
| PUT | /operational/classes/{classId}/expenses/{id} | Altera uma despesa |
| DELETE | /operational/classes/{classId}/expenses/{id} | Remove uma despesa |
Listar despesas
GET /operational/classes/{classId}/expenses
Lista as despesas. Para listar as despesas de uma turma, informe o uuid da turma no parâmetro class_uuid. Sem esse parâmetro, a listagem traz as despesas de todas as turmas da empresa cliente.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| class_uuid | Turma (uuid). Filtra as despesas dessa turma |
| search | Busca na descrição da despesa, no nome, no documento e no nome da empresa do fornecedor, no nome do aluno e no nome do tipo de despesa |
| column | Coluna de ordenação, com order |
| order | Sentido da ordenação: asc ou desc, com column |
| per_page | Quantidade por página. Se omitido, a lista vem completa |
| page | Número da página, com per_page |
Resposta
- 200: lista de despesas ou, com
per_page, objeto paginado (veja Convenções).
Campos principais: id, class_id, training_student_id, student_name, student_document, student_passport, type_uuid, type (nome do tipo de despesa), customer_vendor_id, customer_vendor_name, customer_vendor_document, business_name, business_document, expense (descrição), quantity, unitary_value, total_value, billed, automatic, comments, contract_course_id, user_create_name, user_update_name e created_at.
Exemplo
curl "https://api.pedagogo.app/operational/classes/<uuid-da-turma>/expenses?class_uuid=<uuid-da-turma>&per_page=15" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"
Consultar, alterar e remover
GET /operational/classes/{classId}/expenses/{id}
Devolve a despesa informada, com a turma (class) e o tipo de despesa (type). O id é o identificador numérico da despesa.
- 200: a despesa. Se a despesa não for encontrada, a resposta traz
null.
PUT /operational/classes/{classId}/expenses/{id}
Altera a despesa. Os campos enviados são gravados. O valor total é recalculado a cada alteração como quantidade vezes valor unitário enviados, com quantidade 1 quando não for informada.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| training_student_id | Não | inteiro | Matrícula do aluno à qual a despesa se liga (identificador da matrícula na turma) |
| type_uuid | Não | uuid | Tipo de despesa |
| customer_vendor_id | Não | inteiro | Fornecedor (identificador do cadastro de clientes e fornecedores) |
| expense | Não | texto | Descrição da despesa |
| quantity | Não | inteiro | Quantidade |
| unitary_value | Não | número | Valor unitário |
| billed | Não | booleano | Indica se a despesa está faturada |
| automatic | Não | booleano | Indica se a despesa foi gerada automaticamente |
| comments | Não | texto | Observações |
- 200: a despesa alterada.
- 422: dados inválidos.
DELETE /operational/classes/{classId}/expenses/{id}
Remove a despesa (exclusão lógica).
- 200: sem conteúdo.