Skip to main content

Update a spending plan iteration item

Use this endpoint to update an existing spending_plan_iteration_item.

PUT
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}

Path Parameters

FieldRequiredType

user_guid

The unique identifier for a user, beginning with the prefix USR-.

Required
String

spending_plan_guid

The unique ID for the spending_plan.

Required
String

iteration_item_guid

The unique ID for the iteration_item.

Required
String

Header Parameters

FieldRequiredType

Accept-Version

MX Platform API version.

Required
String

Request Body

Iteration item to be updated with required parameter (planned_amount)

FieldRequiredType

category_guid

The unique identifier for the category. Defined by MX.

Optional
String

item_type

The type of transaction grouping for the spending plan iteration_item (0 = RECURRING_EXPENSE, 1 = PLANNED_EXPENSE, 2 = OTHER_EXPENSE, 3 = INCOME).

Optional
Number

planned_amount

The total amount planned for a spending plan iteration_item.

Required
Number

scheduled_payment_guid

The unique identifier for the scheduled_payment_guid associated with the spending plan iteration_item. Defined by MX.

Optional
String

top_level_category_guid

The unique identifier for the top_level_category_guid associated with the spending plan iteration_item. Defined by MX.

Optional
String
Loading...