Despesas da turma

Os custos da turma, como almoço, hospedagem, instrutor, aluguel e transporte, conforme os tipos de despesa cadastrados pelo cliente. Na tela, ficam na aba Turmas > Despesas da página da turma. Cada despesa tem o total calculado a partir da quantidade e do valor unitário.

Nas rotas desta página, {class_uuid} é o uuid da turma e {id} é o identificador numérico da despesa.

Endpoints

Método	Caminho	Descrição
GET	/comercial/classes/{class_uuid}/expenses	Lista as despesas da turma
POST	/comercial/classes/{class_uuid}/expenses	Inclui uma despesa na turma
GET	/comercial/classes/{class_uuid}/expenses/{id}	Consulta uma despesa da turma
PUT	/comercial/classes/{class_uuid}/expenses/{id}	Altera uma despesa da turma
DELETE	/comercial/classes/{class_uuid}/expenses/{id}	Remove uma despesa da turma
PATCH	/comercial/classes/{class_uuid}/expenses/{id}/toggle-billing	Ativa ou desativa o faturamento da despesa

Listar e incluir

GET /comercial/classes/{class_uuid}/expenses

Lista as despesas da turma informada na URL.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre para buscar pela descrição da despesa, pelo nome do fornecedor, pelo nome do aluno ou pelo tipo da despesa
column e order	Ordena pela coluna informada, em asc ou desc
per_page e page	Paginação. Sem per_page, a resposta é a lista completa

Resposta: 200. Cada item traz os dados da despesa, o tipo, o fornecedor, o aluno (quando houver), o total_value e os nomes de quem criou e alterou o registro.

POST /comercial/classes/{class_uuid}/expenses

Inclui uma despesa na turma.

Corpo

Campo	Obrigatório	Tipo	Descrição
type_uuid	Sim	Texto	uuid do tipo de despesa. Aceita os tipos do cliente e os tipos gerais
expense	Sim	Texto	Descrição da despesa
unitary_value	Sim	Número	Valor de cada unidade
training_student_id	Não	Número	Id do aluno na turma ao qual a despesa se refere
customer_vendor_id	Não	Número	Id do fornecedor, quem recebe o valor
quantity	Não	Número inteiro	Quantidade usada no cálculo do total
billed	Não	Booleano	Indica se a despesa já foi faturada
automatic	Não	Booleano	Marca a despesa como automática, como as geradas pelos vouchers do aluno
comments	Não	Texto	Observações

O total da despesa é calculado como a quantidade (1, quando não informada) multiplicada pelo valor unitário.

curl -X POST "https://api.pedagogo.app/comercial/classes/<uuid-da-turma>/expenses" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"type_uuid": "<uuid-do-tipo-de-despesa>", "expense": "Almoço exemplo", "unitary_value": 35.5, "quantity": 2}'

Resposta: 200 com a despesa criada, incluindo o total_value.

Consultar, alterar, apagar e faturar

GET /comercial/classes/{class_uuid}/expenses/{id}

Consulta uma despesa da turma, com a turma e o tipo.

Resposta: 200 com a despesa.

PUT /comercial/classes/{class_uuid}/expenses/{id}

Altera uma despesa da turma. Envie só os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
type_uuid	Não	Texto	uuid do novo tipo de despesa
expense	Não	Texto	Descrição da despesa
unitary_value	Não	Número	Valor de cada unidade
quantity	Não	Número inteiro	Quantidade usada no cálculo do total
training_student_id	Não	Número	Id do aluno na turma ao qual a despesa se refere
customer_vendor_id	Não	Número	Id do fornecedor
billed	Não	Booleano	Indica se a despesa já foi faturada
automatic	Não	Booleano	Marca a despesa como automática
comments	Não	Texto	Observações

O total é recalculado a cada alteração, a partir da quantidade e do valor unitário.

Resposta: 200 com a despesa alterada.

DELETE /comercial/classes/{class_uuid}/expenses/{id}

Remove uma despesa da turma. A remoção é lógica.

Resposta: 200, com corpo null.

PATCH /comercial/classes/{class_uuid}/expenses/{id}/toggle-billing

Ativa ou desativa o faturamento da despesa. Se a despesa estava faturada, passa a não faturada, e o contrário. Na tela, é a marcação Faturado.

Não há corpo na chamada.

Resposta: 200, com corpo null.