Goals Overview

Use these endpoints to create and manage goals for a user. You can also reposition goals to adjust their priority levels.

Every goal has a track type and a meta type.

The track type is the overall classification of the goal (debt, savings, retirement, or emergency fund) while the meta type is the specific classification (like college, house, vacation, and so on).

Goal Fields

Field Name	Data Type	Description
account_guid	String	Unique identifier for the goal. Defined by MX.
amount	Decimal	The amount of the goal.
completed_at	String	Date and time the goal was completed, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
current_amount	Decimal	The current amount of the goal.
goal_type_name	String	The type of goal. Can be SAVE_AMOUNT or PAYOFF.
guid	String	Unique identifier for the goal. Defined by MX.
has_been_spent	Boolean	If the goal has been spent, this field will be true. Otherwise, this field will be false.
is_complete	Boolean	If the goal is complete, this field will be true. Otherwise, this field will be false.
meta_type_name	String	The category of the goal; see Goal Meta Type for more information.
metadata	String	Additional information a partner can store on the goal.
name	String	The name of the goal that is visible to the user (i.e., "Europe Trip", "Savings", "Toyota Tacoma", etc).
position	Integer	The priority of the goal in relation to multiple goals.
projected_to_complete_at	String	Date and time the goal is projected to be completed, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
targeted_to_complete_at	String	Date and time the goal is to complete, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). Intended for users to set their own goal completion dates.
track_type_name	String	The track of the goal; see Goal Track Type for more information.
user_guid	String	Unique identifier for the user the goal is attached to. Defined by MX.

Goal Meta Type

• AUTOMOBILE
• COLLEGE
• ELECTRONIC
• EMERGENCY_FUND
• HOUSE
• OTHER
• RECREATIONAL_VEHICLE
• RETIREMENT
• SETUP_BUDGETS
• START_MONEY_MANAGEMENT
• VACATION

Goal Track Type

• DEBT_TRACK
• SAVINGS_TRACK
• RETIREMENT_TRACK
• EMERGENCY_FUND_TRACK