Docs/API Reference/Parcelamento
DashboardGitHub

O módulo de parcelamento permite simular, criar e gerenciar planos de pagamento parcelado usando Tabela Price. O agente IA pode oferecer parcelamento automaticamente durante a negociação.

Endpoints

#
MétodoEndpointDescrição
POST/api/installments/simulateSimular parcelas com taxa mensal
POST/api/installments/createCriar plano de parcelamento
POST/api/installments/:id/offerOfertar plano ao devedor via WhatsApp
POST/api/installments/:id/acceptAceitar plano (gera Pix da primeira parcela)
POST/api/installments/:id/rejectRejeitar plano
GET/api/installments/debt/:debtIdListar planos de uma dívida
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).

Simular parcelas

POST/api/installments/simulate

Calcula as parcelas usando Tabela Price com base no valor total e taxa de juros mensal. Retorna o valor de cada parcela, total de juros e valor total final.

Criar plano de parcelamento

POST/api/installments/create

Cria um plano de parcelamento vinculado a uma dívida. O plano é criado com status PENDING até ser ofertado e aceito pelo devedor.

Ofertar plano via WhatsApp

POST/api/installments/:id/offer

Envia o plano de parcelamento ao devedor via WhatsApp, incluindo valores, número de parcelas e condições. O status muda para OFFERED.

Aceitar plano

POST/api/installments/:id/accept

Registra a aceitação do plano pelo devedor e gera automaticamente o Pix da primeira parcela.

Rejeitar plano

POST/api/installments/:id/reject

Registra a rejeição do plano pelo devedor. Um novo plano pode ser criado com condições diferentes.

Listar planos de uma dívida

GET/api/installments/debt/:debtId

Retorna todos os planos de parcelamento associados a uma dívida, incluindo planos rejeitados e expirados.