Skip to main content

Data Structure

The Category object is a structured representation of the transaction category assigned by the categorization engine. For E1, the output is intentionally compact and consists of a category key, a confidence score, and optional flags.

The category object is added to the Transaction API result models. These models are described within the Account Information Transaction Data Structures.

E1 category object​

Here is a brief overview of each field within the e1 category object:

Field
Type
Description
category
string
The category assigned by the E1 engine to the transaction, for example expense.essential.groceries or income.salary. See Categories.
confidence
number (0..1)
The confidence score of the assigned category, representing how certain the engine is about the prediction.
flags
array of string or [ ]
Optional flags that add extra context to the categorization result, for example refund, reversal_payment, or payment_arrangement.
info

Unlike Z2, the E1 category object does not include an entity field.

Example 1 - Transaction Model​

{
  "id": "aeeffb5c-4800-5f6f-8797-7f488351553d",
  "accountNumber": "NL12ABNA9999876523",
  "accountId": "faa409f9-ff20-4462-4729-08dbfaecde2e",
  "description": "Albert Heijn",
  "amount": -54.25,
  "currency": "EUR",
  "category": {
    "e1": {
      "category": "expense.essential.groceries",
      "confidence": 0.97,
      "flags": []
    }
  }
}

Example 2 - Transaction Model with a flag​

{
  "id": "d8906f3a-5128-54cf-840f-1a82c5562b73",
  "accountNumber": "NL12ABNA9999876523",
  "accountId": "faa409f9-ff20-4462-4729-08dbfaecde2e",
  "description": "Refund bol.com",
  "amount": 18.95,
  "currency": "EUR",
  "category": {
    "e1": {
      "category": "other.other",
      "confidence": 0.88,
      "flags": [ "refund" ]
    }
  }
}