Acordos

Renegociações de dívida em parcelas. accept aceita um acordo proposto e gera as parcelas, cancel cancela com motivo, pdf baixa o termo de acordo, e installments lista as parcelas e registra o pagamento de cada uma.

Comando	HTTP	Descrição
agreements list	GET /v1/agreements	Listar acordos
agreements create	POST /v1/agreements	Criar acordo
agreements get	GET /v1/agreements/{id}	Consultar acordo
agreements update	PUT /v1/agreements/{id}	Atualizar acordo
agreements delete	DELETE /v1/agreements/{id}	Excluir acordo
agreements accept	POST /v1/agreements/{id}/accept	Aceitar acordo
agreements cancel	POST /v1/agreements/{id}/cancel	Cancelar acordo
agreements pdf	GET /v1/agreements/{id}/pdf	Termo de acordo (PDF)
agreements installments get	GET /v1/agreements/{id}/installments	Listar parcelas do acordo
agreements installments update	PUT /v1/agreements/{id}/installments	Atualizar parcela do acordo

Exemplos

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

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

# Propor acordo em 6 parcelas
kobana dunning agreements create \
  --json '{"person_id": "PERSON_ID", "original_total": 1500, "number_of_installments": 6, "first_due_date": "2026-08-01"}'

# Aceitar acordo
kobana dunning agreements accept --params '{"id": "AGREEMENT_ID"}' --json '{"terms_accepted": true}'

# Parcelas do acordo
kobana dunning agreements installments get --params '{"id": "AGREEMENT_ID"}'

# Registrar o pagamento da 1ª parcela
kobana dunning agreements installments update \
  --params '{"id": "AGREEMENT_ID"}' \
  --json '{"installment_number": 1, "paid_amount": 250, "paid_at": "2026-08-01", "status": "paid"}'

# Termo de acordo em PDF
kobana dunning agreements pdf --params '{"id": "AGREEMENT_ID"}' --output acordo.pdf

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

Próximos passos

• Campanhas de negociação
• Introspecção de schema — todos os parâmetros que este recurso aceita.