API

Listar alertas de conta das caixas

Condições de alerta da conta ligada ativas (ao vivo) com montantes explicativos.

Devolve condições de alerta ativas para caixas ligadas (como o aviso na app), não o estado de entrega FCM. Cada linha inclui alertSettings, linkedBalance (moeda da caixa) e activeAlerts com montantes (balanceThreshold, insufficientForPlan, creditExceedsPayment). Caixas não ligadas omitidas salvo boxId (então linked: false). Histórico → get_report.

GET/v1/list_box_account_alerts

Consulta

CampoTipoObrigatórioPredefiniçãoDescrição
budgetIdstringSim—Orçamento cujas caixas ligadas avaliar.
boxIdstringNão—Limitar a uma caixa (linked:false se não ligada).

Formato da resposta: { items }.

Resposta data

CampoTipoDescrição
itemsarrayLinhas de alerta das caixas ligadas.

Campos do item

CampoTipoDescrição
boxIdstringId da caixa de despesas.
boxNamestringNome da caixa de despesas.
linkedbooleanFalse só quando boxId foi pedido e a caixa não está ligada.
sourcestringmanual, bank ou crypto quando ligada.
alertSettingsobjectDefinições de alerta configuradas no AccountLink.
linkedBalancenumberSaldo líquido real na moeda da caixa (quando ligada).
currencystringMoeda da caixa para linkedBalance.
activeAlertsarrayAlertas atualmente ativos com montantes explicativos.

Relacionado