Read a spending plan iteration item
Use this endpoint to read the attributes of a specific spending plan iteration_item according to its unique GUID.
Authorizations
To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'
Headers
MX Platform API version.
"v20250224"
Path Parameters
The unique identifier for a user, beginning with the prefix USR-.
The unique ID for the spending_plan.
The unique ID for the iteration_item.
Query Parameters
Results are paginated. Specify current page.
This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.
Response
OK
The sum of the transactions associated with the spending plan iteration_item.
345
The unique identifier for the category. Defined by MX.
"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e"
The date and time the spending plan iteration item was created, represented in ISO 8601 format with a timestamp.
"2025-02-13T18:08:00+00:00"
The unique identifier for the spending plan iteration_item. Defined by MX.
"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262"
The type of transaction grouping for the spending plan iteration_item (0 = RECURRING_EXPENSE, 1 = PLANNED_EXPENSE, 2 = OTHER_EXPENSE, 3 = INCOME).
0, 1, 2, 3 1
The total amount planned for a spending plan iteration_item.
110
The unique identifier for the scheduled_payment_guid associated with the spending plan iteration_item. Defined by MX.
"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b"
The unique identifier for the spending plan iteration_item. Defined by MX.
"SPI-848e6648-3fa3-4632-ac8f-e65f03167102"
The unique identifier for the top_level_category_guid associated with the spending plan iteration_item. Defined by MX.
"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8"
An array of transaction GUIDs that are relevant to the spending plan iteration_item. Defined by MX.
"TRN-265abee9-889b-af6a-c69b-25157db2bdd9"
The date and time the resource was last updated in ISO 8601 format with a timestamp.
For categories, this field will always be null when is_default is true.
"2025-02-13T18:09:00+00:00"
The unique identifier for the user. Defined by MX.
"USR-fa7537f3-48aa-a683-a02a-b18940482f54"

