{ "opencollection": "1.0.0", "info": { "name": "MX Platform Spending Plan API", "version": "0.1.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Spending Plan", "type": "folder" }, "items": [ { "info": { "name": "List spending plan iteration items", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`." }, { "info": { "name": "Create spending plan iteration item", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items", "params": [ { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a new `spending_plan_iteration_item`." }, { "info": { "name": "Read spending plan account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "spending_plan_account_guid", "value": "ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c", "type": "path", "description": "The unique ID for the specified account." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID." }, { "info": { "name": "Delete spending plan account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique ID for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "spending_plan_account_guid", "value": "ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c", "type": "path", "description": "The unique ID for the specified account." } ] }, "docs": "Use this endpoint to delete a `spending_plan_account`." }, { "info": { "name": "Read a spending plan for a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan according to its unique GUID." }, { "info": { "name": "Delete spending plan", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique ID for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to delete a user's `spending_plan`." }, { "info": { "name": "Read a spending plan iteration", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/:iteration_number", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "iteration_number", "value": "1", "type": "path", "description": "The current iteration number for the spending plan `iteration``." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`." } ] } ], "bundled": true }