> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.wbudget.app/w-budget/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.wbudget.app/_mcp/server. # WBudget Api ## Começar 1. Configure `baseUrl` com o endereço base da API, com `/api/v1` e sem barra final. Padrão: `https://wbudget.app/api/v1`. 2. Configure `token` com seu token da API **WBudget**. A chave da API do Postman não autentica chamadas ao WBudget. 3. Consulte empresas, clientes, produtos, modelos e funis para obter IDs válidos. 4. Abra uma requisição, substitua os IDs fictícios e envie. Ative em **Params** os filtros opcionais desejados. Base das requisições: `{{baseUrl}}`. ## Autenticação e acesso Todas as requisições desta collection herdam a autenticação Bearer: `Authorization: Bearer {{token}}` O acesso depende das permissões do usuário e dos recursos habilitados na conta. Importação de oportunidades e listagem de responsáveis exigem permissão administrativa. Use variáveis locais ou de ambiente para credenciais. ## Requisições e respostas Envie corpos JSON com `Content-Type: application/json`. As respostas de sucesso usam `{ "data": ... }`: listas retornam arrays, consultas individuais retornam objetos e gravações podem retornar IDs ou o recurso atualizado. O download de PDF retorna `application/pdf`. Os exemplos são fictícios e ilustram os campos principais, sem representar dados reais de uma conta. Identificadores numéricos devem ser substituídos por IDs válidos. Datas de entrada usam `YYYY-MM-DD` ou `YYYY-MM-DD HH:mm:ss` conforme o campo. Datas de resposta podem conter horário e fuso; preserve o deslocamento informado. Valores monetários são números JSON, sem símbolos de moeda. Campos sem valor podem ser nulos. Estados comerciais: `pending` (em aberto), `earned` (ganha), `lost` (perdida). A etapa do funil é identificada pelo campo `status`. Atividades usam seus próprios estados, como `open`, `late` e `done`. ## Erros ```json { "error": { "message": "Client not found.", "code": "CLIENT_NOT_FOUND" } } ``` Use o status HTTP e `error.code` para tratar falhas; o texto de `error.message` pode variar. Validações podem incluir `error.validation_errors` com detalhes por campo. | HTTP | Significado | | ---- | ------------------------------------------------------ | | 200 | Consulta ou alteração concluída. | | 201 | Criação ou importação concluída. | | 400 | Requisição não processada; consulte o código do erro. | | 401 | Falha de autenticação ou acesso negado. | | 404 | Recurso não encontrado ou indisponível para o usuário. | | 405 | Método não permitido para a rota. | | 409 | Conflito, como exclusão de cliente com histórico. | | 422 | Dados inválidos ou obrigatórios ausentes. | | 500 | Falha ao processar a solicitação. | | 502 | Falha ao gerar o PDF. | ## Fluxo de exemplo Consulte os cadastros → crie ou selecione um cliente → crie uma oportunidade → adicione itens → agende atividades → mova a etapa → obtenha o PDF. Para importar cliente e itens em uma única chamada, use `POST /budgets/import`. ## Docs - [Overview](https://developers.wbudget.app/w-budget/oportunidades.md) - [Overview](https://developers.wbudget.app/w-budget/clientes.md) - [Overview](https://developers.wbudget.app/w-budget/atividades.md) - [Overview](https://developers.wbudget.app/w-budget/crm.md) - [Overview](https://developers.wbudget.app/w-budget/funis.md) - [Overview](https://developers.wbudget.app/w-budget/etapas.md) - [Overview](https://developers.wbudget.app/w-budget/relatorios.md) - [Overview](https://developers.wbudget.app/w-budget/empresas.md) - [Overview](https://developers.wbudget.app/w-budget/produtos-e-servicos.md) - [Overview](https://developers.wbudget.app/w-budget/modelos.md) - [Overview](https://developers.wbudget.app/w-budget/responsaveis.md) - [Overview](https://developers.wbudget.app/w-budget/campos-customizados.md) ## API Docs - [Listar oportunidades](https://developers.wbudget.app/w-budget/oportunidades/listar-oportunidades.md): WBudget > Oportunidades - [Criar oportunidade](https://developers.wbudget.app/w-budget/oportunidades/criar-oportunidade.md): WBudget > Oportunidades - [Importar oportunidade completa](https://developers.wbudget.app/w-budget/oportunidades/importar-oportunidade-completa.md): WBudget > Oportunidades - [Detalhar oportunidade](https://developers.wbudget.app/w-budget/oportunidades/detalhar-oportunidade.md): WBudget > Oportunidades - [Atualizar oportunidade](https://developers.wbudget.app/w-budget/oportunidades/atualizar-oportunidade.md): WBudget > Oportunidades - [Mover oportunidade de etapa](https://developers.wbudget.app/w-budget/oportunidades/mover-oportunidade-de-etapa.md): WBudget > Oportunidades - [Baixar PDF da oportunidade](https://developers.wbudget.app/w-budget/oportunidades/baixar-pdf-da-oportunidade.md): WBudget > Oportunidades - [Listar itens da oportunidade](https://developers.wbudget.app/w-budget/oportunidades/listar-itens-da-oportunidade.md): WBudget > Oportunidades - [Adicionar itens do catalogo](https://developers.wbudget.app/w-budget/oportunidades/adicionar-itens-do-catalogo.md): WBudget > Oportunidades - [Editar item da oportunidade](https://developers.wbudget.app/w-budget/oportunidades/editar-item-da-oportunidade.md): WBudget > Oportunidades - [Remover item da oportunidade](https://developers.wbudget.app/w-budget/oportunidades/remover-item-da-oportunidade.md): WBudget > Oportunidades - [Incluir ou excluir item do total](https://developers.wbudget.app/w-budget/oportunidades/incluir-ou-excluir-item-do-total.md): WBudget > Oportunidades - [Listar clientes](https://developers.wbudget.app/w-budget/clientes/listar-clientes.md): WBudget > Clientes - [Criar cliente](https://developers.wbudget.app/w-budget/clientes/criar-cliente.md): WBudget > Clientes - [Detalhar cliente](https://developers.wbudget.app/w-budget/clientes/detalhar-cliente.md): WBudget > Clientes - [Remover cliente](https://developers.wbudget.app/w-budget/clientes/remover-cliente.md): WBudget > Clientes - [Atualizar cliente](https://developers.wbudget.app/w-budget/clientes/atualizar-cliente.md): WBudget > Clientes - [Adicionar contato ao cliente](https://developers.wbudget.app/w-budget/clientes/adicionar-contato-ao-cliente.md): WBudget > Clientes - [Atualizar contato do cliente](https://developers.wbudget.app/w-budget/clientes/atualizar-contato-do-cliente.md): WBudget > Clientes - [Remover contato do cliente](https://developers.wbudget.app/w-budget/clientes/remover-contato-do-cliente.md): WBudget > Clientes - [Listar atividades](https://developers.wbudget.app/w-budget/atividades/listar-atividades.md): WBudget > Atividades - [Criar atividade](https://developers.wbudget.app/w-budget/atividades/criar-atividade.md): WBudget > Atividades - [Alterar status da atividade](https://developers.wbudget.app/w-budget/atividades/alterar-status-da-atividade.md): WBudget > Atividades - [Reagendar atividade](https://developers.wbudget.app/w-budget/atividades/reagendar-atividade.md): WBudget > Atividades - [Mover atividade de etapa](https://developers.wbudget.app/w-budget/atividades/mover-atividade-de-etapa.md): WBudget > Atividades - [Listar tipos de atividade](https://developers.wbudget.app/w-budget/atividades/listar-tipos-de-atividade.md): WBudget > Atividades - [Carregar kanban do funil](https://developers.wbudget.app/w-budget/crm/carregar-kanban-do-funil.md): WBudget > Crm - [Listar funis](https://developers.wbudget.app/w-budget/funis/listar-funis.md): WBudget > Funis - [Detalhar funil](https://developers.wbudget.app/w-budget/funis/detalhar-funil.md): WBudget > Funis - [Formulario da etapa](https://developers.wbudget.app/w-budget/etapas/formulario-da-etapa.md): WBudget > Etapas - [Relatorio de faturamento](https://developers.wbudget.app/w-budget/relatorios/relatorio-de-faturamento.md): WBudget > Relatorios - [Listar empresas](https://developers.wbudget.app/w-budget/empresas/listar-empresas.md): WBudget > Empresas - [Listar produtos e servicos](https://developers.wbudget.app/w-budget/produtos-e-servicos/listar-produtos-e-servicos.md): WBudget > Produtos E Servicos - [Criar produto ou serviço](https://developers.wbudget.app/w-budget/produtos-e-servicos/criar-produto-ou-servi-o.md): WBudget > Produtos E Servicos - [Consultar produto ou serviço](https://developers.wbudget.app/w-budget/produtos-e-servicos/consultar-produto-ou-servi-o.md): WBudget > Produtos E Servicos - [Atualizar produto ou serviço](https://developers.wbudget.app/w-budget/produtos-e-servicos/atualizar-produto-ou-servi-o.md): WBudget > Produtos E Servicos - [Excluir produto ou serviço](https://developers.wbudget.app/w-budget/produtos-e-servicos/excluir-produto-ou-servi-o.md): WBudget > Produtos E Servicos - [Listar modelos de oportunidade](https://developers.wbudget.app/w-budget/modelos/listar-modelos-de-oportunidade.md): WBudget > Modelos - [Listar responsaveis](https://developers.wbudget.app/w-budget/responsaveis/listar-responsaveis.md): WBudget > Responsaveis - [Listar campos customizados](https://developers.wbudget.app/w-budget/campos-customizados/listar-campos-customizados.md): WBudget > Campos Customizados ## 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