# Obtém o histórico de uma conta bancária

Retorna o histórico de uma conta bancária.

Endpoint: GET /api/v3/bank-accounts/{bankAccountId}/history
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Path parameters:

  - `bankAccountId` (integer, required)
    ID da conta bancária.

## Query parameters:

  - `user_id` (integer)
    Filtro pelo ID do usuário.

Você pode localizar os IDs dos usuários no _endpoint_ de listagem de usuários.
    Example: 1

  - `date_from` (string)
    Filtra por dados que foram registrados a partir de uma data. (Formato: YYYY-MM-DD).

  - `date_to` (string)
    Filtra por dados que foram registrados até uma data. (Formato: YYYY-MM-DD).

  - `type` (string)
    Filtra por tipo de movimentação.
Exemplo:
- new: Nova
- update_value: Atualização valor
- update_date: Atualização data
- cancelled: Cancelamento
- disabled: Exclusão
- update_bank: Alteração conta
- grouped: Agrupamento
- restored: Restauração
    Enum: "new", "update_value", "update_date", "cancelled", "disabled", "update_bank", "grouped", "restored"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

## Response 200 fields (application/json):

  - `data` (object)
    Representa um histórico de conta bancária.

  - `data.bank_account_transactions` (array)
    Histórico de transações da conta bancária.

  - `data.bank_account_transactions.value` (object)
    Valor da transação.

  - `data.bank_account_transactions.value.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.bank_account_transactions.value.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.bank_account_transactions.type` (string)
    Tipo da transação.

- new: Nova
- update_value: Atualização valor
- update_date: Atualização data
- cancelled: Cancelamento
- disabled: Exclusão
- update_bank: Alteração conta
- grouped: Agrupamento
- restored: Restauração
    Enum: "new", "update_value", "update_date", "cancelled", "disabled", "update_bank", "grouped", "restored"

  - `data.bank_account_transactions.due_date` (string)
    Data de vencimento.
    Example: "2025-01-30"

  - `data.bank_account_transactions.payment_date` (string)
    Data de pagamento.
    Example: "2025-01-30"

  - `data.bank_account_transactions.description` (string)
    Descrição da transação.
    Example: "Pagamento de conta de luz"

  - `data.bank_account_transactions.user` (object)
    Representa um usuário.

  - `data.bank_account_transactions.user.id` (integer)
    ID do usuário.
    Example: 123

  - `data.bank_account_transactions.user.name` (string)
    Nome do usuário.
    Example: "Fulando usuário"

  - `data.bank_account_transactions.user.username` (string)
    Nome de usuário do usuário.
    Example: "fulano"

  - `data.bank_account_transactions.user.email` (string)
    E-mail do usuário.
    Example: "fulano@email.com"

  - `data.bank_account_transactions.user.profile` (object)
    Perfil do usuário.

  - `data.bank_account_transactions.user.profile.id` (integer)
    Identificador único do perfil.
    Example: 1

  - `data.bank_account_transactions.user.profile.name` (string)
    Nome do perfil.
    Example: "Administrador"

  - `data.bank_account_transactions.user.profile.description` (string)
    Descrição do perfil.
    Example: "Administrador do sistema"

  - `data.bank_account_transactions.user.settings` (object)
    Configurações do usuário.

  - `data.bank_account_transactions.user.settings.notifications` (object)
    Configurações de notificações.

  - `data.bank_account_transactions.user.settings.notifications.receive_financial_emails` (boolean)
    Indica se o usuário pode receber e-mails financeiros.
    Example: true

  - `data.bank_account_transactions.user.settings.notifications.receive_contract_emails` (boolean)
    Indica se o usuário pode receber e-mails de contratos de planos.

  - `data.bank_account_transactions.user.settings.pos` (object)
    Configurações do PDV.

  - `data.bank_account_transactions.user.settings.pos.show_in_list_on_open` (boolean)
    Indica se o usuário pode aparecer na listagem ao abrir o PDV.
    Example: true

  - `data.bank_account_transactions.user.settings.pos.show_in_sellers_list` (boolean)
    Indica se o usuário pode aparecer na lista de vendedores do PDV.
    Example: true

  - `data.bank_account_transactions.user.companies` (array)
    Lista de empresas que permite visualizar.

  - `data.bank_account_transactions.user.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.bank_account_transactions.user.companies.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `data.bank_account_transactions.user.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `data.bank_account_transactions.account_plan` (object)
    Representa um plano de conta.

  - `data.bank_account_transactions.account_plan.id` (integer)
    Identificador único do plano de conta.
    Example: 123

  - `data.bank_account_transactions.account_plan.name` (string)
    Example: "Despesas Administrativas"

  - `data.bank_account_transactions.is_transfer` (boolean)
    Indica se a transação é uma transferência.

  - `data.bank_account_transactions.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.bank_account_transactions.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.balance_by_date` (array)
    Histórico de saldos organizados por data.

  - `data.balance_by_date.date` (string, required)
    Data do saldo no formato YYYY-MM-DD.
    Example: "2025-07-04"

  - `data.balance_by_date.balance` (object, required)
    Saldo da conta na data especificada.

  - `data.current_balance` (object)
    Saldo atual da conta bancária.

  - `data.bank_account` (object)
    Representa uma conta bancária.

  - `data.bank_account.id` (integer)
    Identificador único da conta bancária.
    Example: 123

  - `data.bank_account.name` (string)
    Nome da conta bancária
    Example: "ConnectPlug Bank"

  - `data.bank_account.initial_date` (string)
    Data.
    Example: "2025-01-30"

  - `data.bank_account.initial_value` (object)
    Valor inicial da conta bancária

  - `data.bank_account.bank` (object)
    Representa um banco.

  - `data.bank_account.bank.id` (integer)
    Identificador único do banco.
    Example: 123

  - `data.bank_account.bank.code` (integer)
    Código do banco
    Example: 10

  - `data.bank_account.bank.image` (string)
    URL da imagem do banco
    Example: "https://connectplug.com.br/images/banks/10.png"

  - `data.bank_account.deleted` (boolean)
    Indica se está apagado ou não.

  - `data.bank_account.first_transaction_date` (string)
    Data da primeira transação na conta bancária.
    Example: "2025-01-30"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields