Referência de ferramentas
Esta página é uma referência para conferência. No uso diário, o planejador não precisa decorar os nomes: basta explicar o resultado desejado ao assistente.
Status revisado
Carteira e seleção do cliente
| Consulta | Resultado para o planejador |
|---|---|
listar_clientes | Clientes vinculados à conta profissional. |
obter_cliente | Identificação do cliente escolhido. |
listar_estruturas_planejador | Estruturas disponíveis na carteira. |
obter_sessao_cliente | Resumo financeiro do cliente selecionado. |
Estrutura do cliente
| Consulta | Resultado para o planejador |
|---|---|
listar_pessoas_cliente | Pessoas da estrutura. |
listar_projetos_cliente | Projetos vinculados. |
listar_contas_cliente | Contas. |
listar_cartoes_cliente | Cartões de crédito. |
listar_categorias_cliente | Categorias de lançamentos. |
listar_conceitos_categoria_cliente | Conceitos da categoria selecionada. |
obter_uso_taxonomia_cliente | Uso, limite, saldo e estado legado de categorias e caixas. |
listar_caixas_cliente | Caixas de organização. |
listar_lancamentos_cliente | Lançamentos, com filtros e limite. |
listar_investimentos_cliente | Investimentos manuais e importados em formato protegido. |
listar_objetivos_cliente | Objetivos. |
listar_realizacoes_cliente | Realizações. |
listar_metas_cliente | Metas. |
listar_ciclos_cliente | Ciclos calculados das metas. |
listar_projecoes_cliente | Projeções patrimoniais. |
listar_documentos_cliente | Informações permitidas dos documentos. |
listar_anexos_cliente | Informações permitidas dos anexos. |
listar_openfinance_cliente | Conexões Open Finance sem tokens ou conteúdo bruto. |
listar_b3_cliente | Autorizações B3 com documentos protegidos. |
listar_agentes_cliente | Agentes ligados ao cliente. |
listar_lembretes_cliente | Lembretes ligados ao cliente. |
Análises do Estúdio
| Consulta | Resultado para o planejador |
|---|---|
analisar_fluxo_caixa_cliente | Totais mensais de entradas, saídas e outros movimentos. |
analisar_categorizacao_cliente | Distribuição dos lançamentos por categoria. |
analisar_distribuicao_cliente | Distribuição dos lançamentos por caixa. |
analisar_patrimonio_cliente | Visão patrimonial consolidada. |
listar_previdencia_social_cliente | Análises previdenciárias disponíveis. |
obter_matriz_previdenciaria_cliente | Disponibilidade da matriz previdenciária. |
analisar_cnis_cliente | Disponibilidade da análise do CNIS. |
analisar_restituicao_cliente | Dados previdenciários disponíveis para restituição. |
analisar_protecao_renda_cliente | Base patrimonial e previdenciária para proteção de renda. |
analisar_otimizacao_prolabore_cliente | Disponibilidade do cálculo previdenciário de pró-labore. |
Consultoria
| Consulta | Resultado para o planejador |
|---|---|
listar_contatos_consultoria | Contatos da consultoria. |
listar_pipeline_consultoria | Contatos e atendimentos do pipeline. |
listar_atendimentos_consultoria | Atendimentos. |
listar_agentes_consultoria | Agentes do planejador. |
listar_lembretes_consultoria | Lembretes do planejador. |
Conta, aparência e catálogos
| Consulta | Resultado para o planejador |
|---|---|
obter_conta_planejador | Dados públicos permitidos da conta profissional. |
listar_assinaturas_planejador | Assinaturas sem identificadores sensíveis. |
obter_configuracao_usuario_planejador | Preferências do planejador. |
listar_catalogo_categorias_planejador | Catálogo de categorias. |
listar_catalogo_caixas_planejador | Catálogo de caixas. |
listar_catalogo_templates_planejador | Templates de estrutura. |
listar_conceitos_categoria_catalogo_planejador | Conceitos da categoria selecionada no catálogo. |
listar_tipos_planejador | Tipos configurados. |
obter_aparencia_planejador | Aparência e marca em formato público. |
Marketplace e atendimento
| Consulta | Resultado para o planejador |
|---|---|
listar_lojas_planejador | Lojas. |
listar_ofertas_planejador | Ofertas. |
listar_paginas_loja_planejador | Páginas e seções das lojas. |
listar_linhas_virtuais_planejador | Linhas virtuais com números protegidos. |
listar_contas_whatsapp_planejador | Contas WhatsApp Business sem identificadores sensíveis. |
listar_chats_atendimento_planejador | Chats de atendimento. |
Office
| Consulta | Resultado para o planejador |
|---|---|
listar_afiliados_office | Afiliados. |
listar_filiadas_office | Filiadas. |
obter_indicadores_atividade_office | Indicadores de atividade. |
Manutenção ativa da taxonomia do cliente
Todas estas ferramentas exigem clienteUsuarioId, validam o vínculo com o planejador autenticado e usam o escopo clientes:write.
| Ferramenta | Ação real |
|---|---|
criar_categoria_cliente | Criar categoria na estrutura do cliente. |
atualizar_categoria_cliente | Atualizar nome, cor, extensão ou conceitos da categoria. |
remover_categoria_cliente | Remover categoria sem dependências; exige confirmar=true. |
criar_conceito_categoria_cliente | Criar conceito em uma categoria. |
atualizar_conceito_categoria_cliente | Atualizar um conceito. |
remover_conceito_categoria_cliente | Remover um conceito; exige confirmar=true. |
criar_caixa_cliente | Criar caixa com IDs de categorias do mesmo cliente. |
atualizar_caixa_cliente | Atualizar caixa e seus vínculos de categorias. |
remover_caixa_cliente | Remover caixa sem dependências; exige confirmar=true. |
Limites da estrutura: 130 categorias, 30 caixas e 100 conceitos por categoria. Cada conceito aceita até 80 caracteres no nome e 300 na definição. obter_uso_taxonomia_cliente deve ser usado antes de criações.
Manutenção ativa do catálogo da consultoria
Estas ferramentas atuam no catálogo do planejador autenticado e usam clientes:write. Não recebem clienteUsuarioId.
| Ferramenta | Ação real |
|---|---|
criar_categoria_catalogo_planejador | Criar categoria do catálogo. |
atualizar_categoria_catalogo_planejador | Atualizar categoria do catálogo. |
remover_categoria_catalogo_planejador | Remover categoria sem caixas dependentes; exige confirmar=true. |
criar_conceito_categoria_catalogo_planejador | Criar conceito em categoria do catálogo. |
atualizar_conceito_categoria_catalogo_planejador | Atualizar conceito do catálogo. |
remover_conceito_categoria_catalogo_planejador | Remover conceito; exige confirmar=true. |
criar_caixa_catalogo_planejador | Criar caixa usando IDs de categorias do catálogo. |
atualizar_caixa_catalogo_planejador | Atualizar caixa e seus vínculos de categorias. |
remover_caixa_catalogo_planejador | Remover caixa sem templates dependentes; exige confirmar=true. |
criar_template_catalogo_planejador | Criar template usando IDs de caixas do catálogo. |
atualizar_template_catalogo_planejador | Atualizar template e seus vínculos de caixas. |
remover_template_catalogo_planejador | Remover template sem configurações, contatos ou convites dependentes; exige confirmar=true. |
O catálogo não tem limite total de categorias ou caixas. Cada categoria tem no máximo 100 conceitos, com nomes de até 80 caracteres e definições de até 300. Os contratos de escrita aceitam somente campos públicos e relações por IDs canônicos do mesmo catálogo.
Conflitos esperados
As manutenções de taxonomia retornam isError: true com conteúdo estruturado quando a operação não pode ser executada:
| Código | Motivo |
|---|---|
limite_taxonomia_excedido | A projeção excede a cota sem reduzir o estado atual. |
nome_duplicado | Nome equivalente já existe no contexto. |
referencia_fora_escopo | Cliente, categoria, caixa ou template não pertence ao contexto autorizado. |
entidade_em_uso | Uma remoção possui dependências. |
Nenhum desses conflitos deve ser tratado como confirmação de sucesso. Consulte o estado novamente antes de repetir uma operação.
O que pode aparecer, mas ainda não executa
Além das 24 ferramentas de taxonomia listadas acima, o catálogo do conector contém ações preparadas para futuras integrações. Estão pendentes as mutações de pessoas, projetos, contas, cartões, lançamentos, investimentos, objetivos, realizações, metas, projeções, documentos, anexos, conexões financeiras, contatos, convites, mensagens, atendimentos, agentes, lembretes, lojas, ofertas, páginas, linhas, WhatsApp, cobranças e uploads.
Essas ações retornam executada=false. O mesmo vale para:
consultar_bcb;consultar_anbima.
Se o assistente sugerir uma delas, peça:
Confirme se a ferramenta pertence à manutenção ativa da taxonomia.
Se não pertencer, não a chame e transforme a intenção
em um passo a passo para eu executar na Rica Pro.
Prompt para conferir uma resposta
Para cada conclusão, diga qual consulta da Rica Pro forneceu o dado.
Separe dado observado, interpretação e pergunta para o cliente.