Listar Contas

Lista as contas bancárias da empresa, com saldos e resumo consolidado. Aceita filtros por qualquer campo cadastral da conta.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/bank-accounts

Parâmetros da URL:

companyId (uuid, obrigatório): Identificador da empresa

Parâmetros de query:

filters (JSON, opcional): Condições sobre os campos abaixo — formato em Filtros, ordenação e busca
joinOperator (opcional): and (padrão) ou or

Retorna todas as contas que atendem aos filtros, sem paginação, ordenadas por banco e número da conta. Não aceita sort nem search.

Campos filtráveis

Campo	Tipo	Observação
`id`	uuid
`name`	texto
`description`	texto
`bank`	texto
`status`	enum	`active`, `pending`, `archived`
`provider`	enum	`local` ou `open-finance`; apenas `eq` e `inArray`
`type`	texto	mesmo valor retornado em `type`
`currencyCode`	texto	ex.: `BRL`
`compeCode`	texto	código COMPE do banco
`accountNumber`	texto
`branchNumber`	texto
`initialBalance`	número
`accountingInitialBalance`	número
`createdAt`	data
`updatedAt`	data

Saldos calculados (currentBalance, partialBalance, currentAutomaticallyInvestedBalance, overdraftUsedLimit) não são filtráveis.

Exemplo

Contas ativas conectadas via Open Finance:

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/bank-accounts" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'filters=[{"id":"status","operator":"eq","value":"active"},{"id":"provider","operator":"eq","value":"open-finance"}]'

Resposta

{
  "status": "success",
  "data": {
    "accounts": [
      {
        "id": "6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d",
        "externalId": null,
        "name": "Conta Corrente Itaú",
        "description": "Conta principal de operações",
        "status": "active",
        "provider": "open-finance",
        "bank": "Itaú Unibanco",
        "type": 4,
        "currentBalance": 15230.45,
        "currentAutomaticallyInvestedBalance": 0,
        "overdraftUsedLimit": 0,
        "currencyCode": "BRL",
        "compeCode": "341",
        "accountNumber": "45678-9",
        "branchNumber": "0912",
        "initialBalance": 100,
        "accountingInitialBalance": "100.00",
        "partialBalance": 15130.45,
        "createdAt": "2025-03-10T09:30:00.000Z",
        "updatedAt": "2026-08-01T12:00:00.000Z"
      }
    ],
    "summary": {
      "currentBalance": 15230.45,
      "invested": 0,
      "limit": 0
    }
  }
}

provider: local (conta cadastrada manualmente) ou open-finance (conectada via Open Finance)
status: active, pending ou archived
type: código numérico do tipo de conta — 0 conta depósito à vista, 1 poupança, 2 conta pagamento pré-paga, 3 cartão de crédito, 4 conta corrente, 5 caixinha, 6 investimentos, 7 aplicação automática, 8 meios de recebimento, 9 outros
summary consolida os saldos das contas retornadas — com filtros, apenas das contas filtradas

Endpoint

Campos filtráveis

Exemplo

Resposta

On this page