Spending Plan Overview - MX Documentation

Spending plans help users create and manage budgets by forecasting income and planned expenses.

Spending Plan Fields

Field name	Data type	Definition
`created_at`	String	The date and time at which the `spending_plan` was created.
`current_iteration_number`	Integer	The current active associated `spending_plan_iteration` number for a given `spending_plan`.
`guid`	String	The unique identifier for the `spending_plan`. Defined by MX.
`updated_at`	String	The date and time at which the `spending_plan` was most recently updated.
`user_guid`	String	The unique identifier for the user to which the `spending_plan` belongs. Defined by MX.

Spending Plan Account Fields

Field Name	Data type	Definition
`account_guid`	String	The unique identifier for the account associated with the `spending_plan_account`. Defined by MX.
`created_at`	String	The date and time at which the `spending_plan_account` was created.
`guid`	String	The unique identifier for the `spending_plan_account`. Defined by MX.
`spending_plan_guid`	String	The unique identifier for the `spending_plan` associated with the `spending_plan_account`. Defined by MX.
`updated_at`	String	The date and time at which the `spending_plan_account` was most recently updated.
`user_guid`	String	The unique identifier for the user to which the `spending_plan_account` belongs. Defined by MX.

Spending Plan Iteration Fields

Field Name	Data type	Definition
`created_at`	String	The date and time at which the `spending_plan_iteration` was created.
`end_on`	String	The date the spending plan iteration ends.
`guid`	String	The unique identifier for the `spending_plan_account`. Defined by MX.
`iteration_number`	Integer	The current iteration number for the spending plan iteration.
`spending_plan_guid`	String	The unique identifier for the `spending_plan` associated with the `spending_plan_account`. Defined by MX.
`start_on`	String	The date the spending plan iteration starts.
`updated_at`	String	The date and time at which the `spending_plan_account` was most recently updated.
`user_guid`	String	The unique identifier for the user to which the `spending_plan_account` belongs. Defined by MX.

Spending Plan Iteration Item Fields

Field Name	Data type	Definition
`actual_amount`	Decimal	The sum of the transactions associated with the `spending_plan_iteration_item`.
`category_guid`	String	The unique identifier for the `category_guid` associated with the `spending_plan_iteration_item`. Defined by MX.
`created_at`	String	The date and time at which the `spending_plan_iteration_item` was created.
`guid`	String	The unique identifier for the `spending_plan_iteration_item`. Defined by MX.
`item_type`	String	The type of transaction grouping for the `spending_plan_iteration_item`.
		0 = RECURRING_EXPENSE, 1 = PLANNED_EXPENSE, 2 = OTHER_EXPENSE, 3 = INCOME.
`planned_amount`	Decimal	The total amount planned for a `spending_plan_iteration_item`.
`scheduled_payment_guid`	String	The unique identifier for the `scheduled_payment_guid` associated with the `spending_plan_iteration_item`. Defined by MX.
`spending_plan_iteration_guid`	String	The unique identifier for the `spending_plan_iteration_item`. Defined by MX.
`top_level_category_guid`	String	The unique identifier for the `top_level_category_guid` associated with the `spending_plan_iteration_item`. Defined by MX.
`transaction_guids`	Array	An array of transaction GUIDs that are relevant to the `spending_plan_iteration_item`. Defined by MX.
`updated_at`	String	The date and time at which the `spending_plan_iteration_item` was most recently updated.
`user_guid`	String	The unique identifier for the user to which the `spending_plan_iteration_item` belongs. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user associated with the `spending_plan_iteration_item`.

Create a spending plan