Clientes, eventos e consultas

Clientes, o histórico de eventos, as importações, os relatórios e as consultas de boleto e de QR Code Pix.

Clientes

Os clientes (pagadores) da conta, com busca por CPF/CNPJ e por e-mail.

Comando	HTTP	Descrição
customers list	GET /v1/customers	Listar Clientes
customers create	POST /v1/customers	Criar um Cliente
customers get	GET /v1/customers/{id}	Visualizar o Cliente
customers update	PUT /v1/customers/{id}	Atualizar Cliente
customers cnpj-cpf list	GET /v1/customers/cnpj_cpf	Busca Cliente por CNPJ/CPF
customers email list	GET /v1/customers/email	Busca Cliente por E-mail

# Listar Clientes
kobana banking customers list

# Visualizar o Cliente
kobana banking customers get --params '{"id":"CUSTOMER_ID"}'

Eventos

O histórico de eventos da conta, os mesmos que os webhooks entregam.

Comando	HTTP	Descrição
events list	GET /v1/events	Listar Eventos
events get	GET /v1/events/{id}	Informações do Evento

# Listar Eventos
kobana banking events list

# Informações do Evento
kobana banking events get --params '{"id":"EVENT_ID"}'

Importações

Importações de dados em massa.

Comando	HTTP	Descrição
imports get	GET /v1/imports/{collection_name}	Listar Importações
imports create	POST /v1/imports/{collection_name}	Importar

# Listar Importações
kobana banking imports get --params '{"collection_name":"IMPORT_COLLECTION_NAME"}'

Relatórios

Relatórios de boletos.

Comando	HTTP	Descrição
reports bank-billets list	GET /v1/reports/bank_billets	Contagem de Boletos.

# Contagem de Boletos.
kobana banking reports bank-billets list

Consultas

Consultas de boleto e de QR Code Pix de terceiros.

Comando	HTTP	Descrição
data bank-billet-queries list	GET /v2/data/bank_billet_queries	Listar Consultas de Boletos
data bank-billet-queries create	POST /v2/data/bank_billet_queries	Criar uma Consulta de Boleto
data pix-qrcode-queries list	GET /v2/data/pix_qrcode_queries	Listar Consultas de Pix QR Code
data pix-qrcode-queries create	POST /v2/data/pix_qrcode_queries	Criar uma Consulta de Pix QR Code

# Listar Consultas de Boletos
kobana banking data bank-billet-queries list

Próximos passos

• Introspecção de schema: os parâmetros e o corpo que cada comando aceita.
• Flags globais: --params, --json, --fields, --dry-run e as demais.