Read current iteration - MX Documentation

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Path Parameters

spending_plan_guid

string

required

The unique identifier for the spending plan. Defined by MX.

Response

200 - application/vnd.mx.nexus.v1+json

iteration

object

Hide child attributes

iteration.created_at

string | null

The date and time at which the spending_plan_iteration was created.

Example:

"2016-10-13T18:08:00+00:00"

iteration.end_on

string | null

The date the spending plan iteration ends.

Example:

"2023-05-31T00:00:00.000Z"

iteration.guid

string | null

The unique identifier for the spending_plan_account. Defined by MX.

Example:

"SPI-848e6648-3fa3-4632-ac8f-e65f03167102"

iteration.iteration_number

integer | null

The current iteration number for the spending plan iteration.

Example:

1

iteration.spending_plan_guid

string | null

The unique identifier for the spending_plan associated with the spending_plan_account. Defined by MX.

Example:

"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600"

iteration.start_on

string | null

The date the spending plan iteration starts.

Example:

"2023-05-01T00:00:00.000Z"

iteration.updated_at

string | null

The date and time at which the spending_plan_account was most recently updated.

Example:

"2016-10-13T18:09:00.000Z"

iteration.user_guid

string | null

The unique identifier for the user to which the spending_plan_account belongs. Defined by MX.

Example:

"USR-72086f59-6684-4adf-8f29-c4d32db43cd7"

pagination

object

Hide child attributes

pagination.current_page

integer

Example:

1

pagination.per_page

integer

Example:

25

pagination.total_entries

integer

Example:

1

pagination.total_pages

integer

Example:

1