{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:naviplancentral-plan/advisors-get":{"get":{"operationId":"finance_naviplancentral_plan_advisors_get","summary":"Retrieve Advisors","description":"GET /api/Advisors","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/advisors-get-by-householdid-clientid":{"get":{"operationId":"finance_naviplancentral_plan_advisors_get_by_householdid_clientid","summary":"Retrieve Advisors for a Client","description":"GET /api/Advisors/{householdId}/{clientId}","tags":["finance"],"parameters":[{"name":"householdId","in":"query","required":true,"description":"Integer id of the household","schema":{"type":"integer","description":"Integer id of the household"}},{"name":"clientId","in":"query","required":true,"description":"Guid id of the client.","schema":{"type":"string","description":"Guid id of the client."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/advisors-get-by-id":{"get":{"operationId":"finance_naviplancentral_plan_advisors_get_by_id","summary":"Retrieve an Advisor","description":"GET /api/Advisors/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Guid id of the advisor","schema":{"type":"string","description":"Guid id of the advisor"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/assumptions-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_assumptions_get_by_planid","summary":"Retrieve plan assumptions","description":"GET /api/Assumptions","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/business-entities-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_business_entities_get_by_planid","summary":"Retrieve business entities","description":"GET /api/BusinessEntities","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/business-entities-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_business_entities_get_by_id_planid","summary":"Retrieve a business entity","description":"GET /api/BusinessEntities/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of business entity to retrieve","schema":{"type":"integer","description":"ID of business entity to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/calculations-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_calculations_get_by_planid","summary":"Retrieve Monte Carlo results from standalone calc service","description":"GET /api/Calculations/MonteCarlo","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/defined-benefit-pensions-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_defined_benefit_pensions_get_by_planid","summary":"Retrieve defined benefit pensions","description":"GET /api/DefinedBenefitPensions","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/defined-benefit-pensions-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_defined_benefit_pensions_get_by_id_planid","summary":"Retrieve a definedBenefitPension","description":"GET /api/DefinedBenefitPensions/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of defined benefit pension to retrieve","schema":{"type":"integer","description":"ID of defined benefit pension to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/eula-accept":{"post":{"operationId":"finance_naviplancentral_plan_eula_accept","summary":"Accepts the EULA","description":"POST /api/Eula/Accept","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/family-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_family_get_by_planid","summary":"Retrieve family","description":"GET /api/Family","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-get-education-by-id-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_goal_adjustments_get_education_by_id_clientid_planid","summary":"Retrieve the adjustments","description":"GET /api/GoalAdjustments/Education/{id}/Adjustments","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the goal to retrieve adjustments for.","schema":{"type":"integer","description":"The id of the goal to retrieve adjustments for."}},{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-post-education-by-id-goaladjustments-planid":{"post":{"operationId":"finance_naviplancentral_plan_goal_adjustments_post_education_by_id_goaladjustments_planid","summary":"Perform calculations","description":"POST /api/GoalAdjustments/Education/{id}/Calculations","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","planId","body"],"properties":{"id":{"type":"integer","description":"The id of the goal to retrieve adjustments for."},"planId":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-get-goal-success-rates-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_goal_adjustments_get_goal_success_rates_by_clientid_planid","summary":"Returns a list of goals with their relevant success rates.","description":"GET /api/GoalAdjustments/GoalSuccessRates","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-get-major-purchase-by-id-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_goal_adjustments_get_major_purchase_by_id_clientid_planid","summary":"Retrieve the adjustments","description":"GET /api/GoalAdjustments/MajorPurchase/{id}/Adjustments","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the goal to retrieve adjustments for.","schema":{"type":"integer","description":"The id of the goal to retrieve adjustments for."}},{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-post-major-purchase-by-id-goaladjustments-p":{"post":{"operationId":"finance_naviplancentral_plan_goal_adjustments_post_major_purchase_by_id_goaladjustments_p","summary":"Perform calculations","description":"POST /api/GoalAdjustments/MajorPurchase/{id}/Calculations","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","planId","body"],"properties":{"id":{"type":"integer","description":"The id of the goal to retrieve adjustments for."},"planId":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-get-goal-adjustment-restrictions-by-clienti":{"get":{"operationId":"finance_naviplancentral_plan_goal_adjustments_get_goal_adjustment_restrictions_by_clienti","summary":"Returns a list of goal adjustment restrictions.","description":"GET /api/GoalAdjustments/Restrictions","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-get-retirement-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_goal_adjustments_get_retirement_by_clientid_planid","summary":"Retrieve the adjustments","description":"GET /api/GoalAdjustments/Retirement/Adjustments","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-post-retirement-by-goaladjustments-planid":{"post":{"operationId":"finance_naviplancentral_plan_goal_adjustments_post_retirement_by_goaladjustments_planid","summary":"Perform calculations","description":"POST /api/GoalAdjustments/Retirement/Calculations","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["planId","body"],"properties":{"planId":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goal-adjustments-get-what-are-my-options-by-id-clientid-plan":{"get":{"operationId":"finance_naviplancentral_plan_goal_adjustments_get_what_are_my_options_by_id_clientid_plan","summary":"Returns WAMO values for current goal","description":"GET /api/GoalAdjustments/{id}/WhatAreMyOptions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the goal to retrieve WAMO values for.","schema":{"type":"integer","description":"The id of the goal to retrieve WAMO values for."}},{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goals-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_goals_get_by_planid","summary":"Retrieve goals","description":"GET /api/Goals","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/goals-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_goals_get_by_id_planid","summary":"Retrieve goals","description":"GET /api/Goals/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of goal to retrieve","schema":{"type":"integer","description":"ID of goal to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/holding-companies-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_holding_companies_get_by_planid","summary":"Retrieve holding companies","description":"GET /api/HoldingCompanies","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/holding-companies-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_holding_companies_get_by_id_planid","summary":"Retrieve a holding company","description":"GET /api/HoldingCompanies/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of holding company to retrieve","schema":{"type":"integer","description":"ID of holding company to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/households-get-by-householdid":{"get":{"operationId":"finance_naviplancentral_plan_households_get_by_householdid","summary":"Retrieve all Households associated with the user","description":"GET /api/Households","tags":["finance"],"parameters":[{"name":"householdId","in":"query","required":false,"description":"The Id of the specific household to retrieve","schema":{"type":"integer","description":"The Id of the specific household to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/liabilities-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_liabilities_get_by_planid","summary":"Retrieve liabilities","description":"GET /api/Liabilities","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/liabilities-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_liabilities_get_by_id_planid","summary":"Retrieve a liability","description":"GET /api/Liabilities/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of liability to retrieve","schema":{"type":"integer","description":"ID of liability to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/lifestyle-assets-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_lifestyle_assets_get_by_planid","summary":"Retrieve lifestyle assets","description":"GET /api/LifestyleAssets","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/lifestyle-assets-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_lifestyle_assets_get_by_id_planid","summary":"Retrieve lifestyle assets","description":"GET /api/LifestyleAssets/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of lifestyle asset to retrieve","schema":{"type":"integer","description":"ID of lifestyle asset to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-goals-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_goals_by_clientid_planid","summary":"Retrieves all goals from the live plan","description":"GET /api/LivePlan/Goals","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-goal-funding-list-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_goal_funding_list_by_clientid_planid","summary":"Retrieve a list of funding accounts","description":"GET /api/LivePlan/Goals/Funding","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-what-are-my-options-by-id-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_what_are_my_options_by_id_clientid_planid","summary":"Retrieve WAMO values for a given goal","description":"GET /api/LivePlan/Goals/{id}/WhatAreMyOptions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the goal","schema":{"type":"integer","description":"The id of the goal"}},{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-accounts-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_accounts_by_clientid_planid","summary":"Retrieves accounts for a given plan","description":"GET /api/LivePlan/NetWorth/Accounts","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-liabilities-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_liabilities_by_clientid_planid","summary":"Retrieves liabilities for a given plan","description":"GET /api/LivePlan/NetWorth/Liabilities","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-lifestyle-assets-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_lifestyle_assets_by_clientid_planid","summary":"Retrieves lifestyle assets for a given plan","description":"GET /api/LivePlan/NetWorth/LifestyleAssets","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-real-estate-assets-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_real_estate_assets_by_clientid_planid","summary":"Retrieves real estate accounts for a given plan","description":"GET /api/LivePlan/NetWorth/RealEstate","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-projected-net-worth-by-clientid-planid":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_projected_net_worth_by_clientid_planid","summary":"Retrieves net worth projections","description":"GET /api/LivePlan/Projections/NetWorth","tags":["finance"],"parameters":[{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/live-plan-get-projected-needs-vs-abilities-by-id-clientid-pl":{"get":{"operationId":"finance_naviplancentral_plan_live_plan_get_projected_needs_vs_abilities_by_id_clientid_pl","summary":"Retrieves needs vs abilities projections","description":"GET /api/LivePlan/Projections/{id}/NeedsVsAbilities","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer"}},{"name":"clientId","in":"query","required":false,"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","schema":{"type":"string","description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions."}},{"name":"planId","in":"query","required":true,"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/net-worth-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_net_worth_get_by_planid","summary":"Retrieve net worth","description":"GET /api/NetWorth","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/password-has-user-set-password":{"post":{"operationId":"finance_naviplancentral_plan_password_has_user_set_password","summary":"Determines if the currently logged in user has set their own password","description":"POST /api/Password/HasUserSetPassword","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/password-password-requirements":{"get":{"operationId":"finance_naviplancentral_plan_password_password_requirements","summary":"Gets the password complexity requirements","description":"GET /api/Password/PasswordRequirements","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/password-reset-by-model":{"post":{"operationId":"finance_naviplancentral_plan_password_reset_by_model","summary":"Resets the password for the supplied user name","description":"POST /api/Password/Reset","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/password-set-by-model":{"post":{"operationId":"finance_naviplancentral_plan_password_set_by_model","summary":"Sets the password for the currently logged in user","description":"POST /api/Password/Set","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/plan-information-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_plan_information_get_by_planid","summary":"Retrieve plan information","description":"GET /api/PlanInformation","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/plan-statuses-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_plan_statuses_get_by_planid","summary":"Retrieve plan data statuses","description":"GET /api/PlanStatuses","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3)","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/portfolio-accounts-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_portfolio_accounts_get_by_planid","summary":"Retrieve portfolio accounts","description":"GET /api/PortfolioAccounts","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/portfolio-accounts-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_portfolio_accounts_get_by_id_planid","summary":"Retrieve a portfolio account","description":"GET /api/PortfolioAccounts/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of portfolio account to retrieve","schema":{"type":"integer","description":"ID of portfolio account to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-annual-summary-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_annual_summary_get_by_planid","summary":"Retrieve projected annual summaries","description":"GET /api/ProjectedAnnualSummary","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-annual-summary-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_annual_summary_get_by_id_planid","summary":"Retrieve projected annual summary by id","description":"GET /api/ProjectedAnnualSummary/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Index into the list of annual projections","schema":{"type":"integer","description":"Index into the list of annual projections"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-cash-flow-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_cash_flow_get_by_planid","summary":"Retrieve projected cash flow","description":"GET /api/ProjectedCashFlow","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-cash-flow-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_cash_flow_get_by_id_planid","summary":"Retrieve projected cash flow by id","description":"GET /api/ProjectedCashFlow/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Index into the list of annual projections","schema":{"type":"integer","description":"Index into the list of annual projections"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-goals-get-assets-funding-goals-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_goals_get_assets_funding_goals_by_planid","summary":"Retrieve assets funding goals over time","description":"GET /api/ProjectedGoals/AssetsFundingGoals","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-goals-get-needs-vs-abilities-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_goals_get_needs_vs_abilities_by_planid","summary":"Retrieve needs vs abilities data","description":"GET /api/ProjectedGoals/NeedsVsAbilities","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-net-worth-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_net_worth_get_by_planid","summary":"Retrieve projected net worth","description":"GET /api/ProjectedNetWorth","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/projected-net-worth-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_projected_net_worth_get_by_id_planid","summary":"Retrieve projected net worth by id","description":"GET /api/ProjectedNetWorth/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"Index into the list of annual projections","schema":{"type":"integer","description":"Index into the list of annual projections"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/restricted-stocks-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_restricted_stocks_get_by_planid","summary":"Retrieve restricted stocks","description":"GET /api/RestrictedStocks","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/restricted-stocks-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_restricted_stocks_get_by_id_planid","summary":"Retrieve a restricted stock","description":"GET /api/RestrictedStocks/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of restricted stock to retrieve","schema":{"type":"integer","description":"ID of restricted stock to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/service-information-statistics":{"get":{"operationId":"finance_naviplancentral_plan_service_information_statistics","summary":"This resource can be used to check the status of the service.","description":"GET /api/ServiceInformation/Statistics","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/stock-options-get-by-planid":{"get":{"operationId":"finance_naviplancentral_plan_stock_options_get_by_planid","summary":"Retrieve stock options","description":"GET /api/StockOptions","tags":["finance"],"parameters":[{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/stock-options-get-by-id-planid":{"get":{"operationId":"finance_naviplancentral_plan_stock_options_get_by_id_planid","summary":"Retrieve a stock option","description":"GET /api/StockOptions/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of stock option to retrieve","schema":{"type":"integer","description":"ID of stock option to retrieve"}},{"name":"planId","in":"query","required":true,"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","schema":{"type":"string","description":"Id of the plan to retrieve data from (e.g. 1001-11-3)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/auth-login-by-model":{"post":{"operationId":"finance_naviplancentral_plan_auth_login_by_model","summary":"Start a session with the DomainProviders user store","description":"POST /api/auth/Login","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/auth-password-requirements":{"get":{"operationId":"finance_naviplancentral_plan_auth_password_requirements","summary":"Gets the login rules","description":"GET /api/auth/LoginConfiguration","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/auth-logout":{"post":{"operationId":"finance_naviplancentral_plan_auth_logout","summary":"POST /api/auth/Logout","description":"POST /api/auth/Logout","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:naviplancentral-plan/auth-resume-session":{"post":{"operationId":"finance_naviplancentral_plan_auth_resume_session","summary":"Validate and extend the duration of a session","description":"POST /api/auth/ResumeSession","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}