Cartão de crédito

Fatura de um cartão em um ciclo, detalhada por categoria

Retorna a fatura de um cartão para um ciclo (identificado pelo mês de vencimento, cycle_month), quebrada por categoria — por padrão pela categoria principal, com as subcategorias detalhadas em subcategories (já incluídas no total da principal); group_by=category devolve uma linha por categoria/subcategoria, sem hierarquia. Quando existe a fatura real do Open Finance, source é pluggy_bill e total é o valor que o emissor cobrou (o mesmo "Total da fatura" que aparece no app), com as transações realmente atribuídas àquela fatura pelo banco; sem fatura real (cartão manual, ciclo fora da janela do banco), source é estimated_payment_date e total é a estimativa local somando as transações cuja data de pagamento cai no mês. total inclui categorias que são cobrança real mas não contam como gasto pessoal (ignorable: true, ex. "Ignorado" e "Pagamento de Cartão de Crédito") — para comparar com gasto pessoal efetivo use effective_total, nunca total sozinho.

get/api/v1/credit-card-bills/invoice

Request

  • Base URL: https://snabber.com.br
  • URL: https://snabber.com.br/api/v1/credit-card-bills/invoice
  • 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.

account_idinteger

Id da conta de cartão de crédito (ver /api/v1/accounts). Obrigatório se account não for informado.

accountstring

Nome exato da conta, alternativa a account_id

cycle_monthstring required
Example:2026-06

Mês de vencimento do ciclo, YYYY-MM

group_by'category_parent' | 'category'

category_parent (padrão): pela categoria principal, com subcategories. category: uma linha por categoria da transação (subcategoria separada da principal).

Response

Fatura do ciclo

accountstring
source'pluggy_bill' | 'estimated_payment_date'

pluggy_bill = total real do emissor; estimated_payment_date = estimativa local por data de pagamento

totalnumber

Total da fatura, incluindo as categorias ignorable

ignored_totalnumber

Parte do total nas categorias ignorable

effective_totalnumber

total - ignored_total: o gasto pessoal efetivo da fatura

transaction_countinteger

Example response

{
  "account": "Nubank",
  "cycle": {
    "month": "2026-06"
  },
  "bill": {
    "id": "a3f1c0de-9b2e-4d77-8f10-2c5e1b7a4d90",
    "account": "Nubank",
    "cycle_month": "2026-06",
    "closing_month": "2026-05",
    "total_amount": 1847.32,
    "currency_code": "BRL"
  },
  "categories": [
    {
      "category": "Mercado",
      "subcategories": [
        {
          "category": "Uber"
        }
      ]
    }
  ]
}

Changes

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