Financial Forecast
Overview
The Financial Forecast insight is a schedule-triggered insight that offers a projected view of users’ finances for a given duration (decided by the frequency) considering all their aggregated bank and card accounts.
The Predicted Cash Flow feature should be enabled as a pre-requisite for this insight.
Following are the additional details for the insight:
| Insight Name | FINANCIAL_FORECAST |
|---|---|
| Applicable Entity | ACCOUNT |
| Insight Type | AGGREGATE |
| Trigger Type | SCHEDULE |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- User engagement
- User:
- Financial wellness - Confidently plan ahead.
Suggested Action
Suggest the users to plan their finances accordingly with some additional buffer.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated once per scheduled frequency for a user.
Following are the applicable frequencies for this insight:
| Frequency | Description | |
|---|---|---|
| DAILY | The insight will be triggered daily. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current day from 12:00 AM same day to the time of insight evaluation. | |
| WEEKLY | The insight will be triggered once every Monday. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar week (Monday to Sunday). For example:
|
|
| MONTHLY | The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month). For example:
|
|
Insight Dynamic Trigger (On-Demand Evaluation)
The insight can be triggered using the following on-demand insight trigger API:
POST /insights/trigger
Peer Benchmarking Data
This insight does not provide peer benchmarking data.
Thresholds
Threshold does not apply to this insight.
GET Customer Subscription
The GET customer subscription API provides all the information about the defaults set for the insights that are subscribed by the customer. The default frequency for the insight is WEEKLY.
Method and URL:
GET /insights/configs/customerSubscriptions
Header Parameters:
| Key | Value | |
|---|---|---|
Authorization |
Client credentials-based authorization | Bearer {{Access Token}} |
| API key-based authentication | Bearer {{JWT Token_Customer}} |
|
| Deprecated cobrand and user credential-based authentication | cobSession={cobSession received in the cobrand login service} |
|
Content-Type |
application/json |
|
Api-Version |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/configs/customerSubscriptions
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
- Api-Version 3.0 and 2.1 Response
{
"customerSubscription":[
{
"insightName": "FINANCIAL_FORECAST",
"insightTitle": "Financial Forecast",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight that provides information about upcoming financial activity of the user",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "WEEKLY"
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "FINANCIAL_FORECAST",
"insightTitle": "Financial Forecast",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight that provides information about upcoming financial activity of the user",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "WEEKLY"
}
]
}
]
}
PATCH Customer Subscription
Using the PATCH API for customer subscription, customers can change the defaults for each insight. Alternatively, customers can use the insights configuration tool to achieve the same result.
Warning! Changing any defaults can potentially impact all users who have subscribed to this insight. If the user has overridden the customer threshold, then the user preference will be applied. For all other users, the new defaults will apply.
Method and URL:
PATCH /insights/configs/customerSubscriptions
Header Parameters:
| Key | Value | |
|---|---|---|
Authorization |
Client credentials-based authorization | Bearer {{Access Token}} |
| API key-based authentication | Bearer {{JWT Token_Customer}} |
|
| Deprecated cobrand and user credential-based authentication | cobSession={cobSession received in the cobrand login service} |
|
Content-Type |
application/json |
|
Api-Version |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| isSubscribed | Subscribes or unsubscribes all the users from the Financial Forecast insight. | true, false |
| insightTitle | The title returned in the GET feed API as well as the insights configuration tool can be changed. | Alphanumeric characters up to 100 characters (including spaces) |
| frequency | The frequency at which an insight will be evaluated. |
|
Sample Request:
{
"customerSubscription": [
{
"insightName": "FINANCIAL_FORECAST",
"insightTitle": "Financial Forecast",
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "DAILY"
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid Input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for insightTitle; special characters ><\""'%{}|^~[] are not supported. |
| 400 | Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed. |
| 400 | Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY |
| 400 | Y802: Specifying duration attribute for FINANCIAL_FORECAST insight is not allowed |
| 400 | Y802: For FINANCIAL_FORECAST insight passing threshold is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying applicableEntity is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying triggerType is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying container is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying description is not allowed |
| 400 | Y800: Invalid value for isSubscribed; Supported values are true, false |
| 400 | Y825: Update not allowed without a valid request body |
| 400 | Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required |
| 400 | Y812: Required field/value - insightName missing in the request |
| 400 | Y802: Modifying InsightType attribute is not allowed |
| 400 | Y813: entityType should be provided |
| 400 | Y803: At least one additional attribute is required in addition to entityType. |
| 400 | Y800: Invalid value for customerConfiguration; customerConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes |
| 400 | Y800: Invalid value for entityType. Supported entityType for FINANCIAL_FORECAST insight are - [ACCOUNT] |
| 400 | Y800: Invalid value for input json |
| 401 | Y020: Invalid token in authorization header |
| 401 | Y020: Token has expired |
GET User Subscription
The GET user subscription API provides all the information about the user defaults set for the insight.
The entityId filter does not apply to this insight.
Method and URL:
GET /insights/configs/userSubscriptions
Header Parameters:
| Key | Value | |
|---|---|---|
Authorization |
Client credentials-based authorization | Bearer {{Access Token}} |
| API key-based authentication | Bearer {{JWT Token_Customer}} |
|
| Deprecated cobrand and user credential-based authentication | cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service} |
|
Content-Type |
application/json |
|
Api-Version |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/configs/userSubscriptions?insightName=FINANCIAL_FORECAST
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
- Api-Version 3.0 and 2.1 Response
{
"userSubscription":[
{
"insightName": "FINANCIAL_FORECAST",
"insightTitle": "Financial Forecast",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight that provides information about upcoming financial activity of the user",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "WEEKLY"
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "WEEKLY"
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName": "FINANCIAL_FORECAST",
"insightTitle": "Financial Forecast",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight that provides information about upcoming financial activity of the user",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "WEEKLY"
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "WEEKLY"
}
]
}
]
}
PATCH User Subscription
Using the PATCH user subscription API for user subscription, users can change the defaults for each insight. If the user wants the insight to be evaluated for a new account, then add that account using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.
Method and URL:
PATCH /insights/configs/userSubscriptions
Header Parameters:
| Key | Value | |
|---|---|---|
Authorization |
Client credentials-based authorization | Bearer {{Access Token}} |
| API key-based authentication | Bearer {{JWT Token_Customer}} |
|
| Deprecated cobrand and user credential-based authentication | cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service} |
|
Content-Type |
application/json |
|
Api-Version |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| isSubscribed | Subscribes or unsubscribes from the Financial Forecast insight. | true, false |
| frequency | The frequency at which an insight will be evaluated. |
|
Sample Request:
{
"userSubscription":[
{
"insightName":"FINANCIAL_FORECAST",
"userConfiguration":[
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "DAILY"
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in FINANCIAL_FORECAST insight |
| 400 | Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY |
| 400 | Y802: Specifying duration attribute for FINANCIAL_FORECAST insight is not allowed |
| 400 | Y802: For FINANCIAL_FORECAST insight passing threshold is not allowed |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying applicableEntity is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying triggerType is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying container is not allowed |
| 400 | Y802: For insight FINANCIAL_FORECAST, modifying description is not allowed |
| 400 | Y800: Invalid value for isSubscribed; Supported values are true, false |
| 400 | Y825: Update not allowed without a valid request body |
| 400 | Y802: For insight FINANCIAL_FORECAST, configurations at an entityId level are not allowed |
| 400 | Y812: Required field/value - insightName missing in the request |
| 400 | Y802: Modifying InsightType attribute is not allowed |
| 400 | Y813: entityType should be provided |
| 400 | Y803: At least one additional attribute is required in addition to entityType. |
| 400 | Y800: Invalid value for userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes |
| 400 | Y800: Invalid value for entityType. Supported entityType for FINANCIAL_FORECAST insight are - [ACCOUNT] |
| 400 | Y800: Invalid value for input json |
| 401 | Y020: Invalid token in authorization header |
| 401 | Y020: Token has expired |
GET Insight Feeds
The GET insights feed API retrieves all or a subset of the valid insight notifications generated for a particular user. However, using the insightName filter, you can specifically request for the Financial Forecast insight.
The entityId filter does not apply to this insight.
Calculation Logic for Derived Attributes:
totalAvailableBalance= Sum of available balance (bank) & available credit (card)predictedBalance=availableBalance+ (Sum of all the transactions where thebaseTypeis identified ascredit) - (Sum of all the transactions where thebaseTypeis identified asdebit)predictedIncome= Sum of all the transactions where thebaseTypeis identified ascredit.predictedExpense= Sum of all the transactions where thebaseTypeis identified asdebit.
Method and URL:
GET /insights/feed
Header Parameters:
| Key | Value | |
|---|---|---|
Authorization |
Client credentials-based authorization | Bearer {{Access Token}} |
| API key-based authentication | Bearer {{JWT Token_Customer}} |
|
| Deprecated cobrand and user credential-based authentication | cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service} |
|
Content-Type |
application/json |
|
Api-Version |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/feed?insightName=FINANCIAL_FORECAST
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60d43db8d59fdb46b0c911f6",
"insightName":"FINANCIAL_FORECAST",
"insightTitle":"Financial Forecast",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-24T08:09:26Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"WEEKLY"
}
],
"dateRange":{
"fromDate":"2021-06-24T00:00:00",
"toDate":"2021-06-30T23:59:59"
},
"accountDerived":{
"totalAvailableBalance":{
"amount":256054.99,
"currency":"USD"
}
},
"predictedInfo":{
"predictedBalance":{
"amount":16560.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":1440.0,
"currency":"USD"
}
},
"bankAccount":[
{
"id":13709572,
"providerName":"Dag Site",
"accountName":"PDV Test Data- All Category",
"accountType":"OTHER",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709572"
},
"availableBalance":{
"amount":6000.0,
"currency":"USD"
},
"currentBalance":{
"amount":6500.0,
"currency":"USD"
},
"balance":{
"amount":6500.0,
"currency":"USD"
},
"lastUpdated":"2021-06-24T08:08:51Z",
"predictedInfo":{
"predictedBalance":{
"amount":0.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":0.0,
"currency":"USD"
}
}
},
{
"id":13709571,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709571"
},
"availableBalance":{
"amount":18000.0,
"currency":"USD"
},
"currentBalance":{
"amount":18000.0,
"currency":"USD"
},
"balance":{
"amount":18000.0,
"currency":"USD"
},
"lastUpdated":"2021-06-24T08:08:51Z",
"predictedInfo":{
"date":"2021-06-30",
"predictedBalance":{
"amount":16560.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":1440.0,
"currency":"USD"
}
},
"basicTransaction":[
{
"id":19504258,
"amount":{
"amount":740.0,
"currency":"USD"
},
"date":"2021-06-30",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504258"
},
"categoryId":15,
"category":"Cable/Satellite Services",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"BILL PAY COMCAST CABLE CO ON-LINE xxxxxxxxxxx00000 ON 00-00",
"consumer":"COMCAST CABLE CO ON-LINE XX0000 ON x0-00"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"BILLERS",
"basicMerchant":{
"name":"Comcast"
}
},
{
"id":19504055,
"amount":{
"amount":100.0,
"currency":"USD"
},
"date":"2021-06-29",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504055"
},
"categoryId":39,
"category":"Utilities",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"Duke Energy FL Bill Payment",
"consumer":"Duke Energy FL"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"BILLERS",
"basicMerchant":{
"name":"Duke Energy"
}
},
{
"id":19504083,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-06-28",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504083"
},
"categoryId":20,
"category":"Personal Care",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"RECURRING PAYMENT AUTHORIZED ON 00/00 LA FITNESS 000-000-0000 CA S000000000000000 CARD 0000",
"consumer":"RECURRING AUTHORIZED ON 00/00 LA FITNESS XX-0000 CA SXX0000 CARD 0000"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
},
{
"id":19504139,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-06-25",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504139"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"NetFlix Payment",
"consumer":"NetFlix"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Netflix"
}
}
]
},
{
"id":13709570,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Account_Balance",
"accountType":"SAVINGS",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709570"
},
"availableBalance":{
"amount":51999.99,
"currency":"USD"
},
"currentBalance":{
"amount":51999.99,
"currency":"USD"
},
"balance":{
"amount":51999.99,
"currency":"USD"
},
"lastUpdated":"2021-06-24T08:08:51Z",
"predictedInfo":{
"predictedBalance":{
"amount":0.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":0.0,
"currency":"USD"
}
}
},
{
"id":13709569,
"providerName":"Dag Site",
"accountName":"PDV Test Data- Account Balance",
"accountType":"SAVINGS",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709569"
},
"availableBalance":{
"amount":5.0,
"currency":"USD"
},
"currentBalance":{
"amount":5.0,
"currency":"USD"
},
"balance":{
"amount":5.0,
"currency":"USD"
},
"lastUpdated":"2021-06-24T08:08:51Z",
"predictedInfo":{
"predictedBalance":{
"amount":0.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":0.0,
"currency":"USD"
}
}
},
{
"id":13709568,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709568"
},
"availableBalance":{
"amount":180000.0,
"currency":"USD"
},
"currentBalance":{
"amount":180000.0,
"currency":"USD"
},
"balance":{
"amount":180000.0,
"currency":"USD"
},
"lastUpdated":"2021-06-24T08:08:51Z",
"predictedInfo":{
"predictedBalance":{
"amount":0.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":0.0,
"currency":"USD"
}
}
},
{
"id":13709567,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data_Sch/Ref",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709567"
},
"availableBalance":{
"amount":50.0,
"currency":"USD"
},
"currentBalance":{
"amount":50.0,
"currency":"USD"
},
"balance":{
"amount":50.0,
"currency":"USD"
},
"lastUpdated":"2021-06-24T08:08:51Z",
"predictedInfo":{
"predictedBalance":{
"amount":0.0,
"currency":"USD"
},
"predictedIncome":{
"amount":0.0,
"currency":"USD"
},
"predictedExpense":{
"amount":0.0,
"currency":"USD"
}
}
}
]
}
]
}