Acordos
Como funcionam os acordos na Principia e as duas formas de integrar com eles.
Quando um aluno negocia uma dívida, a Principia cria um acordo. Este guia explica o que acontece internamente e como sua instituição pode acompanhar isso via GET /acordos / GET /v2/acordos (veja também as Rotas da API).
Como um acordo funciona por dentro
Ao fechar um acordo, a Principia cria novas parcelas (as "parcelas de acordo"), vinculadas às parcelas originais. A partir desse momento:
- As parcelas originais ficam "congeladas": continuam existindo, mas deixam de ser cobradas. A cobrança passa a ser feita nas parcelas do acordo.
- Se o acordo for quebrado ou cancelado, as parcelas originais voltam a ser cobradas, e os valores já pagos nas parcelas do acordo são abatidos nelas.
Acompanhe o status do acordo periodicamente
Um acordo pode ser cancelado depois de criado. Use o campo atualizado_em do objeto de acordo para saber quando algo mudou, e trate a quebra/cancelamento: as parcelas de acordo devem ser canceladas no seu sistema e as parcelas originais voltam a ser cobradas.
Status possíveis de um acordo
| Status | Significado |
|---|---|
PROPOSTA | Aluno ainda não pagou a entrada, então o acordo não foi ativado. |
ATIVO | Aluno pagou a entrada, o acordo está em andamento. |
PAGO | Acordo quitado: aluno pagou todas as parcelas do acordo. |
QUEBRADO | Acordo que já esteve ativo e foi cancelado (inadimplência nas parcelas do acordo). |
EXPIRADO | Aluno não pagou a entrada e o acordo foi cancelado automaticamente 30 dias após a criação. |
CANCELADO | Acordo cancelado. |
Duas formas de integrar
1. Só marcar a parcela original como "em acordo" (mais simples)
Em vez de recriar todas as parcelas do acordo no seu sistema, você só marca (com uma flag própria) que a parcela original está vinculada a um acordo ativo. Isso já resolve a maior parte dos casos, principalmente para rematrícula: um aluno com parcelas em aberto pode estar apto a rematricular se elas estiverem vinculadas a um acordo ativo.
Conforme o aluno paga as parcelas do acordo, liquidações parciais vão sendo geradas na parcela original. Veja Liquidações para o detalhe de como identificar isso.
2. Criar as parcelas do acordo no seu sistema
Use GET /v2/acordos para listar os acordos de um período. Cada acordo traz parcelas_acordo, com id, valor, vencimento e número de cada parcela do acordo. Guarde o id da parcela de acordo: você vai precisar dele para dar baixa quando o aluno pagar.
Continue consultando o status do acordo: se ele for quebrado/cancelado, cancele as parcelas de acordo no seu sistema e volte a cobrar as parcelas originais.
Testar sem escrever código
Teste GET /v2/acordos nas Rotas da API: preencha os campos e envie direto do navegador.