Charges

Each customer's receivables — what the collection rule chases. notify sends a manual notification outside the rule, settlement-pdf produces the settlement letter (paid charges only), and the bulk-* commands archive, cancel or assign a rule to up to 100 charges per call.

Command	HTTP	Description
charges list	GET /v1/charges	List charges
charges create	POST /v1/charges	Create charge
charges get	GET /v1/charges/{id}	Get charge
charges update	PUT /v1/charges/{id}	Update charge
charges delete	DELETE /v1/charges/{id}	Delete charge
charges notify	POST /v1/charges/{id}/notify	Notify charge
charges settlement-pdf	GET /v1/charges/{id}/settlement-pdf	Settlement letter (PDF)
charges bulk-archive create	POST /v1/charges/bulk-archive	Bulk-archive charges
charges bulk-assign-rule create	POST /v1/charges/bulk-assign-rule	Bulk-assign a collection rule
charges bulk-cancel create	POST /v1/charges/bulk-cancel	Bulk-cancel charges

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.

# Overdue charges
kobana dunning charges list \
  --params '{"status": "overdue", "per_page": 100}' \
  --fields "id,person_id,document_number,current_amount,due_date"

# Create a charge
kobana dunning charges create \
  --json '{"person_id": "PERSON_ID", "original_amount": 1500, "issue_date": "2026-07-01", "due_date": "2026-08-01"}'

# Notify manually by e-mail
kobana dunning charges notify \
  --params '{"id": "CHARGE_ID"}' \
  --json '{"channel": "email", "recipient": "maria@exemplo.com.br", "subject": "Lembrete", "body": "Sua cobrança vence amanhã."}'

# Settlement letter as PDF
kobana dunning charges settlement-pdf --params '{"id": "CHARGE_ID"}' --output quitacao.pdf

# Assign a rule to several charges
kobana dunning charges bulk-assign-rule create \
  --json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"], "collection_rule_id": "RULE_ID"}'

# Bulk-cancel charges
kobana dunning charges bulk-cancel create \
  --json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"]}' --dry-run

Next steps

• Collection rules
• Schema introspection — every parameter this resource accepts.