📋 Listagem de Contas (Backoffice)

Este documento descreve o endpoint de listagem de contas, projetado para alimentar o dashboard e a tabela principal de gestão de contas.

Endpoint: GET /backoffice/accounts

🚀 Orientações para o Front-end

1. Cards de Resumo (Stats)

Utilize o objeto summary retornado na raiz da resposta para preencher os cards superiores do dashboard.

• summary.total: Total geral de registros (independente de status).
• summary.active: Contas prontas para operação.
• summary.deleted: Contas que foram removidas (útil para auditoria ou lixeira).

2. Filtro de Bancos e Saldos

O objeto banks contém apenas os bancos que possuem saldo maior que zero.

• Utilize esta lista para preencher um componente de "Resumo de Saldos por Instituição".
• Ideal para filtros rápidos: ao clicar em um banco deste resumo, você pode disparar uma nova busca passando o bank_id.

3. Tabela Principal

Mapeamento de colunas recomendado para a tabela (data):

• Status: Utilize status.title para exibição e status.code para aplicar cores.
  • Valores possíveis para status.code:
    • ACTIVE: Conta ativa e operacional (Cor: success).
    • INACTIVE: Conta inativa temporariamente (Cor: warning).
    • SUSPENDED: Suspenso por violação de políticas (Cor: danger).
    • SOFT_DELETED: Marcado para exclusão (Cor: secondary).
    • DELETED: Conta permanentemente deletada (Cor: dark).
• Banco: Exiba bank.title.
• Saldo: Utilize balance.balance para cálculos ou exibição bruta.
• Datas: O campo created_at vem no formato ISO padrão para facilitar a formatação local usando bibliotecas como date-fns ou moment.

---

🔍 Parâmetros de Filtro

Parâmetro	Tipo	Descrição
search	string	Busca global (Nome, Doc, Conta, Agência).
status	string	Filtro por status exato (ex: ACTIVE).
bank_id	integer	Filtro por banco específico.
date_from	date	Início do período (AAAA-MM-DD).
date_to	date	Fim do período (AAAA-MM-DD).
per_page	integer	Quantidade de itens por página (default: 15).

---

📦 Estrutura de Resposta

{
    "data": [
        {
            "id": 1,
            "name": "Nome da Empresa",
            "document": "12345678000199",
            "status": {
                "code": "ACTIVE",
                "title": "Ativo"
            },
            "bank": {
                "id": 10,
                "title": "Banco do Brasil"
            },
            "balance": {
                "balance": 2500.50,
                "last_account": "..."
            },
            "agency": "0001",
            "account": "123456-7",
            "created_at": "2024-04-17T18:20:00.000000Z"
        }
    ],
    "summary": {
        "total": 150,
        "active": 140,
        "deleted": 10
    },
    "banks": [
        {
            "id": 10,
            "title": "Banco do Brasil",
            "total_balance": 2500.50
        }
    ],
    "links": { ... },
    "meta": { ... }
}