Obter visão geral financeira
Snapshot de uma chamada: saldo bancário, dívida de cartão em aberto, patrimônio líquido, as faturas projetadas dos próximos 30 dias, o resultado do mês corrente (BRT) e o saldo previsto ancorado no saldo atual. É o gêmeo REST da ferramenta MCP visao_geral.
Authorization
bearerAuth Chave de API no cabeçalho Authorization: Bearer dz_live_...
In: header
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/overview"{ "bank_balance": 12430.55, "card_debt": 3820.14, "net_worth": 8610.41, "next_bills": [ { "projected_bill_id": "mocked-bill:b03b9565-8adb-452c-9504-10fc38c4a05c:1725148800000", "card_account_id": "01d988ff-252f-4571-abad-79e3ba56b583", "description": "Fatura Nubank", "amount": 1842.9, "due_date": "2026-09-05", "amount_is_estimate": true }, { "projected_bill_id": "mocked-bill:654d9941-f276-4cdc-81da-5f6d9f788636:1725667200000", "card_account_id": "aabeaa80-96d2-4d33-808d-a4c55a73a901", "description": "Fatura Itaú", "amount": 977.24, "due_date": "2026-09-12", "amount_is_estimate": false } ], "month": { "receitas": 8500, "despesas": 5233.71, "resultado": 3266.29 }, "saldo_previsto": { "base": 12430.55, "expected_in": 0, "committed_out": { "bills": 2820.14, "installments": 430.5, "subscriptions": 89.9, "scheduled": 0 }, "result": 9090.01, "explain": [ "Saldo atual: R$ 12.430,55", "Faturas até 31 ago: -R$ 2.820,14", "Parcelas até 31 ago: -R$ 430,50", "Assinaturas até 31 ago: -R$ 89,90", "Saldo previsto em 31 ago: R$ 9.090,01" ] }}PATCHAtualizar perfil do usuário
Atualiza campos do perfil financeiro do usuário (name, wage, monthly_living_cost, has_spouse, has_children, is_entrepreneur). Todos os campos do corpo são opcionais e anuláveis; só os enviados são alterados. Retorna o perfil atualizado (sem os blocos plan, scopes e limits). Requer escopo write.
GETListar contas
Lista todas as contas e cartões de crédito do usuário autenticado, cada um com o saldo calculado (contas arquivadas retornam saldo nulo). Retorna um objeto com a lista em `data`, ordenada por data de criação.