v1

latestOpenAPI 3.0.02026-07-268955283.0 KB

Get the transaction category taxonomy

Returns the full transaction-category taxonomy. The English fields (mainCategoriesExpenses, mainCategoriesIncomes, subCategoriesExpenses, subCategoriesIncome) are unchanged. The mainCategoriesExpensesHe and mainCategoriesIncomesHe fields provide Hebrew display labels for the CARD-account expense/income categories, keyed by the same English IDs. The mainCategoriesCheckingHe field provides Hebrew display labels for checking-account (עו״ש) categories, which use a separate taxonomy produced by the categorization rules; use this map to translate the transactionCategory of CHECKING transactions.

get/data/transaction-categories

Response

mainCategoriesExpensesobject

Map of expense main-category ID to its sub-category IDs.

mainCategoriesIncomesobject

Map of income main-category ID to its sub-category IDs.

subCategoriesExpensesobject

Map of expense sub-category ID to its matching keywords.

subCategoriesIncomeobject

Map of income sub-category ID to its matching keywords.

mainCategoriesExpensesHeobject

Hebrew translations for expense categories, keyed by the same main-category ID.

mainCategoriesIncomesHeobject

Hebrew translations for income categories, keyed by the same main-category ID.

mainCategoriesCheckingHeobject

Hebrew translations for checking-account (עו״ש) categories, keyed by the categorization-rule main-category ID. Separate taxonomy from the expense/income catalog; use for CHECKING transactions.

Example response

{
  "mainCategoriesExpenses": {
    "HOUSEHOLD_&_SERVICES": [
      "RENT",
      "MORTGAGE",
      "COMMUNICATIONS"
    ]
  },
  "mainCategoriesIncomes": {
    "SALARY": [
      "SALARY_OTHER"
    ]
  },
  "subCategoriesExpenses": {
    "RENT": [
      "שכר דירה"
    ]
  },
  "subCategoriesIncome": {
    "SALARY_OTHER": [
      "משכורת",
      "שכר"
    ]
  },
  "mainCategoriesExpensesHe": {
    "HOUSEHOLD_&_SERVICES": {
      "label": "בית ושירותים",
      "categories": {
        "RENT": "שכר דירה",
        "MORTGAGE": "משכנתא",
        "COMMUNICATIONS": "תקשורת"
      }
    }
  },
  "mainCategoriesIncomesHe": {
    "SALARY": {
      "label": "משכורת",
      "categories": {
        "SALARY_OTHER": "משכורת אחר"
      }
    }
  },
  "mainCategoriesCheckingHe": {
    "HOK_RETURN": {
      "label": "החזרת הוראת קבע",
      "categories": {
        "FUNDS_NOT_COVER": "אין כיסוי מספיק",
        "HOK_COMMISSION": "עמלת החזרת הוראת קבע"
      }
    }
  }
}