Transações

Lista transações do workspace da chave

Retorna transações financeiras (receitas e despesas) do workspace vinculado à chave de API, com filtros por data, categoria, conta e tipo. Paginação por cursor. Cada transação traz category (a categoria dela, que pode ser uma subcategoria) e category_parent (a categoria pai, ou null). Por padrão omite as categorias que não são entrada/saída real de dinheiro — as marcadas como fora dos totais (totals_mode diferente de 'include' em /api/v1/categories, ex.: 'Ignorado', 'Pagamento de Cartão de Crédito', 'Investimentos', e as subcategorias delas) — use include_ignorable_categories=true para trazê-las.

get/api/v1/transactions

Request

  • Base URL: https://snabber.com.br
  • URL: https://snabber.com.br/api/v1/transactions
  • Auth: HTTP bearer

Query parameters

workspace_idinteger

Workspace a consultar, entre os autorizados para esta chave (ver GET /api/v1/workspaces). Se omitido, usa o workspace padrão da chave. Um id fora do conjunto autorizado resulta em 400 INVALID_WORKSPACE. Só é possível autorizar (em /integrations) um workspace do qual o dono da chave já é membro — para incluir dados de um workspace de outra pessoa, ela precisa primeiro compartilhar esse workspace com você (convite em /workspaces), não basta saber o id.

fromstring date

Data inicial (inclusiva), YYYY-MM-DD

tostring date

Data final (inclusiva), YYYY-MM-DD

categorystring

Filtra por categoria. Repetível (?category=a&category=b) ou CSV (?category=a,b)

include_subcategoriesboolean

Com category: se true, cada categoria pedida traz também as subcategorias dela (ex.: category=Transporte inclui "Uber" se for subcategoria de Transporte). Padrão false: nome exato.

accountstring

Filtra por nome de conta. Repetível ou CSV

type'income' | 'expense'

Filtra por tipo, derivado do sinal do valor

limitinteger

Máximo de itens por página (até 200)

cursorstring

Cursor de paginação retornado em pagination.next_cursor

include_ignorable_categoriesboolean

Se true, inclui as categorias que não são entrada/saída real (as fora dos totais, ex.: Ignorado, Pagamento de Cartão de Crédito, Investimentos, e as subcategorias delas). Padrão false: fique de fora ao somar receitas/despesas, a menos que o usuário peça essas categorias explicitamente.

Response

Lista de transações

Example response

{
  "data": [
    {
      "id": 38578,
      "date": "2026-04-05",
      "time": "14:32:00",
      "description": "Mercado",
      "amount": -150.5,
      "currency_code": "BRL",
      "category": "Uber",
      "category_parent": "Transporte",
      "account": "Bradesco",
      "installment_number": 3,
      "total_installments": 10,
      "bill_id": "a3f1c0de-9b2e-4d77-8f10-2c5e1b7a4d90",
      "bill_forecast_date": "2026-06",
      "source": "open_finance",
      "partner_initials": "JS"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.