Listar Lançamentos

Lista os lançamentos contábeis das contas bancárias da empresa, paginados, com filtros por qualquer campo (inclusive campos personalizados), ordenação e busca.

Endpoint

Método e URL:

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

Parâmetros da URL:

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

Parâmetros de query:

accountId (uuid, opcional, repetível): Restringe a contas específicas. Sem o parâmetro, retorna os lançamentos de todas as contas, inclusive os não vinculados a conta. Para apenas os não vinculados, filtre {"id":"bankAccountId","operator":"isEmpty"}
from, to (data YYYY-MM-DD ou data-hora ISO 8601, opcionais): Período sobre date, ambos inclusivos — veja Período
filters (JSON, opcional): Condições sobre os campos abaixo — formato em Filtros, ordenação e busca
joinOperator (opcional): and (padrão) ou or. accountId, from e to sempre restringem o resultado, mesmo com or
sort (JSON, opcional): Qualquer campo abaixo ou id de campo personalizado. Padrão: criados mais recentemente primeiro
search (texto, opcional): Busca nos campos de texto do lançamento e nos dados da contraparte (nome, documento, pagador, recebedor)
page (number, opcional): Página, a partir de 1 (padrão: 1)
perPage (number, opcional): Itens por página, de 1 a 500 (padrão: 10)

Os totais do resultado filtrado ficam em Totais dos Lançamentos, que aceita os mesmos parâmetros.

Campos filtráveis

Todos os campos abaixo também são ordenáveis.

Campo	Tipo	Observação
`date`	data	data contábil do lançamento
`bankTransferDate`	data	data da transação bancária de origem
`value`	número	valor decimal com sinal
`amount`	valor	mesmo valor de `value`, em decimal
`method`	enum	`CREDIT` ou `DEBIT`
`description`	texto
`vendor`	texto
`documentNumber`	texto
`observation`	texto
`bankAccountId`	uuid	`isEmpty` retorna os não vinculados a conta
`bankAccountName`	texto
`bankTransferMethod`	enum	`CREDIT` ou `DEBIT`
`bankTransferType`	texto	tipo da operação, ex.: `PIX`
`bankTransferExternalId`	texto
`transferId`	uuid	transação bancária de origem
`origin`	enum	`TRANSFER` ou `MANUAL`
`conciliationStatus`	texto	ex.: `NOT_CONCILIATED`
`status`	enum	`ACTIVE`, `LOCKED` ou `DESPISED` (descartados nunca são listados)
`classificationStatus`	enum	`NOT_CLASSIFIED`, `CLASSIFIED_PARTIAL` ou `CLASSIFIED`
`presetId`	uuid
`id`	uuid
`createdAt`	data
`updatedAt`	data
id de campo personalizado	campo personalizado	ids em Atributos dos Lançamentos

Exemplos

Lançamentos de agosto acima de R$ 5.000 ainda não classificados:

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/accounting/bank-accounts/entries" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'from=2026-08-01' \
  --data-urlencode 'to=2026-08-31' \
  --data-urlencode 'filters=[{"id":"amount","operator":"gt","value":5000},{"id":"classificationStatus","operator":"eq","value":"NOT_CLASSIFIED"}]' \
  --data-urlencode 'sort=[{"id":"date","desc":true}]'

Por campo personalizado, em duas contas, buscando por contraparte:

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/accounting/bank-accounts/entries" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'accountId=6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d' \
  --data-urlencode 'accountId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d' \
  --data-urlencode 'filters=[{"id":"0d9e1f2a-3b4c-4d5e-6f7a-8b9c0d1e2f3a","operator":"eq","value":"Filial SP"}]' \
  --data-urlencode 'search=acme'

Resposta

{
  "status": "success",
  "data": {
    "data": [
      {
        "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
        "companyId": "3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f",
        "presetId": null,
        "transferId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "bankAccountId": "6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d",
        "bankAccountName": "Conta Corrente Itaú",
        "date": "2026-08-07T14:33:00.000Z",
        "bankTransferDate": "2026-08-07T14:33:00.000Z",
        "description": "PIX RECEBIDO ACME",
        "vendor": null,
        "value": "1500.00",
        "amount": "1500.00",
        "method": "CREDIT",
        "bankTransferMethod": "CREDIT",
        "bankTransferType": "PIX",
        "bankTransferExternalId": "pluggy-tx-889123",
        "bankTransferPartie": { "name": "ACME Comércio Ltda", "document": "98765432000155" },
        "bankTransferPaymentData": null,
        "conciliationStatus": "NOT_CONCILIATED",
        "origin": "TRANSFER",
        "documentNumber": "NF-4521",
        "observation": null,
        "createdAt": "2026-08-07T15:00:00.000Z",
        "updatedAt": "2026-08-07T15:00:00.000Z",
        "status": "ACTIVE",
        "classificationStatus": "CLASSIFIED",
        "dismemberOrigin": null,
        "customFields": {
          "0d9e1f2a-3b4c-4d5e-6f7a-8b9c0d1e2f3a": "Filial SP",
          "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d": "Gestora Alfa"
        }
      }
    ],
    "pagination": { "totalRecords": 1, "totalPages": 1, "hasMore": false }
  }
}

customFields: mapa { fieldId: valor } com os campos personalizados do lançamento e, quando o lançamento não tem valor próprio, os da conta bancária vigentes na data da transação. Filtros por campo personalizado consideram apenas os valores do lançamento
bankTransferPartie / bankTransferPaymentData: dados da contraparte e do pagamento vindos da transação bancária, ou null
pagination.hasMore indica se existe próxima página; totalRecords e totalPages vêm null em conjuntos grandes — veja Paginação
Lançamentos descartados na plataforma não são retornados

Endpoint

Campos filtráveis

Exemplos

Resposta

On this page