🔍 Detalhes da Conta Bancária
Este endpoint retorna informações detalhadas de uma conta específica, incluindo dados cadastrais, endereço, usuários vinculados com suas funções (roles) e estatísticas de movimentação financeira.
Endpoint: GET /backoffice/accounts/\{id\}
⚡ Filtros de Estatísticas
Os parâmetros abaixo filtram os dados contidos no objeto stats (transações e cobranças). Se omitidos, o sistema calculará os totais históricos.
| Parâmetro | Tipo | Exemplo | Descrição |
|---|---|---|---|
date_from | date | 2024-01-01 | Data inicial para o cálculo das estatísticas. |
date_to | date | 2024-01-31 | Data final para o cálculo das estatísticas. |
📦 Estrutura de Retorno
1. Dados Principais (data)
Contém o perfil completo da conta:
- Identificação: Nome, e-mail, documento (CPF/CNPJ).
- Status: Objeto contendo
code,titleecolorpara UI. - Banco: Detalhes da instituição financeira (
id,title,slug). - Saldos:
current: Valor líquido em conta.total_balance: Saldo bruto acumulado.formatted_balance: Valor formatada em R$.
- Usuários: Lista de usuários associados com suas respectivas
rolesdefinidas na conta. - Configurações: Taxas praticadas (Pix, Boleto), limites e URL de Webhook.
2. Estatísticas (stats)
Utilizado para alimentar gráficos e cards de desempenho:
- Transactions:
total_count: Qtd de transações no período.total_value: Soma total do valor das transações.by_type: Quebra de quantidades e valores por tipo de transação.
- Charges:
total_count: Qtd de cobranças geradas.total_value: Valor total das cobranças geradas.total_paid: Valor efetivamente recebido.by_status: Quebra de quantidades e valores por status (Pago, Pendente, Vencido, etc), incluindo descrição (status) e título curto (title).
📝 Exemplo de Resposta (JSON)
json
{
"data": {
"id": 465,
"name": "Camilly Vitória...",
"email": "camilly@exemplo.com",
"document": "165.811.844-89",
"status": {
"code": "ACTIVE",
"title": "Ativo",
"color": "success"
},
"bank": {
"id": 1,
"title": "Teste",
"slug": "base"
},
"balance": {
"current": 1500.50,
"total_balance": 150050,
"formatted_balance": "R$ 1.500,50"
},
"users": [
{
"id": 1,
"name": "Admin",
"roles": { "id": 1, "name": "owner" }
}
]
},
"stats": {
"transactions": {
"total_count": 45,
"total_value": 12500.50,
"by_type": [
{
"type": "PIX_IN",
"description": "Pix Recebido",
"count": 40,
"value": 10000.00
}
]
},
"charges": {
"total_count": 10,
"total_value": 5000.00,
"total_paid": 4500.00,
"by_status": [
{
"status": "Cobrança paga integralmente",
"title": "PAGO",
"count": 9,
"value": 4500.00
}
]
}
}
}