Sorry, you need to enable JavaScript to visit this website.
Skip to main content

Data Model

The Views Data Model explains the details of the information supplied by the Views APIs. This helps you understand the structure and details of entities contained in the data returned by our services. Here you can view the supported list of attributes, their data types and the valid set of values for an attribute.

Entity: view

Attribute Name Type Description Endpoints
id string The unique system-generated identifier for the view. POST /views
GET /views
GET /views/{viewId}
GET /views/{viewId}/budgetSummary
name string The name of the view. POST /views
GET /views
GET /views/{viewId}
GET /views/{viewId}/budgetSummary
GET /views/recommendations
description string The description of the view. GET /views
GET /views/{viewId}
GET /views/{viewId}/budgetSummary
GET /views/recommendations
recommendationId integer The unique system-generated identifier for the recommended views. For more information about the mapping between recommendationId and created view name, refer to the Supported Recommended Views. GET /views
GET /views/{viewId}
GET /views/recommendations
created string The date when the view was created. Date in UTC time zone in the following format: yyyy-MM-dd'T'HH:mm:ss. GET /views
GET /views/{viewId}
GET /views/{viewId}/budgetSummary
lastUpdated string The date when the view was last updated. Date in UTC time zone in the following format: yyyy-MM-dd'T'HH:mm:ss. GET /views
GET /views/{viewId}
GET /views/{viewId}/budgetSummary
sourceType string Indicates if the view is created by the system or the user.
Available Values: SYSTEM or USER		 GET /views
GET /views/{viewId}
GET /views/{viewId}/budgetSummary
rule entity[] An array of rules set for a view. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
budgetData entity[] The budget type and the income and expense budget information. GET /views/{viewId}
budgetSummary entity[] A summary of the budget data. GET /views/{viewId}/budgetSummary

Entity: rule

Attribute Name Type Description Endpoints
id string The unique system-generated identifier for the rule. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
name string The name of the rule. This field appears if the rule name is provided while creating a view. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
fromDate string The date from which the lifespan of the rule starts. Date in UTC time zone in the following format: yyyy-MM-dd'T'HH:mm:ss. The fromDate field is only returned as part of include rules attributes. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
toDate string The date by which the lifespan of the rule ends. Date in UTC time zone in the following format: yyyy-MM-dd'T'HH:mm:ss. The toDate field is only returned as part of include rules attributes. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
type string The view rule type is synonymous with the categoryType field of the transaction category. The supported values for transaction categoryType are provided by the GET transactions/categories API.
Valid Values: Rule Type		 GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
baseType string Indicates if the transaction identifies whether it was deposited to the account (CREDIT) or taken out (DEBIT). Specifying baseType for a rule will filter transactions based on either CREDIT or DEBIT or both.
Note: baseType is not mandatory to be passed. It is useful for specific situations like tracking refunds. Combine "type" = EXPENSE and "baseType" = CREDIT to fetch only refunds.
Valid Values: Enums: Transaction Base Type		 GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/{viewId}/transactions
GET /views/recommendations
include entity The attributes that are included in the view rule. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
exclude entity The attributes that are excluded from the view rule. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations

Entity: include

Attribute Name Type Description Endpoints
merchantName string The name of the merchant associated with the consumer’s transactions. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
categoryId integer The unique identifier of the category assigned to the transaction category. The supported values are provided by the GET transactions/categories API. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
detailCategoryId integer The unique identifier of the detail category assigned to the transaction detail category. GET /views/{viewId}?include=rules
GET /views?include=rules
accountId integer The unique identifier for consumer’s account. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
transactionId integer The unique identifier for consumer’s transactions. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
merchantType string The type of merchant that provides further information about a transaction, i.e., BILLERS, SUBSCRIPTION.  
Valid Values: Enums: Merchant Type		 GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
city string The name of the city where the business or merchant is located. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
state string The standard state codes where the business or merchant is located.
Valid Values: Enums: State Codes		 GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
amountRange entity The range of fromAmount and toAmount to filter transactions.   GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations

Entity: amountRange

Attribute Name Type Description Endpoints
fromAmount number The minimum transaction amount range. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
toAmount number The maximum transaction amount range. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
currency String The amount currency. By default, currency is in USD. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations

Entity: exclude

Attribute Name Type Description Endpoints
merchantName string The name of the merchant associated with the user’s transactions. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
categoryId integer The unique identifier of the category assigned to the transaction category. The supported values are provided by the GET transactions/categories API. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
detailCategoryId integer The unique identifier of the detail category assigned to the transaction detail category. GET /views/{viewId}?include=rules
GET /views?include=rules
accountId integer The unique identifier for user’s account. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
transactionId integer The unique identifier for user’s transactions. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
merchantType string The type of merchant that provides further information about a transaction, i.e., BILLERS, SUBSCRIPTION.  
Valid Values: Merchant Type		 GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
city string The name of the city where the business or merchant is located. GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations
state string The standard state codes where the business or merchant is located.
Valid Values: State Codes		 GET /views/{viewId}?include=rules
GET /views?include=rules
GET /views/recommendations

Entity: budgetData

Attribute Name Type Description Endpoints
type string The entity level at which the budget is set. This entity can be a merchant, a view, a master-level category, or detail-level-category.
Valid Values: Enums: Type		 GET /views/{viewId}
budgetInfo entity[] Details of the budget. GET /views/{viewId}

Entity: budgetInfo

Attribute Name Type Description Endpoints
incomeBudget money The overall income budget amount and currency. GET /views/{viewId}
expenseBudget money The overall income budget amount and currency. GET /views/{viewId}
typeName string The name of the merchant. GET /views/{viewId}
typeId number The unique identifier of the category or detailed category GET /views/{viewId}

Entity: budgetSummary

Attribute Name Type Description Endpoints
type string The entity level at which the budget is set. This entity can be a merchant, a view, a master-level category, or detail-level-category.
Valid Values: Enums: Type		 GET /views/{viewId}/budgetSummary
dateRange entity The date range identified by fromDate and toDate. GET /views/{viewId}/budgetSummary
budgetDetail entity[] Details of the budget. GET /views/{viewId}/budgetSummary

Entity: dateRange

Attribute Name Type Description Endpoints
fromDate string The date from which or after, the aggregated transactions are fetched. This is a mandatory attribute for all rules, except rules that have transactionId. The expected format for date is - yyyy-MM-dd.
Note: The date is in UTC timezone.		 GET /views/{viewId}/budgetSummary
toDate string The date from which or after, the aggregated transactions are fetched. This is a mandatory attribute for all rules, except rules that have transactionId. The expected format for date is - yyyy-MM-dd.
Note: The date is in UTC timezone.		 GET /views/{viewId}/budgetSummary

Entity: budgetDetail

Attribute Name Type Description Endpoints
incomeBudget money The overall income budget amount and currency. GET /views/{viewId}/budgetSummary
remaingIncomeBudget money The remaining income budget amount and currency. GET /views/{viewId}/budgetSummary
expenseBudget money The overall expense budget amount and currency. GET /views/{viewId}/budgetSummary
debitTotal money The total debit amount and currency. GET /views/{viewId}/budgetSummary
creditTotal money The total debit amount and currency. GET /views/{viewId}/budgetSummary
remaingExpenseBudget money The remaining expense budget amount and currency. GET /views/{viewId}/budgetSummary
typeName string The name of the merchant. GET /views/{viewId}/budgetSummary
typeId number The unique identifier of the category or detailed category. GET /views/{viewId}/budgetSummary
remaingIncomeBudgetPercent money The percentage of remaining income budget amount. GET /views/{viewId}/budgetSummary
remaingExpenseBudgetPercent money The percentage of remaining expense budget amount. GET /views/{viewId}/budgetSummary

Entity: transactions

Attribute Name Type Description Endpoints
id  integer A unique identifier for the transaction. The combination of the id and account container are unique in the system. GET /views/{viewId}/transactions
container  string The account's container i.e. bank or creditCard. GET /views/{viewId}/transactions
amount money The amount of the transaction as it appears at the FI site. GET /views/{viewId}/transactions
baseType string Indicates if the transaction appears as a debit or a credit transaction in the account.
Valid Values: Enums: Transaction Base Type		 GET /views/{viewId}/transactions
categoryType  string The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories API. GET /views/{viewId}/transactions
categoryId integer The ID of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories API. GET /views/{viewId}/transSactions
category string The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories API. GET /views/{viewId}/transactions
categorySource string Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories API.
Valid Values: Enums: Transaction Category Source		 GET /views/{viewId}/transactions
highLevelCategoryId integer The high level category ID assigned to the transaction. The supported values are provided by the GET transactions/categories API. GET /views/{viewId}/transactions
isManual  boolean Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API. GET /views/{viewId}/transactions
sourceType string The source through which the transaction is added to the Yodlee system.
Valid Values: Enums: Transaction Source Type 		GET /views/{viewId}/transactions
date string The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site. GET /views/{viewId}/transactions
transactionDate  string The date the transaction happens in the account.  GET /views/{viewId}/transactions
status  string The status of the transaction: pending or posted.
Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.
Valid Values: Enums: Transaction Status		 GET /views/{viewId}/transactions
accountId  integer The account from which the transaction was made. This is basically the primary key of the account resource.  GET /views/{viewId}/transactions
subType string The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype indicates if the purchase was made using a debit or credit card.
Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.
Valid Values: Enums: Transaction Subtypes		 GET /views/{viewId}/transactions
merchantType string Provides further information about a transaction, i.e., if the transaction is carried out on a biller or a subscriber.
Valid Values: Enums: Merchant Type		 GET /views/{viewId}/transactions
type  string The nature of the transaction, i.e., deposit, refund, payment, etc.
Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites. 		GET /views/{viewId}/transactions
recurringEventId integer The unique identifier for the recurring events such as monthly bills of merchants that occurs every month. GET /views/{viewId}/transactions
reconStatus string Indicates the status of the predicted transactions that is if the transaction has been reconciled or not reconciled. GET /views/{viewId}/transactions
recurringStatus string Provides the status of the predicted transactions whether the transaction is pending, paid, reconciled, or missed. GET /views/{viewId}/transactions
description entity Details of the transaction description. GET /views/{viewId}/transactions
merchant entity The name of the merchant associated with the transaction. GET /views/{viewId}/transactions

Entity: description

Attribute Name Type Description Endpoints
original string Original transaction description as it appears at the FI site. GET /views/{viewId}/transactions
consumer string The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field. GET /views/{viewId}/transactions
simple string The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field. 
Note: The simple description field is available only in the United States, Canada, United Kingdom, and India.		 GET /views/{viewId}/transactions

Entity: merchant

Attribute Name Type Description Endpoints
id  string Identifier of the merchant. GET /views/{viewId}/transactions
source  string The source through which merchant information is retrieved.
Valid Values: Enums: Transaction Merchant Source		 GET /views/{viewId}/transactions
name string The name of the merchant. GET /views/{viewId}/transactions
address  address The address of the merchant associated with the transaction is populated in the merchant address field.
Note: The merchant address field is not available by default and customers will have to specifically request the merchant's address (that includes city, state, and ZIP of the merchant). The merchant address field is available only for merchants in the United States.		 GET /views/{viewId}/transactions

Entity: summary

Attribute Name Type Description Endpoints
type string Identifies the entity type based on which the details are grouped by.
Valid Values: category, merchant, categoryType, detailedCategory, state, and city.		 GET /views/{viewId}/transactionSummary
average money The average spending amount. GET /views/{viewId}/transactionSummary
creditTotal money The sum of all credit transactions. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
debitTotal money The sum of all credit transactions. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
netTotal money The net spending amount calculated as debitTotal - creditTotal GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
transactionCount integer The total number of transactions. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
transactionLink entity[] The reference path link to retrieve more information about the specific transaction. GET /views/{viewId}/transactionTrends
name string The name of the type selected. If type is merchant, then the name indicates merchant name. If type is category, name indicates category name. GET /views/{viewId}/transactionTrends
id integer The unique identifier for the type. If type is category, ID indicates categoryId. GET /views/{viewId}/transactionTrends
details entity[] Details of the transaction description. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends

Entity: details

Attribute Name Type Description Endpoints
creditTotal money The sum of all credit transactions. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
debitTotal money The sum of all credit transactions. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
netTotal money The net spending amount calculated as debitTotal - creditTotal. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
average money The average spending amount. GET /views/{viewId}/transactionSummary
percentage integer The percentage is calculated as (groupCreditTotal - groupDebitToal) / (creditTotal - debitTotal) * 100 GET /views/{viewId}/transactionSummary
name string The name of the type selected. If type is merchant, then the name indicates merchant name. If type is category, name indicates category name. GET /views/{viewId}/transactionSummary
id integer The unique identifier for the type. If type is category, ID indicates categoryId. GET /views/{viewId}/transactionSummary
transactionCount integer The total number of transactions. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
transactionLink entity[] The reference path link to retrieve more information about the specific transaction. GET /views/{viewId}/transactionTrends
GET /views/{viewId}/transactionTrends
date string The date on which transaction occures. GET /views/{viewId}/transactionTrends
Attribute Name Type Description Endpoints
method string The method that is used to call the URL. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends
url string The URL to access the endpoint. GET /views/{viewId}/transactionSummary
GET /views/{viewId}/transactionTrends

Entity: transactionTrends

Attribute Name Type Description Endpoints
type string Identifies the entity type based on which the details are grouped by.
Valid Values: category, merchant, categoryType, detailedCategory, state, and city.		 GET /views/{viewId}/transactionTrends
creditTotal string The sum of all credit transactions. GET /views/{viewId}/transactionTrends
debitTotal string GET /views/{viewId}/transactionTrends. GET /views/{viewId}/transactionTrends
netTotal string The net spending amount calculated as debitTotal - creditTotal. GET /views/{viewId}/transactionTrends
transactionCount integer The total number of transactions. GET /views/{viewId}/transactionTrends
summary entity[] Details of the transaction description. GET /views/{viewId}/transactionTrends

Entity: peerData

Attribute Name Type Description Endpoints
timePeriod string The duration for which the peer benchmarking data has to be considered for the list of transactions, categories, and merchants present in the include rules of the given viewId. GET /views/{viewId}/peerData
monthYear string The month and the year information when the peer benchmark values were last evaluated GET /views/{viewId}/peerData
fromDate string The start date of the month as derived from the provided timePeriod. The fromDate defines the start date of the timePeriod that is considered for computing the benchmark values. The fromDate can vary based on the API query date.
Usually, the benchmark values of the previous month are computed on the 15th of the current month. If the API is called within the 1st to the 15th, then the timePeriod (for example, LAST_MONTH) will be the month before the previous month, and the fromDate will be the start date of that particular month. However, if API is called after the 16th to the end of the current month, the fromDate will be the previous month's start date. The from date is in UTC format - yyyy-MM-dd'T'HH:mm:ss.		 GET /views/{viewId}/peerData
toDate string The end date of the month as derived from the provided timePeriod. The toDate defines the end date of the timePeriod that is considered for computing the benchmark values. The toDate can vary based on the API query date.
Usually, the benchmark values of the previous month are computed on the 15th of the current month. If the API is called within the 1st to the 15th, then the timePeriod (for example, LAST_MONTH) will be the month before the previous month, and the toDate will be the end date of that particular month. However, if API is called after the 16th to the end of the current month, the toDate will be the previous month's end date. The end date is in UTC format - yyyy-MM-dd'T'HH:mm:ss.		 GET /views/{viewId}/peerData
segment entity[] The segmentation details such as the income bucket and geo location that are considered for the peer benchmarking data. GET /views/{viewId}/peerData
peerDetailCategorySummary entity[] The detail category details based on which peer benchmarking data is returned. GET /views/{viewId}/peerData
peerCategorySummary entity[] The category details based on which peer benchmarking data is returned. GET /views/{viewId}/peerData
peerMerchantSummary entity[] The merchant details based on which peer benchmarking data is returned. GET /views/{viewId}/peerData

Entity: segment

Attribute Name Type Description Endpoints
incomeRange string The income range such as min_income and max_income for which the benchmarking data is returned. GET /views/{viewId}/peerData
geo address The geo location details such as the state and city for which the peer benchmarking data is returned. GET /views/{viewId}/peerData

Entity: peerDetailCategorySummary

Attribute Name Type Description Endpoints
id string The unique identifier of the detail category for which the peer benchmarking data is returned. GET /views/{viewId}/peerData
name string The name of the detail category for which the peer benchmarking data is returned. GET /views/{viewId}/peerData
benchmark entity[] Provides the peer benchmarking data at the geo location. GET /views/{viewId}/peerData

Entity: peerCategorySummary

Attribute Name Type Description Endpoints
id string The unique identifier of the category for which the peer benchmarking data is returned. GET /views/{viewId}/peerData
name string The name of the category for which the peer benchmarking data is returned. GET /views/{viewId}/peerData
benchmark entity[] Provides the peer benchmarking data at the geo location. GET /views/{viewId}/peerData

Entity: peerMerchantSummary

Attribute Name Type Description Endpoints
name string The merchant name for which the peer benchmarking data is returned. GET /views/{viewId}/peerData
benchmark entity[] Provides the peer benchmarking data at the geo location. GET /views/{viewId}/peerData

Entity: benchmark

Attribute Name Type Description Endpoints
benchmarkLevel string The benchmark level. GET /views/{viewId}/peerData
geo entity The geo location details. GET /views/{viewId}/peerData
metric entity Provides the peer data metrics at the geo location. GET /views/{viewId}/peerData

Entity: geo

Attribute Name Type Description Endpoints
level string Provides the details of geography-level i.e. one of city, state, or national that belongs to the peer. GET /views/{viewId}/peerData
value string The value corresponding to the geography-level. For example, if the level is NATIONAL then the value is US. GET /views/{viewId}/peerData

Entity: metric

Attribute Name Type Description Endpoints
numberOfPeers integer Provides the median number of the peers in the same income range. GET /views/{viewId}/peerData
spendAmount money The median amount spent by peers in that segment for the specified category or merchant. GET /views/{viewId}/peerData

Entity: recommendation

Attribute Name Type Description Endpoints
id string The unique system-generated identifier for the recommended views. For more information about the mapping between recommendationId and created view name, refer to Supported Recommended Views. GET /views/recommendations
metadata entity The details based on which system displays recommended views. GET /views/recommendations
view entity The details of the recommended views. GET /views/recommendations

Entity: metadata

Attribute Name Type Description Endpoints
duration entity The time duration for which the API considers user’s transactions to recommend views. By default, the API takes the last 90 days of transactions to recommend views. GET /views/recommendations
totalTransactions number The total number of transactions that are evaluated to recommend a view in the last 90 days GET /views/recommendations
totalAmount noney The total amount of all the transactions and currency. GET /views/recommendations

Entity: duration

Attribute Name Type Description Endpoints
fromDate string The date from which the API starts calculating transactions. The date is in UTC time zone in the following format: yyyy-MM-dd'T'HH:mm:ss. GET /views/recommendations
toDate string The date to which the API starts calculating transactions. The date is in UTC time zone in the following format: yyyy-MM-dd'T'HH:mm:ss. GET /views/recommendations

Entity: segment

Attribute Name Type Description Endpoints
id string The system generated unique segment identifier. GET /user/segments
lifeStage string The life stages of the user i.e., STUDENT, EMPLOYED, UNEMPLOYED, or RETIRED. GET /user/segments
incomeRange string A user income range given by the user. Applicable values are: $0K - $35K, $35K - $50K, $50K - $75K, $75K - $100K, $100K - $150K, and $150K+. GET /user/segments
age integer A unique Identifier for user's age stored in insights database entered by the user. This attribute is optional and is present for a segment that is created for the given user. GET /user/segments
geoLocation entity The geo location details of the user. GET /user/segments
income money The total income of the user. GET /user/segments
networth money The total net worth of the user. GET /user/segments
homeOwnership boolean Indicates the home ownership of the user. GET /user/segments

Entity: geoLocation

Attribute Name Type Description Endpoints
state string The state details of the user. GET /user/segments
city string The city details of the user. GET /user/segments
country string The country details of the user. GET /user/segments
zipcode string The ZIP code details of the user. GET /user/segments

Enums: Type

Type Description
View Indicates that the entity type is view.
MERCHANT Indicates that the entity type is merchant.
CATEGORY Indicates that the entity type is master category.
DETAIL_CATEGORY Indicates that the entity type is detail category.

Enums: Rule Type

Rule Type Description
EXPENSE Indicates that the rule is an expense-related rule. For an EXPENSE rule type, the categoryType should also be EXPENSE.
INCOME Indicates that the rule is an income-related rule. For an INCOME rule type, the categoryType should be INCOME.

Enums: Merchant Type

Merchant Type Description
BILLERS Merchants that are identified as billers in the Yodlee merchant database.
SUBSCRIPTION Merchants that are identified as subscribers in the Yodlee merchant database.

Enums: State Codes

State Codes Abbreviation
Alabama AL
Alaska AK
American Samoa AS
Arizona AZ
Arkansas AR
California CA
Colorado CO
Connecticut CT
Delaware DE
District of Columbia DC
Federated States of Micronesia FM
Florida FL
Georgia GA
Guam GU
Hawaii HI
Idaho ID
Illinois IL
Indiana IN
Iowa IA
Kansas KS
Kentucky KY
Louisiana LA
Maine ME
Marshall Islands MH
Maryland MD
Massachusetts MA
Michigan MI
Minnesota MN
Mississippi MS
Missouri MO
Montana MT
Nebraska NE
Nevada NV
New Hampshire NH
New Jersey NJ
New Mexico NM
New York NY
North Carolina NC
North Dakota ND
Northern Mariana Islands MP
Ohio OH
Oklahoma OK
Oregon OR
Palau PW
Pennsylvania PA
Puerto Rico PR
Rhode Island RI
South Carolina SC
South Dakota SD
Tennessee TN
Texas TX
Utah UT
Vermont VT
Virgin Islands VI
Virginia VA
Washington WA
West Virginia WV
Wisconsin WI
Wyoming WY

Enums: Transaction Base Type

Base Type Description
CREDIT Denotes that the transactions are being credited to the account.
DEBIT Denotes that the transactions are getting debited to the account.

Enums: Transaction Category Type

Category Type Description
INCOME The transaction category belongs to an income type.
EXPENSE The transaction category belongs to an expense type.

Enums: Transaction Category Source

Category Source Description
SYSTEM The category assigned to the transaction is a system defined category.
 USER The category assigned to the transaction is a user defined category.

Enums: Transaction Source Type

Source Description
AGGREGATED Indicates that the transaction is aggregated from the provider site.
MANUAL Indicates that the transaction is created manually by the user.

Enums: Transaction Status

Status Description
POSTED Denotes that the transaction is realized on the account's balance.
PENDING Denotes that the transaction is not yet realized on the account's balance.
SCHEDULED Denotes that the transacation is a future dated transaction.
FAILED Denotes the failed transactions. It is only applicable to rejected claims in a Flexible Spending account.

Enums: Transaction Sub Type

Container Sub Type
bank, creditCard ACCOUNT_TO_ACCOUNT_TRANSFER 
ACCOUNT_VERIFICATION 
ACH_DEBIT 
ADJUSTMENT 
ANNUAL_FEE 
ATM_CASH_WITHDRAWAL 
ATM_TELLER_DEPOSIT 
AUTH_COMPLETE 
AUTH_HOLD 
AUTH_PROCESSING 
AUTH_RELEASE 
AUTH_REQUEST 
AUTH_VOID 
AUTO_LOAN 
BALANCE_ENQUIRY 
BALANCE_TRANSFER 
BANK_ADJUSTMENT 
BANK_DIRECT_DEPOSIT 
BANK_TO_BANK_TRANSACTION 
BANK_TO_NON_BANK_ACCOUNT_TRANSFER 
BILL_PAY_CHARGE 
CAPITAL_GAINS_DISTIBUTION 
CASH_ADVANCE 
CASH_WITHDRAWAL_AT_FI 
CG_LONG_TERM_DEPOSIT 
CHARGE_A_REPEAT_CUSTOMER 
CHARGES_FEES 
CHECK_DEPOSIT 
CHECK_IMAGE_SERVICE_CHARGE 
CHECKS_ORDERING_CHARGE 
CHILD_SUPPORT 
CONTACT_LESS_DEBIT 
CONVENIENCE_FEE 
CREDIT 
CREDIT_ADJUSTMENT 
CREDIT_CARD_CREDIT 
CREDIT_CARD_PAYMENT 
DEBIT 
DEBIT_CARD_FEE 
DEBIT_CARD_WITHDRAWAL_AT_STORE
DEFERRED_BILL_PAY 
DEFERRED_DEPOSIT 
DEPOSIT 
DEPOSITS_CREDITS 
DIRECT_DEPOSIT_SALARY 
DIVIDEND_DEPOSIT 
DOWN_PAYMENT_OR_ANNUITY_PAYMENT_OR_DIRECT_PAYMENT 
ELECTRONIC_PAYMENT 
FEE_PAYMENT 
FEE_REFUND 
FEE_VOID 
FINANCE_CHARGE 
FINANCE_CHARGE_REFUND 
HOLD_CHECK_PAYMENT 
HOME_LOAN_MORTGAGE 
INSTALLMENT_PAYMENT 
INSURANCE_PAYMENT 
INTEREST 
INTEREST_ADJUSTMENT 
INTEREST_CHECK 
INTEREST_SAVINGS 
INVESTMENT_INCOME_CASH 
LOAN 
MOBILE_REMOTE_DEPOSIT 
MONTHLY_MAINTENANCE_CHARGE 
NSF_FEES 
ONLINE_PURCHASE 
OPEN_SALE_DEPOSIT 
OTHER_CHARGES_FEES 
OTHER_DEPOSITS 
OTHER_WITHDRAWALS 
OVERDRAFT_CHARGE 
OVERDRAFT_PROTECTION 
OVERDRAFT_PROTECTION_CHARGE 
PAYMENT 
PAYMENT_BY_CHECK 
PAYMENT_PLAN 
PERSONAL_LOAN 
PERSONAL_LOAN_CREDIT 
PIN_DEBIT 
POS_DEBIT 
PRE_AUTH 
PRE_AUTH_COMPLETION 
PURCHASE 
PURCHASE_VOID 
PURCHASE_WITH_CREDIT_CARD 
PURCHASE_WITH_DEBIT_CARD 
PURCHASED_WITH_CHECK 
RECURRING_BILLING 
RECURRING_SUBSCRIPTION_PAYMENT 
REFUND 
REIMBURSEMENT 
RETURNED_CHECK_CHARGE 
RETURNED_CHECK_REIMBURSEMENT 
REWARDS 
SALES_TAX 
SERVICE_CHARGE 
SERVICE_CHARGE_FEE_REFUND 
SHORT_TERM_CREDIT 
SIGNATURE_DEBIT 
SSA 
STOP_PAYMENT_CHARGE 
STUDENT_LOAN 
TAX_PAYMENT 
TAX_REFUND 
TELLER_DEPOSIT 
TRANSACTION_VOID 
TRANSFER 
UTILITIES_PAYMENT
WIRE_TRANSFER 
WIRE_TRANSFER_CHARGE 
WITHDRAWAL

Enums: Transaction Merchant Source

Source Description
YODLEE The source that provided the merchant information is Yodlee.
FACTUAL The source that provided the merchant information is FACTUAL.

Enums: Transaction Type

Container Description
bank, creditCard AUTHORIZATION
BANK_ADJUSTMENT
CASH_ADVANCE
CHARGES_FEES
CREDIT
DEBIT
DEFERRED
DEPOSIT
DEPOSITS_CREDITS
INTEREST
OTHER_DEPOSITS
OTHER_WITHDRAWALS
PAYMENT
POS_DEBIT
PURCHASE
REFUND
TRANSFER
WITHDRAWAL
VOID

The views are validated based on category, merchant type or merchant name. All categories referenced in the following table are master level categories. To get the full list of all master level categories and their IDs, use the GET /transactions/categories API.

Recommendation ID View Name Category ID-based Rules Merchant-based Rules
1 Bills   merchantType = BILLERS
2 Subscriptions   merchantType = SUBSCRIPTION
3 Restaurants 22 (Restaurants/Dining)  
4 Automotive 2 (Automotive Expenses)
8 (Gasoline/Fuel)		  
5 Personal Care & Fashion 5 (Clothing/Shoes)
20 (Personal Care)		  
6 Entertainment 7 (Entertainment)  
7 Hobbies 34 (Hobbies)  
8 Childcare 4 (Child/Dependent Expenses)  
9 Groceries 10 (Groceries)  
10 Fast Food   7-Eleven
Arby's
Au Bon Pain
Auntie Anne's
Bojangles' Famous Chicken 'n Biscuits
Carl's Jr.
Charleys Philly Steaks
Chick-fil-A
China Wok
Chipotle Mexican Grill
Church's Chicken
Dairy Queen
Del Taco
Domino's Pizza
Dutch Bros. Coffee
Dunkin' Donuts
El Pollo Loco
Firehouse Subs
Five Guys
Fuzzy's Taco Shop
Hardee's
Hungry Howie's Pizza
In-N-Out Burger
Jack in the Box
Jersey Mike's Subs
Jimmy John's
KFC
Krispy Kreme
Little Caesars
McDonald's
Moe's Southwest Grill
Panda Express
Panera Bread
Papa John's Pizza
Peet's Coffee
Pizza Hut
Popeyes Louisiana Kitchen
Pollo Tropical
Potbelly
Pret a Manger
Qdoba Mexican Grill
Schlotzsky's
Shake Shack
Smashburger
Snack & Soda
Sonic Drive-In
Starbucks
Subway
Taco Bell
Taco Cabana
Tim Hortons
Wendy's
Whataburger
Which Wich Superior Sandwiches
White Castle
Zaxby's
11 Big Box Stores   Amazon
Academy Sports + Outdoors
Albertsons
Best Buy
Barnes & Noble
Bed Bath & Beyond
Big Lots
CVS Pharmacy
Corner Store
Costco
Dollar Tree
Dollar General
Dillard's
Dick's Sporting Goods
Family Dollar
HomeGoods
Hobby Lobby
Jo-Ann Stores
Kroger
Lowe's
Meijer
Michaels
Office Depot
Party City
Ross Stores
Sam's Club
Staples
Shoprite
Sears
Target
The Home Depot
Walgreens
Walmart
12 Refunds 114 (Expense Reimbursement)
227 (Refunds/Adjustments)		  
13 Income 29 (Paychecks/Salary)
30 (Investment Income)
32 (Other Income)
92 (Consulting)
94 (Sales)
96 (Interest)
98 (Services)		  
14 Healthcare 11 (Healthcare/Medical)  
15 Travel 23 (Travel)  
16 Fees 24 (Service Charges/Fees)  
17 Home Expenses 12 (Home Maintenance)
13 (Home Improvement)		  
18 Coffee   85C Bakery Café
Allegro Coffee
Au Bon Pain
Big Apple Bagels
Blue Bottle Coffee
Bruegger's
Cafe Metro
Caribou Coffee
Cinnabon
Corner Bakery Cafe
Crumbs
Dunkin' Donuts
Dutch Bros. Coffee
Ebar
Einstein Bros. Bagels
Financier Patisserie
Gregorys Coffee
Krispy Kreme
Le Pain Quotidien
Luby's
Maui Wowi
Mister Donut
My Favorite Muffin
Noah's Bagels
Paris Baguette
Peet's Coffee
Seattles Best Coffee
Shipley Do-Nuts
Specialty's Cafe & Bakery
Starbucks
Teavana
The Coffee Bean & Tea Leaf
The Great American Bagel
Wolferman's
19 Streaming   Amazon Prime Video
ATT Watch TV
Acorn Tv
AMC Networks
BlazeTV
Britbox
CBS All Access
Crunchyroll
Curiositystream
Dc Universe
Funimation
Fubotv
Gaia
HIDIVE
Hulu
Hallmark Movies Now
HBO Now
iTunes
Lifetime Movies
Laugh Out Loud
Netflix
Peacock
Playstation Vue
Philo
Pureflix
Pure Flix
Shudder
Sling Tv
Sundance Now
Showtime
Slice
Twitch
UP Faith & Family
Vault
Vrv
Vimeo
Vudu
Volta
YouTube Tv
20 Ride Sharing   Lyft
Uber
21 Hardware Stores   84 Lumber
A-boy Electric & Plumbing Supply
Ace Hardware
Aubuchon Hardware
Briggs Hardware
Distribution America
Do It Best
Handy Dan
Handy Hardware
Hi-School Pharmacy
Hi-school Pharmacy
Lowe'S
Menards
Orchard Supply Hardware
Parr Lumber
Pro Group
The Home Depot
True Value
Valu Home Centers
22 Pets 42 (Pets/Pet Care)  
23 Charity 3 (Charitable Giving)  
24 Education 6 (Education)  
25 Movie Theatre   AMC Theatres
Cinemark Theatres
Fandango
Regal Cinemas
26 Business Expenses 45 (Office Supplies)
100 (Advertising)
102 (Business Miscellaneous)
106 (Printing)
110 (Office Maintenance)
112 (Wages Paid)		  
27 Taxes 37 (Taxes)  
28 Video Games   Blizzard Entertainment
GameStop
Nintendo
Sony Playstation Networks
Steam
29 NYC Commuter   E-Zpass
NYC Taxi
Metropolitan Transportation Authority
NJ Transit
30 Discretionary Spending 3 (Charitable Giving)
5 (Clothing/Shoes)
7 (Entertainment)
9 (Gifts)
13 (Home Improvement)
15 (Cable/Satellite Services)
16 (Online Services)
20 (Personal Care)
22 (Restaurants/Dining)
23 (Travel)
34 (Hobbies)
38 (Telephone Services)
43 (Electronics)
44 (General Merchandise)
108 (Dues and Subscriptions)