sass-imobiliaria/.specify/features/006-client-area/contracts/me-boletos.md

1 KiB

Contract: GET /api/v1/me/boletos

Blueprint: client_bp Auth: JWT Bearer — require_auth — ClientUser only


Request

GET /api/v1/me/boletos
Authorization: Bearer <jwt_token>

Sem parâmetros de query ou corpo.


Response 200 OK

[
  {
    "id": "d5be07h8-9012-6784-d5he-4e185h88ch33",
    "description": "Aluguel referente a Maio/2026",
    "amount": "3500.00",
    "due_date": "2026-05-10",
    "status": "pending",
    "url": "https://boleto.banco.com.br/abc123"
  },
  {
    "id": "e6cf18i9-0123-7895-e6if-5f296i99di44",
    "description": "Taxa de condomínio Abril/2026",
    "amount": "450.00",
    "due_date": "2026-04-30",
    "status": "paid",
    "url": null
  }
]

Ordenado por due_date ASC (vencimentos próximos primeiro). Lista vazia [] quando sem boletos.

url é null quando o link ainda não foi preenchido pelo admin. O botão de acesso deve ser desabilitado neste caso.


Response 401 Unauthorized

{ "error": "Token inválido ou ausente" }