Docs API Reference Transaction/bff/transaction/category-list

/bff/transaction/category-list

Returns all transaction categories with aggregated income, expense, and net totals. Useful for a breakdown chart or category filter in the transaction list.

TransactiongetBffTransactionCategory-list

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

Transaction category with aggregated financial data.

category_codestringRequired

Category code identifier.

category_labelstringRequired

Category display label.

currencystringRequired

Currency code (e.g., "CZK").

colorstringRequired

Category hex color (e.g., "#FF5733").

total_incomenumberRequired

Sum of all incoming transactions in this category.

total_expensenumberRequired

Sum of all outgoing transactions in this category.

transaction_countnumberRequired

Number of transactions in this category.

net_totalnumberRequired

Net total (income + expense). Negative if expense > income.

Response example

application/json

{
  "items": [
    {
      "category_code": "example_category_code",
      "category_label": "example_category_label",
      "currency": "example_currency",
      "color": "example_color",
      "total_income": 0,
      "total_expense": 0,
      "transaction_count": 0,
      "net_total": 0
    }
  ]
}

Request example

GET /bff/transaction/category-list

get

curl -X GET "https://api.bizkithub.com/bff/transaction/category-list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key