Clientes

A carteira: os devedores (pessoas físicas ou jurídicas) a quem as cobranças pertencem. statement-pdf gera o extrato do devedor, bulk-archive create arquiva até 100 clientes de uma vez, e os canais de contato de cada um (e-mail, telefone, WhatsApp, endereço) vivem em contact-points.

Comando	HTTP	Descrição
people list	GET /v1/people	Listar clientes
people create	POST /v1/people	Criar cliente
people get	GET /v1/people/{id}	Consultar cliente
people update	PUT /v1/people/{id}	Atualizar cliente
people delete	DELETE /v1/people/{id}	Excluir cliente
people statement-pdf	GET /v1/people/{id}/statement-pdf	Extrato do devedor (PDF)
people bulk-archive create	POST /v1/people/bulk-archive	Arquivar clientes em massa
people contact-points list	GET /v1/people/{id}/contact-points	Listar pontos de contato
people contact-points create	POST /v1/people/{id}/contact-points	Criar ponto de contato
people contact-points update	PATCH /v1/people/{id}/contact-points/{cpId}	Atualizar ponto de contato
people contact-points delete	DELETE /v1/people/{id}/contact-points/{cpId}	Excluir ponto de contato

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.

# Listar clientes
kobana dunning people list \
  --params '{"search": "Silva", "per_page": 50}' \
  --fields "id,name,document_number,classification_id"

# Criar cliente
kobana dunning people create \
  --json '{"name": "Maria da Silva", "document_type": "cpf", "document_number": "12345678901"}'

# Extrato do devedor em PDF
kobana dunning people statement-pdf --params '{"id": "PERSON_ID"}' --output extrato.pdf

# Adicionar um ponto de contato
kobana dunning people contact-points create \
  --params '{"id": "PERSON_ID"}' \
  --json '{"channel": "whatsapp", "value": "+5511999990000", "is_primary": true}'

# Arquivar clientes em massa
kobana dunning people bulk-archive create \
  --json '{"ids": ["PERSON_ID_1", "PERSON_ID_2"]}' --dry-run

Próximos passos

• Classificações
• Introspecção de schema — todos os parâmetros que este recurso aceita.