# Lista de contas bancárias

Retorna lista de contas bancárias.

Endpoint: GET /api/v3/bank-accounts
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

## Query parameters:

  - `bank_accounts_id` (string)
    Filtro pelos IDs das contas bancárias. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `name` (string)
    Filtro pelo nome da conta bancária.
    Example: "Connectplug Bank"

  - `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).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.bank_accounts` (array)
    Representa a lista de conta bancária

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `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