Notificacoes

Gerencie notificacoes do sistema: faturas proximas do vencimento, pagamentos atrasados, confirmacoes e alertas. Configure preferencias de notificacao por tipo.

GET/api/notifications

Lista notificacoes com paginacao e filtros.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)
`unreadOnly`(query)	`boolean`	Nao	Apenas nao lidas
`type`(query)	`string`	Nao	bill_due_soon, bill_overdue, payment_confirmed, accountant_sent, system

bash

curl -s "https://flow.seudominio.com/api/notifications?unreadOnly=true" \
  -H "Authorization: Bearer $TOKEN" | jq .

200Lista de notificacoes

json

{
  "success": true,
  "data": {
    "notifications": [
      {
        "id": "clx...",
        "type": "bill_due_soon",
        "title": "Fatura proxima do vencimento",
        "message": "Servidor Cloud AWS vence em 3 dias (R$ 450,00)",
        "read": false,
        "createdAt": "2026-02-15T08:00:00Z"
      },
      {
        "id": "clx...",
        "type": "payment_confirmed",
        "title": "Pagamento confirmado",
        "message": "Pagamento de R$ 5.000,00 da Empresa ABC confirmado",
        "read": false,
        "createdAt": "2026-02-14T16:30:00Z"
      }
    ],
    "total": 12,
    "page": 1,
    "limit": 20
  }
}

GET/api/notifications/unread-count

Retorna a contagem de notificacoes nao lidas.

200Contagem

json

{
  "success": true,
  "data": { "unreadCount": 5 }
}

POST/api/notifications/{id}/read

Marca uma notificacao como lida.

bash

curl -X POST "https://flow.seudominio.com/api/notifications/clx123/read" \
  -H "Authorization: Bearer $TOKEN"

POST/api/notifications/read-all

Marca todas as notificacoes como lidas.

bash

curl -X POST "https://flow.seudominio.com/api/notifications/read-all" \
  -H "Authorization: Bearer $TOKEN"

DELETE/api/notifications/{id}

Remove uma notificacao.

bash

curl -X DELETE "https://flow.seudominio.com/api/notifications/clx123" \
  -H "Authorization: Bearer $TOKEN"

DELETE/api/notifications/read

Remove todas as notificacoes ja lidas.

bash

curl -X DELETE "https://flow.seudominio.com/api/notifications/read" \
  -H "Authorization: Bearer $TOKEN"

200Notificacoes removidas

json

{
  "success": true,
  "data": { "deletedCount": 8 }
}

Preferencias de Alerta

GET/api/notifications/preferences

Retorna as preferencias de alerta do usuario.

200Preferencias

json

{
  "success": true,
  "data": {
    "billDueSoon": true,
    "billOverdue": true,
    "paymentConfirmed": true,
    "accountantSent": true,
    "daysBeforeDue": 3
  }
}

PUT/api/notifications/preferences

Atualiza as preferencias de alerta.

bash

curl -X PUT "https://flow.seudominio.com/api/notifications/preferences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "billDueSoon": true,
    "billOverdue": true,
    "paymentConfirmed": false,
    "daysBeforeDue": 5
  }'