Categorization

The categorize feature lets you categorize the transactions of a bank account of end users.

This feature is not activated by default on your domain. Please contact us to request access.

Upon activation, the property categories is available in the Bank transactions or in the ACCOUNT_CATEGORIZED webhook.

List bank transactions categories

GET https://{domain}.biapi.pro/2.0/users/{userId}/transactions?expand=categories

List bank transactions with their associated categories of the Authenticated User. By default, only active (non-deleted) transactions are returned; use the all parameter to retrieve the complete list.

Categories

Parent categoryChildren categoryDescription

Administration and taxes

Administrative expenses.

legal_advice

Expenses on lawyers and expert legal advice.

others_administration_and_taxes

Administration and taxes expenses which cannot be allocated to its child category.

social_contributions

Social charges contribute to financing the French social security system, including healthcare coverage, retirement benefits, and social welfare programs.

taxes

Tax expenses including income tax, real property tax, personal property tax, and taxes on assets etc.

Bank insurances

Insurance transactions and bank fees.

banking_fees

Bank fees including monthly maintenance/service fee, out-of-network ATM fees, overdraft fees and wire transfer fees etc.

insurance_repayments

Insurance proceeds.

insurances

Insurance premium.

others_bank_insurances

Bank / insurances expenses which cannot be allocated to its child category.

retirement_insurance

Insurance for retirement.

savings

Transactions for savings or transferd to savings account.

unauthorized_debit_fees

Unauthorized debit card charges.

Food and restaurants

Expenses for food, drink and restaurants.

baker

Expenses at bakery.

bars_restaurants

Expenses for bar, restaurant or coffee shop.

butcher_fishmongers_produce

Expenses for butchers, fishmongers and related food preparers.

others_food_and_restaurants

Food and restaurants expenses which cannot be allocated to its child category.

supermarket_and_groceries

Expense at supermarkets and groceries.

Household

House maintenance and repairs and child raises expenses.

home_services_cleaning

Home maintenance expenses.

kitchen_and_appliances

Kitchen equipment and home appliances expenses.

others_furniture_and_home_services

Household expense which cannot be allocated to its child category.

works_diy_gardening

Landscaping expenses like gardener, lawn care, lawn mowing.

child_care_and_kindergarten

Childminder, nursery, and babysitting expenses.

furniture_and_decoration

Interior decorating expenses like artwork, furniture etc.

alimony_payment

Expense the noncustodial parent pays to the custodial parent, to help cover the child's basic needs.

Healthcare

Medical expenses.

doctors_specialist_dentists_hospitals

Expenses in hospital and specialist including dental, optical or physio treatment etc.

health_insurance_fees

Health insurance cost.

health_insurance_reimbursement

Reimbursement of medical costs.

others_healthcare

Healthcare expenses which cannot be allocated to its child category.

pharmacy

Pharmaceutical spending.

Housing

Monthly expenses associated with home.

energy

Expense of electricity and gaz.

others_housing

Housing expenses which cannot be allocated to a its child category.

rent

Base rent expense and recurring charges of additional rent.

water

Expense of water.

Leisure

Leisurely activities expenses.

cinema_theater_culture

Expenses on cultural activities for concerts, exhibitions and theatres.

hotels

Hotel and Airbnb expenses.

others_leisure

Leisure expenses which cannot be allocated to its child category.

sports

Expenses related to sports including membership to sports clubs, sport lessons and shopping in sporting goods retailer.

tobacco_gambling

Expenses on tobacco and gambling including sports betting, casinos, lotteries, gaming and scratch cards.

Loans

Disposal and payment of loans.

consumer_loans_disposal

Disposal of consumer loans which refers to transactions other than real estate.

mortgage_disposal

Disposal of mortgage loans.

others_loans

Loans expense which cannot be allocated to its child category.

consumer_loans_payment

Loan that is typically used for personal expense, such as buying a car or consolidating credit card debt.

mortgage_payment

Loan that is used to purchase a home.

Media and telecommunications

Media expenses.

media_subscriptions

Expense on subscriptions to media like music streaming services.

others_media_and_telecommunications

Media and telecommnunications expense which cannot be allocated to a its child category.

phone_internet_tv

Phone, Internet, TV expenses.

Others

All expense and income which cannot be allocated to explicit parent category.

return_debit

Unsuccessful / refused payment.

transfers

Bank transfers.

Revenue

Income received.

financial_income

Distribution of profits to shareholders, or income earned on loaned money or investments.

others_revenue

Revenue incomes which cannot be allocated to its child category.

pensions

Regular payment made by the state to retired people.

rental_income

Amount of rent that a landlord receives from their tenants.

salary

Paid for work or services.

alimony

Payment the custodial parent receives from the non custodial parent, to help cover the child's basic needs.

family_benefits

Family allowances such as Paje.

unemployment_benefits

Unemployment benefit paid by a French governmental agency such as Pôle emploi.

others_benefits

Other benefits like scholarship benefit or disability benefits etc.

housing_benefits

Housing benefits such as CAF benefits.

savings_disposal

Transactions for savings, or received in savings account.

Shopping

Online shopping and in-store shopping expenses.

beauty_hairdressing_aesthetic

Expenses in beauty salons, hair salons and on aesthetic services and products.

clothing_and_accessories

Clothes and accessories expenses like gloves, bracelets, watches etc.

ecommerce

Online shopping expenses.

multimedia_books_stationery

Expenses on books, stationery and multimedia products including e-learning courses, video games etc.

others_shopping

Shopping expenses which cannot be allocated to its child category.

Travel and transport

Travel expenses including airfare and transportation services.

fuel

Fuel and oil expense which refers to gasoline, oil, and lubricants used in operating.

others_travel_and_transport

Travel and transport expenses which cannot be allocated to its child category.

parking_maintenance_tolls

Expenses for tolls, parking, mainetenance.

plane_or_boat_travel

Expense for travel by airplane or boat.

public_transportation

Expenses for public transportation including trams, buses, and coaches.

rental_and_taxis

Expense for rental cars, taxis, private car services.

train_travel

Expense for travel by train.

Last updated