Categories (obsolete)

The current version of this feature is obsolete. A major redesign of it is in progress.

API endpoints

Authentication: endpoints listed in this page require header authentication with a user token.

List categories

GET https://{domain}.biapi.pro/2.0/categories

Get all categories.

200: OK List of categories

Response body: CategoriesList object

Route aliases:

/users/{userId}/categories
/users/{userId}/categories/full

Category

GET https://{domain}.biapi.pro/2.0/categories/{categoryId}

Get a single category by ID.

Path Parameters

Name	Type	Description
categoryId*	Integer	Category ID.

200: OK Category details

Response body: Category object

Data model

CategoriesList object

Property	Type	Description
categories	Array of Category objects	The full list of categories.

Category object

Property	Type	Description
id	Integer	ID of the category.
id_parent_category	Integer	ID of the parent category. If this is a parent category, it will be equal to its own ID.
name	String	Name of the category.
color	String	Color of the category.
income	Boolean or null	Is an income category. If null, this is both an income and an expense category.
refundable	Boolean	This category accepts opposite sign of transactions.
id_logo	Integer or null	ID of the logo.