Agreements

Debt renegotiations paid in installments. accept accepts a proposed agreement and creates its installments, cancel cancels it with a reason, pdf downloads the agreement term, and installments lists the installments and records each one's payment.

Command	HTTP	Description
agreements list	GET /v1/agreements	List agreements
agreements create	POST /v1/agreements	Create agreement
agreements get	GET /v1/agreements/{id}	Get agreement
agreements update	PUT /v1/agreements/{id}	Update agreement
agreements delete	DELETE /v1/agreements/{id}	Delete agreement
agreements accept	POST /v1/agreements/{id}/accept	Accept agreement
agreements cancel	POST /v1/agreements/{id}/cancel	Cancel agreement
agreements pdf	GET /v1/agreements/{id}/pdf	Agreement term (PDF)
agreements installments get	GET /v1/agreements/{id}/installments	List agreement installments
agreements installments update	PUT /v1/agreements/{id}/installments	Update agreement installment

Examples

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# Active agreements
kobana dunning agreements list \
  --params '{"status": "active"}' \
  --fields "id,person_id,final_total,number_of_installments,status"

# Propose a 6-installment agreement
kobana dunning agreements create \
  --json '{"person_id": "PERSON_ID", "original_total": 1500, "number_of_installments": 6, "first_due_date": "2026-08-01"}'

# Accept an agreement
kobana dunning agreements accept --params '{"id": "AGREEMENT_ID"}' --json '{"terms_accepted": true}'

# Agreement installments
kobana dunning agreements installments get --params '{"id": "AGREEMENT_ID"}'

# Record payment of the 1st installment
kobana dunning agreements installments update \
  --params '{"id": "AGREEMENT_ID"}' \
  --json '{"installment_number": 1, "paid_amount": 250, "paid_at": "2026-08-01", "status": "paid"}'

# Agreement term as PDF
kobana dunning agreements pdf --params '{"id": "AGREEMENT_ID"}' --output acordo.pdf

# Cancel an agreement
kobana dunning agreements cancel \
  --params '{"id": "AGREEMENT_ID"}' \
  --json '{"reason": "Cliente desistiu"}' --dry-run

Next steps

• Negotiation campaigns
• Schema introspection — every parameter this resource accepts.