Exports
Portfolio output as CSV. charges list and people list return the file right away (up to 10,000 rows); beyond that, jobs create schedules the generation, jobs list tracks it and jobs download fetches the finished CSV.
| Command | HTTP | Description |
|---|---|---|
exports charges list | GET /v1/exports/charges | Export charges (synchronous CSV) |
exports jobs list | GET /v1/exports/jobs | List asynchronous exports |
exports jobs create | POST /v1/exports/jobs | Create asynchronous export |
exports jobs download | GET /v1/exports/jobs/{id}/download | Download export CSV |
exports people list | GET /v1/exports/people | Export customers (synchronous CSV) |
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.
# CSV of overdue charges
kobana dunning exports charges list --params '{"status": "overdue"}' --output cobrancas.csv
# Asynchronous customer export
kobana dunning exports jobs create --json '{"resource_type": "people"}'
# Download the CSV once the job finishes
kobana dunning exports jobs download --params '{"id": "JOB_ID"}' --output clientes.csv
Next steps​
- Metrics
- Schema introspection — every parameter this resource accepts.