Clientes (Clients)

Gerencie seus clientes pessoa física e jurídica através da API.

Criar Cliente

POST /api/v1/clients

Pessoa Física

{
  "client_type": "individual",
  "full_name": "João da Silva",
  "email": "joao@example.com",
  "phone": "(11) 98765-4321",
  "cpf": "123.456.789-00"
}

Pessoa Jurídica

{
  "client_type": "company",
  "full_name": "Tech Solutions LTDA",
  "email": "contato@techsolutions.com",
  "cnpj": "12.345.678/0001-90",
  "company_name": "Tech Solutions LTDA"
}

Campos obrigatórios:

client_type - individual ou company
full_name - Nome completo/Razão social
email - Email válido

Use client_type: "individual" para pessoa física e "company" para pessoa jurídica.

Listar Clientes

GET /api/v1/clients?page=1&limit=50&search=joão

Query Parameters:

page - Número da página
limit - Itens por página (máx: 100)
client_type - Filtrar por tipo
search - Buscar por nome, email, CPF ou CNPJ
is_active - true ou false

Buscar Cliente

GET /api/v1/clients/:id

Retorna todos os dados do cliente.

Atualizar Cliente

PATCH /api/v1/clients/:id

Envie apenas os campos que deseja atualizar:

{
  "phone": "(11) 99999-9999",
  "notes": "Cliente VIP"
}

Deletar Cliente

DELETE /api/v1/clients/:id

Se o cliente tiver faturas/orçamentos vinculados, ele será apenas desativado (is_active: false) ao invés de deletado.

Clientes

On this page