> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.wbudget.app/w-budget/clientes/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.wbudget.app/_mcp/server. # Overview O **cliente** é quem recebe a proposta. Cada cliente tem um cadastro (nome, documento, contato, endereço, campos personalizados) e uma lista de **contatos**, dos quais um pode ser o principal. Toda oportunidade aponta para um cliente pelo campo `client`. ## Rotas | Método | Rota | Para quê | | -------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `GET` | `/clients` | [Listar clientes](/w-budget/clientes/listar-clientes) acessíveis ao usuário. | | `POST` | `/clients` | [Criar cliente](/w-budget/clientes/criar-cliente); só `name` é obrigatório. | | `GET` | `/clients/{id}` | [Detalhar cliente](/w-budget/clientes/detalhar-cliente): cadastro, contatos e resumo comercial. | | `PATCH` | `/clients/{id}` | [Atualizar cliente](/w-budget/clientes/atualizar-cliente), inclusive o contato principal via `main_contact`. | | `DELETE` | `/clients/{id}` | [Remover cliente](/w-budget/clientes/remover-cliente) sem histórico vinculado. | | `POST` | `/clients/{id}/contacts` | [Adicionar contato ao cliente](/w-budget/clientes/adicionar-contato-ao-cliente). | | `PUT` | `/clients/{id}/contacts/{contactId}` | [Atualizar contato do cliente](/w-budget/clientes/atualizar-contato-do-cliente). | | `DELETE` | `/clients/{id}/contacts/{contactId}` | [Remover contato do cliente](/w-budget/clientes/remover-contato-do-cliente). | ## Fluxo típico 1. Procure o cliente em `GET /clients`; se não existir, crie com `POST /clients`. 2. Use o `id` retornado no campo `client` ao [criar a oportunidade](/w-budget/oportunidades/criar-oportunidade). 3. Para mais pessoas de contato, use `POST /clients/{id}/contacts`. O ID do contato criado aparece na lista `contacts` da resposta. ## Cuidados * **`PATCH` do cliente preserva o que não vier.** Campos omitidos, nulos ou vazios mantêm o valor atual. * **`PUT` do contato substitui o contato.** Envie todos os dados que quer manter; campos omitidos podem virar vazio ou padrão. * **Contato principal.** `main=1` torna o contato principal; `main=0` retira a indicação. `main` e `active` são numéricos (`0` ou `1`). * **Documento como texto.** Envie `national_id` como string, para não perder zeros à esquerda. * **Exclusão só sem histórico.** Cliente com propostas ou atividades vinculadas não pode ser excluído (HTTP 409). * **Campos personalizados.** `metadata` segue as definições da conta; consulte [Campos customizados](/w-budget/campos-customizados). ## API Docs - [Listar clientes](https://developers.wbudget.app/w-budget/clientes/listar-clientes.md): Clientes - [Criar cliente](https://developers.wbudget.app/w-budget/clientes/criar-cliente.md): Clientes - [Detalhar cliente](https://developers.wbudget.app/w-budget/clientes/detalhar-cliente.md): Clientes - [Remover cliente](https://developers.wbudget.app/w-budget/clientes/remover-cliente.md): Clientes - [Atualizar cliente](https://developers.wbudget.app/w-budget/clientes/atualizar-cliente.md): Clientes - [Adicionar contato ao cliente](https://developers.wbudget.app/w-budget/clientes/adicionar-contato-ao-cliente.md): Clientes - [Atualizar contato do cliente](https://developers.wbudget.app/w-budget/clientes/atualizar-contato-do-cliente.md): Clientes - [Remover contato do cliente](https://developers.wbudget.app/w-budget/clientes/remover-contato-do-cliente.md): Clientes ## OpenAPI Specification - [OpenAPI JSON](https://developers.wbudget.app/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://developers.wbudget.app/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format