Meu Assessor Financeiro icon

Meu Assessor Financeiro

Interagir com a API do Meu Assessor Financeiro

Metas → Criar Meta

AI-generated

Summary

Cria uma meta financeira para o usuário identificado pelo telefone, enviando os dados preenchidos à API do Meu Assessor Financeiro. Informe o nome e o valor alvo; os demais campos personalizam a meta e, se aplicável, definem contribuições recorrentes.

Inputs

  • Telefone (required) — Telefone do usuário no formato E.164, como +5511999999999.
  • Nome da Meta (required) — Nome da meta; enviado à API como name.
  • Tipo da Meta — Categoria da meta: poupança, compra, viagem, investimento, reserva de emergência, quitação de dívida ou outro. O padrão é savings.
  • Valor Alvo (R$) (required) — Valor objetivo da meta, em reais; enviado como targetAmount.
  • Valor Atual (R$) — Saldo atual da meta. Só é enviado quando maior que zero.
  • Prazo — Prazo da meta; enviado como deadline quando preenchido.
  • Data de Início — Data de início; enviada como startDate quando preenchida.
  • Prioridade — Normal (0), alta (1) ou urgente (2). O padrão 0 é enviado à API.
  • Observações — Notas sobre a meta; enviadas quando preenchidas.
  • Ícone — Ícone da meta; enviado quando preenchido.
  • Cor (Hex) — Cor em hexadecimal; enviada quando preenchida.
  • Milestones (JSON) — Lista JSON de marcos com amountCents e title. Só uma lista válida e não vazia é enviada; JSON inválido é ignorado.
  • Conta da Meta (ID) — ID da conta associada à meta; enviado apenas se maior que zero.
  • Conta de Reserva (ID) — ID da conta de reserva; enviado apenas se maior que zero.
  • Frequência de Contribuição — Sem recorrência, semanal, quinzenal ou mensal. A frequência só é enviada quando não está definida como sem recorrência.
  • Dia do Mês (1-28) — Dia do mês para contribuições recorrentes; enviado se maior que zero.
  • Dia da Semana (0-6) — Dia da semana para contribuições recorrentes; enviado se for zero ou maior.
  • Valor da Contribuição (R$) — Valor de cada contribuição recorrente; enviado apenas se maior que zero.

Output shape

Um ou mais itens JSON com a resposta da API para cada item de entrada.

A chamada cria a meta por meio do webhook da API. Campos opcionais vazios ou com valor zero são em geral omitidos; a prioridade zero é preservada. Erros da API geram erro na execução, ou um item JSON com error se Continue On Fail estiver ativado.

Links

Discussion