Pular para o conteúdo principal
Estas operações só leem dados e precisam do escopo pfm:read. Valores em dinheiro são texto decimal com um currency_code, como "1842.90". Datas usam YYYY-MM-DD, e horários usam ISO 8601 em UTC. Os números são os mesmos que o app do Visor mostra.

Visão geral

GET /v1/spaces/{space_id}/overview traz um resumo do espaço no período financeiro atual. O período segue o dia de início do mês do espaço, não o mês do calendário. Todos os valores estão na moeda de exibição do usuário.

Cartões e faturas

GET /v1/spaces/{space_id}/cards lista os cartões de crédito visíveis do espaço, com o limite, o limite usado e as datas da fatura atual. O id do cartão é o mesmo id da conta. GET /v1/spaces/{space_id}/cards/{card_id}/bills lista as faturas de um cartão. Filtre pelo vencimento com from e to. Sem eles, a lista mostra o mês atual. Quando amount_is_estimate é true, o Visor montou o total a partir das transações sincronizadas, e o banco ainda pode mudar esse valor.

Assinaturas e contas fixas

O Visor separa as despesas recorrentes em duas listas: Cada despesa recorrente aparece em uma lista só. As duas listas mostram as despesas ativas, com o próximo vencimento e a data da última cobrança encontrada.

Parcelamentos

GET /v1/spaces/{space_id}/installment-plans lista as compras parceladas. paid_installments e total_installments são o X de N do app. Use status=completed para listar os parcelamentos que você marcou como concluídos.

Metas

GET /v1/spaces/{space_id}/goals lista as metas ativas e concluídas, com o objetivo, o valor guardado e o progresso. A reserva de emergência é uma meta com kind: emergency_fund. Filtre com status=active, completed ou archived.

Investimentos

GET /v1/spaces/{space_id}/investments lista os investimentos conectados e manuais, do maior para o menor. summary.total_value é o total na moeda de exibição e não soma os investimentos que você tirou do patrimônio.

Conexões Open Finance

GET /v1/spaces/{space_id}/connections lista as conexões bancárias que alimentam contas do espaço, com o status da sincronização e a última sincronização concluída. Quando requires_reauth é true, reconecte o banco no app do Visor.

Seu perfil e notificações

GET /v1/me traz seu nome, e-mail, idioma, moeda de exibição, plano em vigor e espaço ativo. GET /v1/notifications lista suas notificações de todos os espaços, da mais nova para a mais antiga. Use unread=true para listar só as não lidas. A lista tem páginas, como a lista de transações: passe next_cursor como after para ler a próxima página.