Documentation Index
Fetch the complete documentation index at: https://docs.garu.com.br/llms.txt
Use this file to discover all available pages before exploring further.
Visão Geral
A partir da v0.4.0, você pode manter uma agenda de clientes no seu account do Garu. É a base para os próximos recursos de cobranças agendadas e portal do cliente — mas já é útil sozinho:
- Cadastro explícito (sem precisar criar uma cobrança).
- E-mail de cobrança configurável por cliente, fixo mesmo se o cliente trocar de e-mail.
Onde fica: Acesse /clientes no menu lateral do dashboard. Pela API, use os endpoints abaixo.
Modelo de dados
Customer (registro do cliente)
document, name, email, phone, ... ← último valor visto
CustomerSellerProfile (por seller × cliente)
email, phone, ... ← último valor visto neste seller
billingEmailOverride ← e-mail fixo (opcional)
Resolução do e-mail de cobrança:
billingEmailOverride
?? CustomerSellerProfile.email
?? Customer.email
Cadastrando via dashboard
Acesse Clientes
No menu lateral, clique em Clientes.
Clique em Novo cliente
Botão Vesúvio no canto superior direito da página.
Preencha os dados
Nome completo, CPF ou CNPJ (apenas dígitos), e-mail e telefone.
Pronto
O cliente passa a aparecer na sua agenda imediatamente.
Cadastrando via API
Inclua sua chave de API no header Authorization de todas as requisições:
Authorization: Bearer sk_test_sua_chave_api
Nunca exponha sua chave de API em código frontend ou repositórios públicos.
Registrar cliente
curl -X POST https://garu.com.br/api/customers \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Maria Silva",
"document": "12345678901",
"email": "maria@exemplo.com",
"phone": "11999999999",
"personType": "fisica"
}'
{
"id": 42,
"name": "Maria Silva",
"document": "12345678901",
"email": "maria@exemplo.com",
"phone": "11999999999",
"billingEmail": "maria@exemplo.com",
"hasBillingEmailOverride": false
}
Definir um e-mail de cobrança fixo
Útil quando o cliente quer que cobranças venham para um e-mail específico (ex: financeiro@empresa.com.br):
curl -X PATCH https://garu.com.br/api/customers/42/billing-email-override \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "billingEmailOverride": "financeiro@empresa.com.br" }'
curl -X PATCH https://garu.com.br/api/customers/42/billing-email-override \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "billingEmailOverride": null }'
Listar clientes
curl "https://garu.com.br/api/customers?page=1&limit=20&search=maria" \
-H "Authorization: Bearer sk_live_xxx"
Buscar um cliente
curl https://garu.com.br/api/customers/42 \
-H "Authorization: Bearer sk_live_xxx"
Permissões
| Ação | Permissão |
|---|
| Listar / ver clientes | customer:view |
| Cadastrar cliente | customer:create |
| Atualizar cliente / e-mail de cobrança | customer:edit |
| Desvincular cliente do seller | customer:delete |
Próximos passos
- Cobranças agendadas — agende PIX/Boleto para
uma data futura para um cliente cadastrado. A Garu envia o e-mail no vencimento
e alerta seu time financeiro se atrasar.
- Em breve: portal do cliente em
/minha-area para o próprio cliente acompanhar
e pagar cobranças sem login.
