🏦 Gestão de Contas Bancárias (Backoffice)

Endpoints para monitoramento de contas bancárias e saldos.

Listagem e Dashboard

Para detalhes sobre a listagem de contas, filtros e metadados de resumo para o dashboard, consulte o documento específico: 👉 Listagem de Contas e Orientações Front-end

---

Atualizar Conta

Atualiza os dados de uma conta bancária.

Endpoint: PUT /backoffice/accounts/\{id\}

Parâmetros (Form Data / JSON)

Caminho	Tipo	Descrição
name	string	Nome da conta.
document	string	CPF ou CNPJ.
status	string	Novo status da conta.
bank_id	integer	ID do banco vinculado.
agency	string	Agência bancária.
account	string	Número da conta.

---

Detalhar Conta

Retorna dados completos da conta, incluindo endereço, usuários vinculados e estatísticas de movimentação.

Endpoint: GET /backoffice/accounts/\{id\}

Resposta (Estrutura)

{
    "data": {
        "id": 1,
        "name": "Nome da Conta",
        "users": [
            {
                "id": 10,
                "name": "João Silva",
                "roles": { "id": 1, "name": "Admin" }
            }
        ],
        "balance": {
            "current": 1500.50,
            "total_balance": 150050,
            "formatted_balance": "R$ 1.500,50"
        }
    },
    "stats": {
        "transactions": {
            "total_count": 500
        },
        "charges": {
            "total_count": 120,
            "total_value": 45000.00,
            "total_paid": 38000.00,
            "by_status": [
                {
                    "status": "PAGO",
                    "count": 80,
                    "value": 38000.00
                },
                {
                    "status": "PENDENTE",
                    "count": 40,
                    "value": 7000.00
                }
            ]
        }
    }
}

---

Consultar Saldo

Consulta o saldo atual consolidado de uma conta.

Endpoint: GET /backoffice/accounts/\{id\}/balance

Resposta

{
    "account_id": 1,
    "name": "Empresa Exemplo",
    "balance": 1500.50,
    "total_balance": 150050,
    "formatted_balance": "R$ 1.500,50"
}

---

Relatório de Contas

Gera um relatório consolidado de todas as contas e seus saldos totais.

Endpoint: GET /backoffice/reports/accounts