Cash Flow Summary

Overview

The Cash Flow Summary insight is a schedule-trigger insight that gives an overview to users of the cash flow situation for an aggregated bank or card account.

Following are the additional details for the insight:

Insight Name	CASH_FLOW_SUMMARY
Applicable Entity	ACCOUNT
Insight Type	OTHER
Trigger Type	SCHEDULE
Supported Containers	BANK, CARD

Use Cases

Customer:
- User engagement
User:
- Financial planning - Understand cash flow and plan finances accordingly.

Suggested Action

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for each of the applicable entity ID.

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: Normal scenario: If the calendar week starts from 1st January to 7th January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar week starts from 1st January to 7th January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
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: Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

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 MONTHLY and the default duration for the insight is THREE_MONTHS.

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`	`2.1`
`Api-Version`	`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 2.1 Response

{
   "customerSubscription":[
      {
         "insightName":"CASH_FLOW_SUMMARY",
         "insightTitle":"Cash Flow Summary",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight that provides cash flow trends over a configured time period.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
      {
         "insightName":"CASH_FLOW_SUMMARY",
         "insightTitle":"Cash Flow Summary",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight that provides cash flow trends over a configured time period.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ]
      }
   ]
}

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes all the users from the Cash Flow Summary 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.	DAILY (Every day - Early Morning) WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning)
duration	The data range that should be considered for evaluating the insight.	THIS_MONTH LAST_MONTH THREE_MONTHS (Current Month + Last 2 Months) SIX_MONTHS (Current Month + Last 5 Months) ONE_YEAR (Current Month + Last 11 Months)

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"CASH_FLOW_SUMMARY",
         "insightTitle":"New Title",
         "customerConfiguration":[
            {
               "duration":"THREE_MONTHS",
               "isSubscribed":true,
               "entityType":"ACCOUNT",
               "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	Y800: Invalid value for duration; Supported values are THIS_MONTH, LAST_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR
400	Y802: For CASH_FLOW_SUMMARY insight passing threshold is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying applicableEntity is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying triggerType is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying container is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, 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 CASH_FLOW_SUMMARY 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.

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/userSubscriptions?insightName=CASH_FLOW_SUMMARY

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

Api-Version 2.1 Response

{
   "userSubscription":[
      {
         "insightName":"CASH_FLOW_SUMMARY",
         "insightTitle":"Cash Flow Summary",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight that provides cash flow trends over a configured time period.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType": "ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
      {
         "insightName":"CASH_FLOW_SUMMARY",
         "insightTitle":"Cash Flow Summary",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight that provides cash flow trends over a configured time period.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType": "ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ]
      }
   ]
}

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
entityId	The ID of the account for which the account gets evaluated.	Valid IDs for accounts belonging to the user
isSubscribed	Subscribes or unsubscribes from the Cash Flow Summary insight.	true, false
frequency	The frequency at which an insight will be evaluated.	DAILY (Every day - Early Morning) WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning)
duration	The data range that should be considered for evaluating the insight.	THIS_MONTH LAST_MONTH THREE_MONTHS (Current Month + Last 2 Months) SIX_MONTHS (Current Month + Last 5 Months) ONE_YEAR (Current Month + Last 11 Months)

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"CASH_FLOW_SUMMARY",
         "userConfiguration":[
            {
               "duration":"THREE_MONTHS",
               "isSubscribed":true,
               "entityType": "ACCOUNT",
               "entityId": "10255809",
               "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 CASH_FLOW_SUMMARY insight
400	Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY
400	Y800: Invalid value for duration; Supported values are THIS_MONTH, LAST_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR
400	Y800: Invalid value for entityId; This id is either invalid or not supported for this insight.
400	Y802: For CASH_FLOW_SUMMARY insight passing threshold is not allowed
400	Y802: Modifying insightTitle using this API is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying applicableEntity is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying triggerType is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying container is not allowed
400	Y802: For insight CASH_FLOW_SUMMARY, modifying description is not allowed
400	Y802: Duplicate entityId entries within userConfiguration 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	Y800: Invalid value for userConfiguration; entityId should be provided.
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	Y802: Duplicate entityId entries is not allowed
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 CASH_FLOW_SUMMARY 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 Cash Flow Summary insight.

Calculation Logic for Derived Attributes:

Calculations for the detail entity for each month-
- cashInFlow = (All the credit transactions of income categories - All the debit transactions of income categories) + Uncategorized credit transactions
- cashOutFlow = (All the debit transactions of expense categories - All the credit transactions of expense categories) + Uncategorized debit transactions
- transferIn = All the credit transactions of transfer categories
- transferOut = All the debit transactions of transfer categories
- netTransfer = transferIn - transferOut
- totalCashFlow = cashInFlow - cashOutFlow + netTransfer
Calculations for the cashFlowTrend entity -
- cashInFlow = Sum of the all cashInFlow amounts for the specified duration from the detail entity
- cashOutFlow = Sum of the all cashOutFlow amounts for the specified duration from the detail entity
- transferIn = Sum of the all transferIn amounts for the specified duration from the detail entity
- transferOut = Sum of the all transferOut amounts for the specified duration from the detail entity
- netTransfer = Sum of the all netTransfer amounts for the specified duration from the detail entity
- totalCashFlow = Sum of the all totalCashFlow amounts for the specified duration from the detail entity
- averageNetCashFlow = Sum of the all totalCashFlow amounts for the specified duration from the detail entity / duration in months

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=CASH_FLOW_SUMMARY

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "feed":[
      {
         "id":"60d43dbed59fdb46b0c91212",
         "insightName":"CASH_FLOW_SUMMARY",
         "insightTitle":"Cash Flow Summary",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-24T08:09:31Z",
         "subscription":[
            {
               "entityId":"13709568",
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS"
            }
         ],
         "basicAccount":[
            {
               "id":13709568,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709568"
               },
               "basicTrend":[
                  {
                     "dateRange":{
                        "fromDate":"2021-04-01",
                        "toDate":"2021-06-24"
                     },
                     "cashFlowTrend":[
                        {
                           "cashInFlow":{
                              "amount":11196.44,
                              "currency":"USD"
                           },
                           "cashOutFlow":{
                              "amount":113875.76,
                              "currency":"USD"
                           },
                           "transferIn":{
                              "amount":0.0,
                              "currency":"USD"
                           },
                           "transferOut":{
                              "amount":0.0,
                              "currency":"USD"
                           },
                           "netTransfer":{
                              "amount":0.0,
                              "currency":"USD"
                           },
                           "averageNetCashFlow":{
                              "amount":-34226.44,
                              "currency":"USD"
                           },
                           "totalCashFlow":{
                              "amount":-102679.32,
                              "currency":"USD"
                           },
                           "detail":[
                              {
                                 "dateRange":{
                                    "fromDate":"2021-06-01",
                                    "toDate":"2021-06-24"
                                 },
                                 "cashInFlow":{
                                    "amount":7865.48,
                                    "currency":"USD"
                                 },
                                 "cashOutFlow":{
                                    "amount":103015.76,
                                    "currency":"USD"
                                 },
                                 "transferIn":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "transferOut":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "netTransfer":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "totalCashFlow":{
                                    "amount":-95150.28,
                                    "currency":"USD"
                                 }
                              },
                              {
                                 "dateRange":{
                                    "fromDate":"2021-05-01",
                                    "toDate":"2021-05-31"
                                 },
                                 "cashInFlow":{
                                    "amount":1665.48,
                                    "currency":"USD"
                                 },
                                 "cashOutFlow":{
                                    "amount":5430.0,
                                    "currency":"USD"
                                 },
                                 "transferIn":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "transferOut":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "netTransfer":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "totalCashFlow":{
                                    "amount":-3764.52,
                                    "currency":"USD"
                                 }
                              },
                              {
                                 "dateRange":{
                                    "fromDate":"2021-04-01",
                                    "toDate":"2021-04-30"
                                 },
                                 "cashInFlow":{
                                    "amount":1665.48,
                                    "currency":"USD"
                                 },
                                 "cashOutFlow":{
                                    "amount":5430.0,
                                    "currency":"USD"
                                 },
                                 "transferIn":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "transferOut":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "netTransfer":{
                                    "amount":0.0,
                                    "currency":"USD"
                                 },
                                 "totalCashFlow":{
                                    "amount":-3764.52,
                                    "currency":"USD"
                                 }
                              }
                           ]
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ]
}