Exportações
Saída da carteira em CSV. charges list e people list respondem o arquivo na hora (até 10 mil linhas); acima disso, jobs create agenda a geração, jobs list acompanha e jobs download baixa o CSV pronto.
| Comando | HTTP | Descrição |
|---|---|---|
exports charges list | GET /v1/exports/charges | Exportar cobranças (CSV síncrono) |
exports jobs list | GET /v1/exports/jobs | Listar exportações assíncronas |
exports jobs create | POST /v1/exports/jobs | Criar exportação assíncrona |
exports jobs download | GET /v1/exports/jobs/{id}/download | Baixar CSV da exportação |
exports people list | GET /v1/exports/people | Exportar clientes (CSV síncrono) |
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.
# CSV das cobranças vencidas
kobana dunning exports charges list --params '{"status": "overdue"}' --output cobrancas.csv
# Exportação assíncrona de clientes
kobana dunning exports jobs create --json '{"resource_type": "people"}'
# Baixar o CSV quando o job terminar
kobana dunning exports jobs download --params '{"id": "JOB_ID"}' --output clientes.csv
Próximos passos
- Métricas
- Introspecção de schema — todos os parâmetros que este recurso aceita.