Data structures
The following data structures are used within the EnableNow Categorization API.
Categorization Job
A Categorization Job is a task initiated to start the process of categorizing bank transactions. Once initiated, the Categorization Job runs in the background without waiting for the categorization to complete.
The job is designed to handle large volumes of transactions efficiently and provides a way to monitor its progress. You can request updates on the status of the Categorization Job at any time, which can be particularly helpful when categorizing large numbers of transactions. This asynchronous design ensures that the Categorization API is both robust and user-friendly.
A Categorization Job has one of the following statuses:
| Status | Description |
|---|---|
| PENDING | The job has been created but not yet started |
| INPROGRESS | The job is in progress |
| COMPLETED | The job has completed |
| FAILED | The job has failed |
Category
The Category object is a structured representation of the transaction category hierarchy. It is divided into four levels of detail (from l0Name to l3Name) and a code that uniquely identifies the category.
Here's a brief overview of each field:
- l0Name: This represents the highest level of the category and the engine used. In the example provided. At the moment "Retail" is the only available categorization engine.
- l1Name: This is the first sub-category. Can be "Inflows" or "Outflows".
- l2Name: This is the second sub-category, providing an even more granular level of detail. In the example, it is "Income".
- l3Name: This is the deepest level of categorization. In the example, "Variable income" falls under "Income".
- code: This is a unique identifier for the category. It's a string of alphanumeric characters that corresponds to the specific category path from l0Name to l3Name. In the example, the code "R010102" represents the "Retail > Inflows > Income > Variable income" category.
Available categories
| Level 1 | Level 2 | Level 3 | Code |
|---|---|---|---|
| Inflows | Income | Fixed income | R010101 |
| Inflows | Income | Variable income | R010102 |
| Inflows | Income | Investment income | R010103 |
| Inflows | Income | Rent income | R010104 |
| Inflows | Income | Other income inflows | R010199 |
| Inflows | Benefits and subsidies | Unemployment benefit | R010201 |
| Inflows | Benefits and subsidies | Sickness benefit | R010202 |
| Inflows | Benefits and subsidies | Disability benefit | R010203 |
| Inflows | Benefits and subsidies | Childbirth benefit | R010204 |
| Inflows | Benefits and subsidies | Assistance subsidy | R010205 |
| Inflows | Benefits and subsidies | Childcare subsidy | R010206 |
| Inflows | Benefits and subsidies | Day care subsidy | R010207 |
| Inflows | Benefits and subsidies | Healthcare subsidy | R010208 |
| Inflows | Benefits and subsidies | Rent subsidy | R010209 |
| Inflows | Benefits and subsidies | Child related budget | R010210 |
| Inflows | Benefits and subsidies | Other benefits and subsidies inflows | R010299 |
| Inflows | Pension | State pension | R010301 |
| Inflows | Pension | Personal pension | R010302 |
| Inflows | Pension | Other pension inflows | R010399 |
| Inflows | Loans | Consumer loan inflow | R010401 |
| Inflows | Loans | Student loan inflow | R010402 |
| Inflows | Loans | Private loan inflow | R010403 |
| Inflows | Loans | Flash loan inflow | R010404 |
| Inflows | Loans | Other loan inflows | R010499 |
| Inflows | Alimony | Child alimony inflow | R010601 |
| Inflows | Alimony | Partner alimony inflow | R010602 |
| Inflows | Alimony | Other alimony inflows | R010699 |
| Inflows | Refunds and reimbursements | Reversal payment inflow | R010701 |
| Inflows | Refunds and reimbursements | Other refunds and reimbursements inflows | R010799 |
| Inflows | Insurance | Health insurance inflow | R010801 |
| Inflows | Insurance | Car insurance inflow | R010802 |
| Inflows | Insurance | Other insurance inflows | R010899 |
| Inflows | Tax | Tax return | R010901 |
| Inflows | Tax | Other tax inflows | R010999 |
| Inflows | Cash deposit | Cash deposit | R011001 |
| Inflows | Gambling | Gambling | R011101 |
| Inflows | Crypto | Crypto | R011201 |
| Inflows | Lotteries | Lotteries | R011301 |
| Inflows | Other | Other inflows | R019999 |
| Inflows | Internal transactions | Other internal transaction inflows | R010099 |
| Outflows | Housing | Rent | R020101 |
| Outflows | Housing | Mortgage | R020102 |
| Outflows | Housing | Real estate purchase | R020103 |
| Outflows | Housing | Rent deposit | R020104 |
| Outflows | Housing | Other housing outflows | R020199 |
| Outflows | Utilities | Energy | R020201 |
| Outflows | Utilities | Water | R020202 |
| Outflows | Utilities | Other utilities outflows | R020299 |
| Outflows | Tax | Car tax | R020301 |
| Outflows | Tax | Municipal tax | R020302 |
| Outflows | Tax | Income tax | R020303 |
| Outflows | Tax | Other tax outflows | R020399 |
| Outflows | Insurance | Health insurance outflow | R020401 |
| Outflows | Insurance | Car insurance outflow | R020402 |
| Outflows | Insurance | Other insurance outflows | R020499 |
| Outflows | Home and leisure | Groceries | R020501 |
| Outflows | Home and leisure | Clothing | R020502 |
| Outflows | Home and leisure | Medical | R020503 |
| Outflows | Home and leisure | Education | R020504 |
| Outflows | Home and leisure | Day care and out of school care | R020505 |
| Outflows | Home and leisure | Financial | R020506 |
| Outflows | Home and leisure | Restaurants bars and clubs | R020507 |
| Outflows | Home and leisure | Travel and vacation | R020508 |
| Outflows | Home and leisure | Culture sports and recreation | R020509 |
| Outflows | Home and leisure | Other home and leisure outflows | R020599 |
| Outflows | Mobility | Car lease | R020601 |
| Outflows | Mobility | Car costs | R020602 |
| Outflows | Mobility | Other mobility outflows | R020699 |
| Outflows | Pension and investments | Investment outflows | R020801 |
| Outflows | Pension and investments | Pension outflows | R020802 |
| Outflows | Pension and investments | Other pensions and investments | R020899 |
| Outflows | Loans | Student loan repayment | R020901 |
| Outflows | Loans | Consumer loan repayment | R020902 |
| Outflows | Loans | Private loan repayment | R020903 |
| Outflows | Loans | Flash loan repayment | R020904 |
| Outflows | Loans | BNPL repayment | R020905 |
| Outflows | Loans | Other loan repayment outflows | R020999 |
| Outflows | Fines and debt collection | Fines | R021001 |
| Outflows | Alimony | Child alimony outflow | R021201 |
| Outflows | Alimony | Partner alimony outflow | R021202 |
| Outflows | Alimony | Other alimony outflows | R021299 |
| Outflows | Refunds and reimbursements | Reversal payment outflow | R021301 |
| Outflows | Refunds and reimbursements | Other refunds and reimbursements outflows | R021399 |
| Outflows | Debt collection | Debt collection agencies | R021401 |
| Outflows | Debt collection | Bailiffs | R021402 |
| Outflows | Debt collection | Other debt collection | R021499 |
| Outflows | Cash | Cash withdrawal | R021501 |
| Outflows | Gambling | Gambling | R021601 |
| Outflows | Crypto | Crypto | R021701 |
| Outflows | Lotteries | Lotteries | R021801 |
| Outflows | Other | Other outflows | R029999 |
| Outflows | Internal transactions | Other internal transaction outflows | R020099 |