Réguas de cobrança

A régua em si: a sequência de etapas que dispara mensagens, tarefas, negativação ou protesto conforme a cobrança se aproxima do vencimento e envelhece. As etapas são gerenciadas em steps, cada uma com o gatilho (before_due, on_due, after_due + dias), a ação e os canais.

Comando	HTTP	Descrição
`collection-rules list`	`GET /v1/collection-rules`	Listar réguas
`collection-rules create`	`POST /v1/collection-rules`	Criar régua
`collection-rules get`	`GET /v1/collection-rules/{id}`	Consultar régua
`collection-rules update`	`PUT /v1/collection-rules/{id}`	Atualizar régua
`collection-rules delete`	`DELETE /v1/collection-rules/{id}`	Excluir régua
`collection-rules steps get`	`GET /v1/collection-rules/{id}/steps`	Listar etapas da régua
`collection-rules steps create`	`POST /v1/collection-rules/{id}/steps`	Criar etapa
`collection-rules steps update`	`PUT /v1/collection-rules/{id}/steps/{stepId}`	Atualizar etapa
`collection-rules steps delete`	`DELETE /v1/collection-rules/{id}/steps/{stepId}`	Excluir etapa

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.

# Listar réguas
kobana dunning collection-rules list --fields "id,name,classification_id,is_default,activated_at"

# Criar régua
kobana dunning collection-rules create \
  --json '{"name": "Régua padrão", "is_default": true}'

# Listar as etapas de uma régua
kobana dunning collection-rules steps get --params '{"id": "RULE_ID"}'

# Adicionar etapa: e-mail 3 dias antes do vencimento
kobana dunning collection-rules steps create \
  --params '{"id": "RULE_ID"}' \
  --json '{"name": "Lembrete D-3", "trigger_type": "before_due", "trigger_days": 3, "action_type": "notification", "channels": ["email"]}'

# Excluir etapa
kobana dunning collection-rules steps delete --params '{"id": "RULE_ID", "stepId": "STEP_ID"}' --dry-run

Próximos passos

Modelos de mensagem
Introspecção de schema — todos os parâmetros que este recurso aceita.

Exemplos​

Próximos passos​

Exemplos

Próximos passos