MX Technologies

MX Technologies spending plan API

The spending plan API from MX Technologies — 9 operation(s) for spending plan.

GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items Add a planned item to a spending plan · Create spending plan iteration item #
Ask an LLM
“How do I add a planned amount for a category, like groceries, to a user's spending plan?”
“Can a spending plan item be tied to a scheduled payment instead of a category?”
Tell an agent
Add a {amount} planned item for category {category} to spending plan {plan} of user {user}.
Create a {item_type} item of {amount} in user {user}'s spending plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items List line items in a spending plan · List spending plan iteration items #
Ask an LLM
“What planned expenses and income items are in a user's current spending plan period?”
“Can I see every iteration item a spending plan contains, page by page?”
Tell an agent
List the iteration items in spending plan {plan} for user {user}.
Show all planned line items for user {user}'s spending plan {plan}, {per_page} per page.
POST /users/{user_guid}/spending_plans Create a spending plan for a user · Create spending plan #
Ask an LLM
“How do I start a new spending plan for someone?”
“Can I set up a monthly spending plan for a user with one call?”
Tell an agent
Create a spending plan for user {user}.
Start a new spending plan on user {user}'s profile.
GET /users/{user_guid}/spending_plans List a user's spending plans · List spending plans #
Ask an LLM
“Does this user already have a spending plan set up?”
“Which spending plans exist for a user?”
Tell an agent
List spending plans for user {user}.
Show every spending plan user {user} has, page {page}.
DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} Remove an account from a spending plan · Delete spending plan account #
Ask an LLM
“How do I drop an account out of a user's spending plan?”
“Can I stop a spending plan from counting a particular account?”
Tell an agent destructive · confirm first
Delete spending plan account {plan_account} from plan {plan} for user {user}.
Remove account {plan_account} from user {user}'s spending plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} Read an account attached to a spending plan · Read spending plan account #
Ask an LLM
“How do I see the details of one account included in a user's spending plan?”
“What does a spending plan account record contain?”
Tell an agent
Get spending plan account {plan_account} in plan {plan} for user {user}.
Read the linked account {plan_account} of user {user}'s spending plan {plan}.
DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} Delete a line item from a spending plan · Delete spending plan iteration item #
Ask an LLM
“How do I take a planned expense out of a user's spending plan?”
“Can I remove a single iteration item without deleting the whole plan?”
Tell an agent destructive · confirm first
Delete iteration item {item} from spending plan {plan} for user {user}.
Remove line item {item} from user {user}'s plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} Read one spending plan line item · Read a spending plan iteration item #
Ask an LLM
“How much was planned for a single line item in a spending plan?”
“Can I look up one spending plan iteration item by its GUID?”
Tell an agent
Get iteration item {item} in spending plan {plan} for user {user}.
Show the planned amount on line item {item} of user {user}'s plan {plan}.
PUT /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} Change a planned amount in a spending plan · Update a spending plan iteration item #
Ask an LLM
“How do I raise or lower the planned amount on an existing spending plan item?”
“Can I move an existing plan item to a different category?”
Tell an agent
Set line item {item} in spending plan {plan} for user {user} to {amount}.
Update user {user}'s plan item {item} in plan {plan} to {amount} under category {category}.
DELETE /users/{user_guid}/spending_plans/{spending_plan_guid} Delete a user's spending plan · Delete spending plan #
Ask an LLM
“How do I get rid of a user's entire spending plan?”
“Can a user throw away their spending plan and start over?”
Tell an agent destructive · confirm first
Delete spending plan {plan} for user {user}.
Remove user {user}'s whole spending plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid} Read a user's spending plan · Read a spending plan for a user #
Ask an LLM
“How do I retrieve the settings of a specific spending plan?”
“What attributes does MX return for one spending plan?”
Tell an agent
Get spending plan {plan} for user {user}.
Read the attributes of user {user}'s spending plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts List accounts included in a spending plan · List spending plan accounts #
Ask an LLM
“Which of a user's accounts feed into their spending plan?”
“Can I list all spending plan accounts for one plan?”
Tell an agent
List the accounts in spending plan {plan} for user {user}.
Show which accounts user {user}'s plan {plan} tracks.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations List the periods of a spending plan · List spending plan iterations #
Ask an LLM
“How do I see past and present periods of a user's spending plan?”
“Can I list every iteration a spending plan has gone through?”
Tell an agent
List iterations of spending plan {plan} for user {user}.
Show the history of periods in user {user}'s spending plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current Read the current spending plan period · Read current spending plan iteration #
Ask an LLM
“Where does a user stand in this month's spending plan?”
“How do I fetch the active iteration of a spending plan?”
Tell an agent
Get the current iteration of spending plan {plan} for user {user}.
Show this period's numbers for user {user}'s plan {plan}.
GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} Read a spending plan period by number · Read a spending plan iteration #
Ask an LLM
“Can I look back at a specific earlier period of a spending plan by its iteration number?”
“How did a user do in iteration 3 of their spending plan?”
Tell an agent
Get iteration {number} of spending plan {plan} for user {user}.
Show period number {number} from user {user}'s plan {plan}.

Documentation

📖
Documentation
https://docs.mx.com/api-reference/platform-api/overview/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mx-technologies/refs/heads/main/openapi/mx-technologies-spending-plan-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mx-technologies/refs/heads/main/json-schema/mx-technologies-platform-api.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/mx-technologies/refs/heads/main/examples/mx-technologies-platform-api-examples.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mx-technologies:mx-technologies-spending-plan-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mx-technologies-spending-plan-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mx Technologies spending plan API
  contact:
    name: MX Platform API
    url: https://www.mx.com/products/platform-api
  version: '1.0'
  description: 'Operations tagged spending plan across 2 of this provider''s published API definitions: mx-technologies-platform-openapi.yml, mx-technologies-platform-v20250224-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://int-api.mx.com
- url: https://api.mx.com
security:
- basicAuth: []
tags:
- name: spending plan
paths:
  /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items:
    post:
      description: This endpoint creates a new `spending_plan_iteration_item`.
      operationId: createSpendingPlanIterationItem
      parameters:
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/userGuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpendingPlanIterationItemCreateRequestBody'
        description: Iteration item to be created with required parameter (planned_amount)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationItemResponse'
          description: OK
      summary: Create spending plan iteration item
      tags:
      - spending plan
    get:
      description: Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
      operationId: listSpendingPlanIterationItems
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationItemsResponseBody'
          description: OK
      summary: List spending plan iteration items
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans:
    post:
      description: This endpoint creates a new `spending_plan` for the user.
      operationId: createSpendingPlan
      parameters:
      - $ref: '#/components/parameters/userGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanResponse'
          description: OK
      summary: Create spending plan
      tags:
      - spending plan
    get:
      description: Use this endpoint to list all the spending plans associated with the user.
      operationId: listSpendingPlans
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlansResponseBody'
          description: OK
      summary: List spending plans
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}:
    delete:
      description: Use this endpoint to delete a `spending_plan_account`.
      operationId: deleteSpendingPlanAccount
      parameters:
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/spendingPlanAccountGuid'
      responses:
        '204':
          description: No Content
      summary: Delete spending plan account
      tags:
      - spending plan
    get:
      description: Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
      operationId: readSpendingPlanAccount
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/spendingPlanAccountGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanAccountResponse'
          description: OK
      summary: Read spending plan account
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}:
    delete:
      description: Use this endpoint to delete a spending plan `iteration_item`.
      operationId: deleteSpendingPlanIterationItem
      parameters:
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/iterationItemGuid'
      responses:
        '204':
          description: No Content
      summary: Delete spending plan iteration item
      tags:
      - spending plan
    get:
      description: Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
      operationId: readSpendingPlanIterationItem
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/iterationItemGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationItemResponse'
          description: OK
      summary: Read a spending plan iteration item
      tags:
      - spending plan
    put:
      description: Use this endpoint to update an existing `spending_plan_iteration_item`.
      operationId: updateSpendingPlanIterationItem
      parameters:
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/iterationItemGuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpendingPlanIterationItemCreateRequestBody'
        description: Iteration item to be updated with required parameter (planned_amount)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationItemResponse'
          description: OK
      summary: Update a spending plan iteration item
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}:
    delete:
      description: Use this endpoint to delete a user's `spending_plan`.
      operationId: deleteSpendingPlan
      parameters:
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      responses:
        '204':
          description: No Content
      summary: Delete spending plan
      tags:
      - spending plan
    get:
      description: Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
      operationId: readSpendingPlanUser
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanResponse'
          description: OK
      summary: Read a spending plan for a user
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts:
    get:
      description: Use this endpoint to list all the spending plan accounts associated with the spending plan.
      operationId: listSpendingPlanAccounts
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanAccountsResponse'
          description: OK
      summary: List spending plan accounts
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations:
    get:
      description: Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
      operationId: listSpendingPlanIterations
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationsResponse'
          description: OK
      summary: List spending plan iterations
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current:
    get:
      description: Use this endpoint to read the attributes of the current spending plan `iteration`.
      operationId: readCurrentSpendingPlanIteration
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationResponse'
          description: OK
      summary: Read current spending plan iteration
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
  /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}:
    get:
      description: Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
      operationId: readSpendingPlanIteration
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/recordsPerPageMax1000'
      - $ref: '#/components/parameters/userGuid'
      - $ref: '#/components/parameters/spendingPlanGuid'
      - $ref: '#/components/parameters/iterationNumber'
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                $ref: '#/components/schemas/SpendingPlanIterationResponse'
          description: OK
      summary: Read a spending plan iteration
      tags:
      - spending plan
    servers:
    - url: https://int-api.mx.com
    - url: https://api.mx.com
components:
  parameters:
    iterationNumber:
      description: The current iteration number for the spending plan `iteration`.
      example: 1
      in: path
      name: iteration_number
      required: true
      schema:
        type: integer
    userGuid:
      description: The unique identifier for a `user`, beginning with the prefix `USR-`.
      example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
      in: path
      name: user_guid
      required: true
      schema:
        type: string
    spendingPlanGuid:
      description: The unique ID for the `spending_plan`.
      example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262
      in: path
      name: spending_plan_guid
      required: true
      schema:
        type: string
    spendingPlanAccountGuid:
      description: The unique ID for the specified account.
      example: ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c
      in: path
      name: spending_plan_account_guid
      required: true
      schema:
        type: string
    recordsPerPageMax1000:
      description: 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.
      example: 10
      in: query
      name: records_per_page
      schema:
        type: integer
    page:
      description: Results are paginated. Specify current page.
      example: 1
      in: query
      name: page
      schema:
        type: integer
    iterationItemGuid:
      description: The unique ID for the `iteration_item`.
      example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3
      in: path
      name: iteration_item_guid
      required: true
      schema:
        type: string
    acceptVersion:
      name: Accept-Version
      in: header
      required: true
      schema:
        type: string
        default: v20250224
        example: v20250224
      description: MX Platform API version.
  schemas:
    SpendingPlanAccountsResponse:
      properties:
        spending_plan_accounts:
          items:
            $ref: '#/components/schemas/SpendingPlanAccountResponse'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
      type: object
    SpendingPlanIterationResponse:
      properties:
        created_at:
          example: '2016-10-13T18:08:00+00:00'
          type:
          - string
          - 'null'
        end_on:
          example: '2023-05-31'
          type:
          - string
          - 'null'
        guid:
          example: SPI-848e6648-3fa3-4632-ac8f-e65f03167102
          type:
          - string
          - 'null'
        iteration_number:
          example: 1
          type:
          - integer
          - 'null'
        spending_plan_guid:
          example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600
          type:
          - string
          - 'null'
        start_on:
          example: '2023-05-01'
          type:
          - string
          - 'null'
        updated_at:
          example: '2016-10-13T18:09:00+00:00'
          type:
          - string
          - 'null'
        user_guid:
          example: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
          type:
          - string
          - 'null'
      type: object
    SpendingPlanResponse:
      properties:
        created_at:
          example: '2016-10-13T18:08:00+00:00'
          type:
          - string
          - 'null'
        current_iteration_number:
          example: 1
          type:
          - integer
          - 'null'
        guid:
          example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262
          type:
          - string
          - 'null'
        updated_at:
          example: '2016-10-13T18:09:00+00:00'
          type:
          - string
          - 'null'
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type:
          - string
          - 'null'
      type: object
    PaginationResponse:
      properties:
        current_page:
          example: 1
          type: integer
        per_page:
          example: 25
          type: integer
        total_entries:
          example: 1
          type: integer
        total_pages:
          example: 1
          type: integer
      type: object
    SpendingPlanAccountResponse:
      properties:
        account_guid:
          example: ACT-97d3948f-ebe7-434a-9bd0-20b29d67c9d4
          type: string
        client_guid:
          example: CLT-024284fc-a6a7-42ee-b363-dab9343e3f72
          type: string
        created_at:
          example: '2023-04-27T23:14:16Z'
          type: string
        guid:
          example: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a
          type: string
        spending_plan_guid:
          example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600
          type: string
        updated_at:
          example: '2023-04-27T23:14:16Z'
          type: string
        user_guid:
          example: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
          type: string
      type: object
    SpendingPlansResponseBody:
      properties:
        spending_plans:
          items:
            $ref: '#/components/schemas/SpendingPlanResponse'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
      type: object
    SpendingPlanIterationItemResponse:
      properties:
        actual_amount:
          example: 345
          type:
          - number
          - 'null'
        category_guid:
          example: CAT-40faf068-abb4-405c-8f6a-e883ed541fff
          type:
          - string
          - 'null'
        created_at:
          example: '2016-10-13T18:08:00+00:00'
          type:
          - string
          - 'null'
        guid:
          example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262
          type:
          - string
          - 'null'
        item_type:
          example: '1'
          type:
          - string
          - 'null'
        planned_amount:
          example: 110
          type:
          - number
          - 'null'
        scheduled_payment_guid:
          example: SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b
          type:
          - string
          - 'null'
        spending_plan_iteration_guid:
          example: SPI-848e6648-3fa3-4632-ac8f-e65f03167102
          type:
          - string
          - 'null'
        top_level_category_guid:
          example: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8
          type:
          - string
          - 'null'
        transaction_guids:
          items:
            example: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
            type:
            - string
            - 'null'
          type: array
        updated_at:
          example: '2016-10-13T18:09:00+00:00'
          type:
          - string
          - 'null'
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type:
          - string
          - 'null'
      type: object
    SpendingPlanIterationItemsResponseBody:
      properties:
        iteration_items:
          items:
            $ref: '#/components/schemas/SpendingPlanIterationItemResponse'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
      type: object
    SpendingPlanIterationItemCreateRequestBody:
      properties:
        category_guid:
          example: CAT-40faf068-abb4-405c-8f6a-e883ed541fff
          type: string
        item_type:
          example: 1
          type: number
        planned_amount:
          example: 110
          type: number
        scheduled_payment_guid:
          example: SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b
          type: string
        top_level_category_guid:
          example: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8
          type: string
      required:
      - planned_amount
      type: object
    SpendingPlanIterationsResponse:
      properties:
        iterations:
          items:
            $ref: '#/components/schemas/SpendingPlanIterationResponse'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
      type: object
    SpendingPlanIterationResponse_2:
      properties:
        created_at:
          description: The date and time the spending plan iteration was created, represented in ISO 8601 format with a timestamp.
          example: '2025-02-13T18:08:00+00:00'
          type:
          - string
          - 'null'
        end_on:
          description: The date on which the spending plan iteration ends.
          example: '2023-05-31'
          type:
          - string
          - 'null'
        guid:
          description: The unique identifier for the spending plan iteration. Defined by MX.
          example: SPI-848e6648-3fa3-4632-ac8f-e65f03167102
          type:
          - string
          - 'null'
        iteration_number:
          description: The current iteration number for the spending plan iteration.
          example: 1
          type:
          - integer
          - 'null'
        spending_plan_guid:
          description: The unique identifier for the spending plan. Defined by MX.
          example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600
          type:
          - string
          - 'null'
        start_on:
          description: The date on which the spending plan iteration starts.
          example: '2023-05-01'
          type:
          - string
          - 'null'
        updated_at:
          description: '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`.

            '
          example: '2025-02-13T18:09:00+00:00'
          type:
          - string
          - 'null'
        user_guid:
          description: The unique identifier for the user. Defined by MX.
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type:
          - string
          - 'null'
      type: object
    SpendingPlanResponse_2:
      properties:
        created_at:
          description: The date and time the spending plan was created, represented in ISO 8601 format with a timestamp.
          example: '2025-02-13T18:08:00+00:00'
          type:
          - string
          - 'null'
        current_iteration_number:
          description: The current active associated `spending_plan_iteration` number for a given `spending_plan`.
          example: 1
          type:
          - integer
          - 'null'
        guid:
          description: The unique identifier for the `spending_plan`. Defined by MX.
          example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262
          type:
          - string
          - 'null'
        updated_at:
          description: '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`.

            '
          example: '2025-02-13T18:09:00+00:00'
          type:
          - string
          - 'null'
        user_guid:
          description: The unique identifier for the user. Defined by MX.
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type:
          - string
          - 'null'
      type: object
    PaginationResponse_2:
      properties:
        current_page:
          description: The page delivered by the current response.
          example: 1
          type: integer
        per_page:
          description: The number of records delivered with each page.
          example: 25
          type: integer
        total_entries:
          description: The total number of records available.
          example: 1
          type: integer
        total_pages:
          description: The total number of pages available.
          example: 1
          type: integer
      type: object
    SpendingPlanAccountResponse_2:
      properties:
        account_guid:
          description: The unique identifier for an account. Defined by MX.
          example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          type: string
        client_guid:
          description: The unique identifier for the client associated with the insight. Defined by MX.
          example: CLT-abcd-1234
          type: string
        created_at:
          description: The date and time the spending plan account was created, represented in ISO 8601 format with a timestamp.
          example: '2025-02-13T18:08:00+00:00'
          type: string
        guid:
          description: The unique identifier for the spending plan account. Defined by MX.
          example: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a
          type: string
        spending_plan_guid:
          description: The unique identifier for the spending plan. Defined by MX.
          example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600
          type: string
        updated_at:
          description: '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`.

            '
          example: '2025-02-13T18:09:00+00:00'
          type: string
        user_guid:
          description: The unique identifier for the user. Defined by MX.
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    SpendingPlanIterationItemResponse_2:
      properties:
        actual_amount:
          description: The sum of the transactions associated with the spending plan `iteration_item`.
          example: 345
          type:
          - number
          - 'null'
        category_guid:
          description: The unique identifier for the category. Defined by MX.
          example: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e
          type:
          - string
          - 'null'
        created_at:
          description: The date and time the spending plan iteration item was created, represented in ISO 8601 format with a timestamp.
          example: '2025-02-13T18:08:00+00:00'
          type:
          - string
          - 'null'
        guid:
          description: The unique identifier for the spending plan `iteration_item`. Defined by MX.
          example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262
          type:
          - string
          - 'null'
        item_type:
          description: The type of transaction grouping for the spending plan `iteration_item` (0 = `RECURRING_EXPENSE`, 1 = `PLANNED_EXPENSE`, 2 = `OTHER_EXPENSE`, 3 = `INCOME`).
          example: 1
          type:
          - integer
          - 'null'
          enum:
          - 0
          - 1
          - 2
          - 3
        planned_amount:
          description: The total amount planned for a spending plan `iteration_item`.
          example: 110
          type:
          - number
          - 'null'
        scheduled_payment_guid:
          description: The unique identifier for the `scheduled_payment_guid` associated with the spending plan `iteration_item`. Defined by MX.
          example: SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b
          type:
          - string
          - 'null'
        spending_plan_iteration_guid:
          description: The unique identifier for the spending plan `iteration_item`. Defined by MX.
          example: SPI-848e6648-3fa3-4632-ac8f-e65f03167102
          type:
          - string
          - 'null'
        top_level_category_guid:
          description: The unique identifier for the `top_level_category_guid` associated with the spending plan `iteration_item`. Defined by MX.
          example: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8
          type:
          - string
          - 'null'
        transaction_guids:
          description: An array of transaction GUIDs that are relevant to the spending plan `iteration_item`. Defined by MX.
          items:
            example: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
            type:
            - string
            - 'null'
          type: array
        updated_at:
          description: '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`.

            '
          example: '2025-02-13T18:09:00+00:00'
          type:
          - string
          - 'null'
        user_guid:
          description: The unique identifier for the user. Defined by MX.
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type:
          - string
          - 'null'
      type: object
    SpendingPlanIterationItemCreateRequestBody_2:
      properties:
        category_guid:
          description: The unique identifier for the category. Defined by MX.
          example: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e
          type: string
        item_type:
          description: The type of transaction grouping for the spending plan `iteration_item` (0 = `RECURRING_EXPENSE`, 1 = `PLANNED_EXPENSE`, 2 = `OTHER_EXPENSE`, 3 = `INCOME`).
          example: 1
          type: number
        planned_amount:
          description: The total amount planned for a spending plan `iteration_item`.
          example: 61.11
          type: number
        scheduled_payment_guid:
          description: The unique identifier for the `scheduled_payment_guid` associated with the spending plan `iteration_item`. Defined by MX.
          example: SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b
          type: string
        top_level_category_guid:
          description: The unique identifier for the `top_level_category_guid` associated with the spending plan `iteration_item`. Defined by MX.
          example: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8
          type: string
      required:
      - planned_amount
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    basicAuth:
      scheme: basic
      type: http
x-refined-from:
- mx-technologies-platform-openapi.yml
- mx-technologies-platform-v20250224-openapi.yml
x-provenance:
  method: harvested
  publisher: MX Technologies
  source: https://raw.githubusercontent.com/mxenabled/openapi/HEAD/openapi/mx_platform_api.yml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)