Nexus API
Monthly Cash Flow Profile Overview
The monthly cash flow profile provides an analysis of a user's income and expense patterns over time.
Monthly Cash Flow Profile Fields
To create, update, or reposition a goal, the monthly_cash_flow_profile must have a goals_contribution and estimated_goals_contribution value that is greater than 0.
| Field name` | Data type | Description |
|---|---|---|
budgeted_expenses | decimal | The amount of the budgeted expenses for the user. |
budgeted_income | decimal | The amount of the budgeted income for the user. |
estimated_goals_contribution | decimal | The estimated monthly dollar amount allocated for goals calculated from income and budgets. |
goals_contribution | decimal | The monthly dollar amount allocated for goals. |
guid | string | Unique identifier for the monthly cash flow profile. Defined by MX. |
user_guid | string | Unique identifier for the user the monthly cash flow profile is attached to. Defined by MX. |
uses_estimated_goals_contribution | boolean | If the user uses estimated goals contribution, this field will be true. Otherwise, this field will be false. |