Acuerdos
Renegociaciones de deuda en cuotas. accept acepta un acuerdo propuesto y genera las cuotas, cancel lo cancela con motivo, pdf descarga el término de acuerdo, e installments lista las cuotas y registra el pago de cada una.
| Comando | HTTP | Descripción |
|---|---|---|
agreements list | GET /v1/agreements | Listar acuerdos |
agreements create | POST /v1/agreements | Crear acuerdo |
agreements get | GET /v1/agreements/{id} | Consultar acuerdo |
agreements update | PUT /v1/agreements/{id} | Actualizar acuerdo |
agreements delete | DELETE /v1/agreements/{id} | Eliminar acuerdo |
agreements accept | POST /v1/agreements/{id}/accept | Aceptar acuerdo |
agreements cancel | POST /v1/agreements/{id}/cancel | Cancelar acuerdo |
agreements pdf | GET /v1/agreements/{id}/pdf | Término de acuerdo (PDF) |
agreements installments get | GET /v1/agreements/{id}/installments | Listar cuotas del acuerdo |
agreements installments update | PUT /v1/agreements/{id}/installments | Actualizar cuota del acuerdo |
Ejemplos
--params lleva parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.
# Acuerdos activos
kobana dunning agreements list \
--params '{"status": "active"}' \
--fields "id,person_id,final_total,number_of_installments,status"
# Proponer acuerdo en 6 cuotas
kobana dunning agreements create \
--json '{"person_id": "PERSON_ID", "original_total": 1500, "number_of_installments": 6, "first_due_date": "2026-08-01"}'
# Aceptar acuerdo
kobana dunning agreements accept --params '{"id": "AGREEMENT_ID"}' --json '{"terms_accepted": true}'
# Cuotas del acuerdo
kobana dunning agreements installments get --params '{"id": "AGREEMENT_ID"}'
# Registrar el pago de la 1.ª cuota
kobana dunning agreements installments update \
--params '{"id": "AGREEMENT_ID"}' \
--json '{"installment_number": 1, "paid_amount": 250, "paid_at": "2026-08-01", "status": "paid"}'
# Término de acuerdo en PDF
kobana dunning agreements pdf --params '{"id": "AGREEMENT_ID"}' --output acordo.pdf
# Cancelar acuerdo
kobana dunning agreements cancel \
--params '{"id": "AGREEMENT_ID"}' \
--json '{"reason": "Cliente desistiu"}' --dry-run
Próximos pasos
- Campañas de negociación
- Introspección de schema — todos los parámetros que acepta este recurso.