Extrato resumido

O extrato como o painel mostra: movimentações, cobranças em aberto e pedidos de MED, com título, cor e totais já calculados.

GET /v1/statement

cURL

curl "https://bukio-backend-production.up.railway.app/v1/statement?days=7&direction=income&category=charge" \
  -H "Authorization: Bearer bk_live_..."

200

{
  "items": [
    {
      "kind": "transaction",
      "id": "BKY-7KQ2M9XP4RZT",
      "title": "Pix recebido",
      "counterparty": "Ana Souza",
      "description": "Pedido 1842",
      "category": "charge",
      "amount": 14950,
      "fee": 50,
      "direction": "in",
      "balanceEffect": 14950,
      "status": "completed",
      "statusTitle": "Aprovado",
      "tone": "in",
      "date": "2026-10-08T15:04:11.000Z",
      "dueDate": null
    },
    {
      "kind": "charge",
      "id": "BKY-2W8M4Z3F7K9Q",
      "title": "Cobrança criada",
      "counterparty": null,
      "description": "Pedido 1843",
      "category": "charge",
      "amount": 9900,
      "fee": 0,
      "direction": "in",
      "balanceEffect": 0,
      "status": "pending",
      "statusTitle": "Entrada pendente",
      "tone": "pending",
      "date": "2026-10-08T15:40:00.000Z",
      "dueDate": null
    }
  ],
  "totals": {
    "income": 14950,
    "expense": 0,
    "result": 14950,
    "movements": 1,
    "toReceive": 9900,
    "toReceiveCount": 1
  },
  "nextCursor": null
}

Escopo account:statement. Diferente de Listar movimentações, aqui a linha da tarifa não aparece separada (o amount da entrada já é líquido e o da saída já inclui a tarifa), e entram também as cobranças ainda não pagas e os pedidos de MED. Vem em páginas, da mais nova para a mais antiga, sem corte: siga o nextCursor até ele voltar null. Para conciliação contábil, use o livro-razão.

days · integer · default: "30"

0 (hoje), 7, 30 ou 90.

direction · string · default: "all"

all, income ou expense.

category · string

pix, charge, transfer, withdraw, refund ou med.

q · string

Busca por código (com prefixo), descrição, contraparte ou valor. Até 80 caracteres.

limit · integer · default: "100"

Linhas por página, de 1 a 200.

cursor · string

O nextCursor da página anterior. Inválido: 400 INVALID_CURSOR.

​

Resposta

items · object[]

Show propriedades de cada linha

kind · string

transaction (movimentação), charge (cobrança em aberto ou expirada) ou med (pedido de devolução).

id · string

Código com prefixo.

title · string

Título pronto (ex.: “Pix recebido”, “Saque”).

counterparty · string | null

Quem pagou ou recebeu.

description · string | null

Descrição.

category · string

pix, charge, transfer, withdraw, refund ou med.

amount · integer

O que entrou (líquido) ou saiu (com a tarifa) do saldo.

fee · integer

Tarifa embutida.

direction · string

in, out ou none (MED aberto só bloqueia).

balanceEffect · integer

Quanto mexeu no saldo: positivo entrou, negativo saiu, 0 não mexeu (cobrança criada, MED aberto).

status · string

Situação do recurso.

statusTitle · string

Texto em português.

tone · string

Cor sugerida: in, out, pending, muted ou med.

date · string

Data e hora.

dueDate · string | null

Prazo (MED aberto).

nextCursor · string | null

Mande em ?cursor= (com os mesmos filtros) para a próxima página. null quando acabou.

totals · object | null

Totais do período inteiro e dos filtros (todas as páginas), só do que mexeu no saldo. Vem só na primeira página; nas seguintes, null.

Show propriedades

income · integer

Entradas.

expense · integer

Saídas.

result · integer

income - expense.

movements · integer

Quantidade de movimentações no período.

toReceive · integer

Soma das cobranças em aberto da conta (não depende do período).

toReceiveCount · integer

Quantas cobranças em aberto.

cURL

curl "https://bukio-backend-production.up.railway.app/v1/statement?days=7&direction=income&category=charge" \
  -H "Authorization: Bearer bk_live_..."

200

{
  "items": [
    {
      "kind": "transaction",
      "id": "BKY-7KQ2M9XP4RZT",
      "title": "Pix recebido",
      "counterparty": "Ana Souza",
      "description": "Pedido 1842",
      "category": "charge",
      "amount": 14950,
      "fee": 50,
      "direction": "in",
      "balanceEffect": 14950,
      "status": "completed",
      "statusTitle": "Aprovado",
      "tone": "in",
      "date": "2026-10-08T15:04:11.000Z",
      "dueDate": null
    },
    {
      "kind": "charge",
      "id": "BKY-2W8M4Z3F7K9Q",
      "title": "Cobrança criada",
      "counterparty": null,
      "description": "Pedido 1843",
      "category": "charge",
      "amount": 9900,
      "fee": 0,
      "direction": "in",
      "balanceEffect": 0,
      "status": "pending",
      "statusTitle": "Entrada pendente",
      "tone": "pending",
      "date": "2026-10-08T15:40:00.000Z",
      "dueDate": null
    }
  ],
  "totals": {
    "income": 14950,
    "expense": 0,
    "result": 14950,
    "movements": 1,
    "toReceive": 9900,
    "toReceiveCount": 1
  },
  "nextCursor": null
}