Transações

Agrega transações do workspace da chave por dimensão

Agrupa transações (receitas e despesas) do workspace vinculado à chave de API por uma ou mais dimensões (category, category_parent, account, month, description, partner), somando receita/despesa/saldo por grupo. category_parent soma as subcategorias na categoria pai delas; category separa cada subcategoria. Aceita os mesmos filtros de /api/v1/transactions (from, to, category, include_subcategories, account, type). Não é paginado — varre todo o período pedido até um teto interno de linhas; se excedido, meta.truncated=true e o período deve ser reduzido. Por padrão exclui dos totais 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) — use include_ignorable_categories=true para incluí-las (ex.: ao pedir explicitamente o total movimentado em transferências ou investimentos).

get/api/v1/transactions/aggregate

Request

  • Base URL: https://snabber.com.br
  • URL: https://snabber.com.br/api/v1/transactions/aggregate
  • 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 ou CSV

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

group_bystring

Dimensão(ões) de agrupamento: category, category_parent, account, month, description, partner. Repetível ou CSV. Padrão: category

top_ninteger

Máximo de buckets quando group_by inclui 'description'; o restante vira um bucket 'Outros'

include_ignorable_categoriesboolean

Se true, inclui nos totais 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). Padrão false.

Response

Transações agregadas por grupo

Example response

{
  "buckets": [
    {
      "keys": {
        "month": "2026-04"
      }
    }
  ]
}

Changes

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