Classifications
The portfolio segments (good payer, recurring, high risk…). Every customer belongs to one classification, and the classification decides which collection rule applies to them.
| Command | HTTP | Description |
|---|---|---|
classifications list | GET /v1/classifications | List classifications |
classifications create | POST /v1/classifications | Create classification |
classifications get | GET /v1/classifications/{id} | Get classification |
classifications update | PUT /v1/classifications/{id} | Update classification |
classifications delete | DELETE /v1/classifications/{id} | Delete classification |
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.
# List classifications
kobana dunning classifications list --fields "id,name,code,is_default,priority"
# Create a classification
kobana dunning classifications create \
--json '{"name": "Bom pagador", "code": "good_payer"}'
# Delete a classification
kobana dunning classifications delete --params '{"id": "CLASSIFICATION_ID"}' --dry-run
Next steps
- Charges
- Schema introspection — every parameter this resource accepts.