Usage

Syntax

kobana <product> <resource> <method> [flags]

• <product> — banking, finance, billing, inbox, dunning or dashboards.
• <resource> — can be nested: charges, agreements installments, collection-rules steps.
• <method> — the action: list, get, create, update, delete, or an action specific to the resource.

The API version never appears in the command — the CLI resolves the URL from the embedded OpenAPI spec.

URL and query parameters go in --params; the request body goes in --json. Listings paginate with page/per_page (at most 100 per page), so --page-all walks every page on its own.

The whole surface is discoverable through --help, at every level:

kobana --help                          # products
kobana dunning --help                  # Régua de Cobrança resources
kobana dunning collection-rules --help # a resource's methods

dunning resources

Resource	Description
people	Customers
classifications	Classifications
charges	Charges
collection-rules	Collection rules
templates	Message templates
notifications	Notifications
notification-channels	Notification channels
notification-preferences	Notification preferences
email-layouts	E-mail layouts
agreements	Agreements
negotiation-campaigns	Negotiation campaigns
disputes	Disputes
negativations	Credit-bureau reports
protests	Protests
interactions	Interactions
tasks	Tasks
imports	Imports
exports	Exports
metrics	Metrics
audit-logs	Audit trail
webhook-endpoints	Webhook endpoints
me	Token identity

Each resource has a page of its own, with the full command table and examples — see the catalogue.

Examples

# A customer's overdue charges
kobana dunning charges list \
  --params '{"person_id": "PERSON_ID", "status": "overdue"}' \
  --fields "id,document_number,current_amount,due_date"

# Create a customer and a charge
kobana dunning people create --json '{"name": "Maria da Silva", "document_type": "cpf", "document_number": "12345678901"}'
kobana dunning charges create \
  --json '{"person_id": "PERSON_ID", "original_amount": 1500, "issue_date": "2026-07-01", "due_date": "2026-08-01"}'

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

# Accept an agreement and see its installments
kobana dunning agreements accept --dry-run --params '{"id": "AGREEMENT_ID"}'
kobana dunning agreements installments get --params '{"id": "AGREEMENT_ID"}'

# List with automatic pagination (NDJSON)
kobana dunning people list --page-all --fields "id,name,document_number"

# Table output
kobana dunning collection-rules list --output-format table

# Save the response to a file
kobana dunning people statement-pdf --params '{"id": "PERSON_ID"}' --output extrato.pdf

Next steps

• Schema introspection — inspect any endpoint's parameters and body.
• Global flags — every flag a command accepts.
• Helpers — +verb shortcuts for common workflows.
• Resources — the full catalogue, resource by resource.