openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 143 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"x-twitter":"AdvicentFP"},"description":"An API for accessing NaviPlan plan data for a client.","title":"NaviPlan API","version":"v1","x-apisguru-categories":["financial"],"x-logo":{"url":"https://twitter.com/Advicent/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://demo.uat.naviplancentral.com/plan/swagger/docs/v1","version":"2.0"},{"format":"swagger","url":"https://demo.uat.naviplancentral.com/plan/swagger/docs/v1","version":"2.0"}],"x-providerName":"naviplancentral.com","x-serviceName":"plan"},"paths":{"/api/Advisors":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the Advisors in the plan.","operationId":"Advisors_Get","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvisorsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvisorsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for advisor details"},"404":{"description":"Object not found"}},"summary":"Retrieve Advisors","tags":["Advisors"]}},"/api/Advisors/{householdId}/{clientId}":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the Advisors for the client.","operationId":"Advisors_GetByHouseholdidClientid","parameters":[{"description":"Integer id of the household","in":"path","name":"householdId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Guid id of the client.","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvisorsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvisorsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for advisor details"},"403":{"description":"Request is restricted for access to advisor information"},"404":{"description":"Object not found"}},"summary":"Retrieve Advisors for a Client","tags":["Advisors"]}},"/api/Advisors/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an Advisor from the plan.","operationId":"Advisors_GetById","parameters":[{"description":"Guid id of the advisor","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvisorModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvisorModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for advisor details"},"404":{"description":"Object not found"}},"summary":"Retrieve an Advisor","tags":["Advisors"]}},"/api/Assumptions":{"get":{"deprecated":false,"description":"This operation retrieves an object containing all assumptions for the specified plan.","operationId":"Assumptions_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssumptionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AssumptionsModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve plan assumptions","tags":["Assumptions"]}},"/api/BusinessEntities":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the business entities in the plan.","operationId":"BusinessEntities_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessEntitiesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/BusinessEntitiesModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve business entities","tags":["BusinessEntities"]}},"/api/BusinessEntities/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a business entity from the plan.","operationId":"BusinessEntities_GetByIdPlanid","parameters":[{"description":"ID of business entity to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessEntityModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/BusinessEntityModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a business entity","tags":["BusinessEntities"]}},"/api/Calculations/MonteCarlo":{"get":{"deprecated":false,"description":"Currently just stubbed out, POC in development","operationId":"Calculations_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve Monte Carlo results from standalone calc service","tags":["Calculations"]}},"/api/DefinedBenefitPensions":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the defined benefit pensions in the plan.","operationId":"DefinedBenefitPensions_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinedBenefitPensionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DefinedBenefitPensionsModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve defined benefit pensions","tags":["DefinedBenefitPensions"]}},"/api/DefinedBenefitPensions/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a defined benefit pension from the plan.","operationId":"DefinedBenefitPensions_GetByIdPlanid","parameters":[{"description":"ID of defined benefit pension to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinedBenefitPensionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/DefinedBenefitPensionModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a definedBenefitPension","tags":["DefinedBenefitPensions"]}},"/api/Eula/Accept":{"post":{"deprecated":false,"operationId":"Eula_Accept","responses":{"200":{"description":"OK"},"500":{"description":"InternalServerError"}},"summary":"Accepts the EULA","tags":["Eula"]}},"/api/Family":{"get":{"deprecated":false,"description":"This operation retrieves an object containing all familymembers for the specified plan.","operationId":"Family_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FamilyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/FamilyModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve family","tags":["Family"]}},"/api/GoalAdjustments/Education/{id}/Adjustments":{"get":{"deprecated":false,"description":"This function retrieves a goal and the adjustments made to it","operationId":"GoalAdjustments_GetEducationByIdClientidPlanid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsEducationGoalAdjustmentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsEducationGoalAdjustmentsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieve the adjustments","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Education/{id}/Calculations":{"post":{"deprecated":false,"description":"This function returns the posted object and the adjusted calculation values","operationId":"GoalAdjustments_PostEducationByIdGoaladjustmentsPlanid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments"}}},"description":"The adjusted values for this goal","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Perform calculations","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/GoalSuccessRates":{"get":{"deprecated":false,"operationId":"GoalAdjustments_GetGoalSuccessRatesByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Goal Success Rates successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateResultsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateResultsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Returns a list of goals with their relevant success rates.","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/MajorPurchase/{id}/Adjustments":{"get":{"deprecated":false,"description":"This function retrieves a goal and the adjustments made to it","operationId":"GoalAdjustments_GetMajorPurchaseByIdClientidPlanid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsMajorPurchaseGoalAdjustmentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsMajorPurchaseGoalAdjustmentsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieve the adjustments","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/MajorPurchase/{id}/Calculations":{"post":{"deprecated":false,"description":"This function returns the posted object and the adjusted calculation values","operationId":"GoalAdjustments_PostMajorPurchaseByIdGoaladjustmentsPlanid","parameters":[{"description":"The id of the goal to retrieve adjustments for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments"}}},"description":"The adjusted values for this goal","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Perform calculations","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Restrictions":{"get":{"deprecated":false,"description":"This function returns a list of adjustment restrictions for all goals.","operationId":"GoalAdjustments_GetGoalAdjustmentRestrictionsByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Restrictions successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsResultModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsResultModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Returns a list of goal adjustment restrictions.","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Retirement/Adjustments":{"get":{"deprecated":false,"description":"This function retrieves a goal and the adjustments made to it for a particular client","operationId":"GoalAdjustments_GetRetirementByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsRetirementGoalAdjustmentsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsRetirementGoalAdjustmentsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieve the adjustments","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/Retirement/Calculations":{"post":{"deprecated":false,"description":"This function returns the posted object and the adjusted calculation values","operationId":"GoalAdjustments_PostRetirementByGoaladjustmentsPlanid","parameters":[{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments"}}},"description":"The adjusted values for this goal","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Perform calculations","tags":["GoalAdjustments"]}},"/api/GoalAdjustments/{id}/WhatAreMyOptions":{"get":{"deprecated":false,"operationId":"GoalAdjustments_GetWhatAreMyOptionsByIdClientidPlanid","parameters":[{"description":"The id of the goal to retrieve WAMO values for.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"What are my options results successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Returns WAMO values for current goal","tags":["GoalAdjustments"]}},"/api/Goals":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the goals in the plan.","operationId":"Goals_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/GoalsModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve goals","tags":["Goals"]}},"/api/Goals/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a goal from the plan.","operationId":"Goals_GetByIdPlanid","parameters":[{"description":"ID of goal to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/GoalModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve goals","tags":["Goals"]}},"/api/HoldingCompanies":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the holding companies in the plan.","operationId":"HoldingCompanies_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoldingCompaniesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/HoldingCompaniesModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve holding companies","tags":["HoldingCompanies"]}},"/api/HoldingCompanies/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a holding company from the plan.","operationId":"HoldingCompanies_GetByIdPlanid","parameters":[{"description":"ID of holding company to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoldingCompanyModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/HoldingCompanyModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a holding company","tags":["HoldingCompanies"]}},"/api/Households":{"get":{"deprecated":false,"description":"This operation retrieves a list of households the current user has access to or one household specified by a householdId parameter","operationId":"Households_GetByHouseholdid","parameters":[{"description":"The Id of the specific household to retrieve","in":"query","name":"householdId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HouseholdsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/HouseholdsModel"}}}},"401":{"description":"Unauthorized for household data access"},"403":{"description":"Access to household is restricted"}},"summary":"Retrieve all Households associated with the user","tags":["Households"]}},"/api/Liabilities":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the liabilities in the plan.","operationId":"Liabilities_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiabilitiesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/LiabilitiesModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve liabilities","tags":["Liabilities"]}},"/api/Liabilities/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a liability from the plan.","operationId":"Liabilities_GetByIdPlanid","parameters":[{"description":"ID of liability to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiabilityModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/LiabilityModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a liability","tags":["Liabilities"]}},"/api/LifestyleAssets":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the lifestyle assets in the plan.","operationId":"LifestyleAssets_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifestyleAssetsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/LifestyleAssetsModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve lifestyle assets","tags":["LifestyleAssets"]}},"/api/LifestyleAssets/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a lifestyle asset from the plan.","operationId":"LifestyleAssets_GetByIdPlanid","parameters":[{"description":"ID of lifestyle asset to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifestyleAssetModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/LifestyleAssetModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve lifestyle assets","tags":["LifestyleAssets"]}},"/api/LivePlan/Goals":{"get":{"deprecated":false,"operationId":"LivePlan_GetGoalsByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalsModelsLiveGoalBaseModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalsModelsLiveGoalBaseModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves all goals from the live plan","tags":["LivePlan"]}},"/api/LivePlan/Goals/Funding":{"get":{"deprecated":false,"description":"This function retrieves a list of funding accounts for the goals in the plan","operationId":"LivePlan_GetGoalFundingListByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalsModelsGoalFundingListModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalsModelsGoalFundingListModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieve a list of funding accounts","tags":["LivePlan"]}},"/api/LivePlan/Goals/{id}/WhatAreMyOptions":{"get":{"deprecated":false,"description":"This function retrieves the WAMO values for the specified goal","operationId":"LivePlan_GetWhatAreMyOptionsByIdClientidPlanid","parameters":[{"description":"The id of the goal","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieve WAMO values for a given goal","tags":["LivePlan"]}},"/api/LivePlan/NetWorth/Accounts":{"get":{"deprecated":false,"operationId":"LivePlan_GetAccountsByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsAccountBaseModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsAccountBaseModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves accounts for a given plan","tags":["LivePlan"]}},"/api/LivePlan/NetWorth/Liabilities":{"get":{"deprecated":false,"operationId":"LivePlan_GetLiabilitiesByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsLiabilityBaseModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsLiabilityBaseModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves liabilities for a given plan","tags":["LivePlan"]}},"/api/LivePlan/NetWorth/LifestyleAssets":{"get":{"deprecated":false,"operationId":"LivePlan_GetLifestyleAssetsByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetBaseModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetBaseModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves lifestyle assets for a given plan","tags":["LivePlan"]}},"/api/LivePlan/NetWorth/RealEstate":{"get":{"deprecated":false,"operationId":"LivePlan_GetRealEstateAssetsByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsRealEstateBaseModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiNetWorthModelsRealEstateBaseModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves real estate accounts for a given plan","tags":["LivePlan"]}},"/api/LivePlan/Projections/NetWorth":{"get":{"deprecated":false,"operationId":"LivePlan_GetProjectedNetWorthByClientidPlanid","parameters":[{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves net worth projections","tags":["LivePlan"]}},"/api/LivePlan/Projections/{id}/NeedsVsAbilities":{"get":{"deprecated":false,"operationId":"LivePlan_GetProjectedNeedsVsAbilitiesByIdClientidPlanid","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.","in":"query","name":"clientId","required":false,"schema":{"type":"string"}},{"description":"Id of the Plan to retrieve or update data for (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"},"503":{"description":"Unable to acquire a NaviPlan engine"}},"summary":"Retrieves needs vs abilities projections","tags":["LivePlan"]}},"/api/NetWorth":{"get":{"deprecated":false,"description":"This operation retrieves an object containing net worth values for specific dates within the plan:\r\n * Plan Start Date\r\n * Retirement Date\r\n * Plan End Date.","operationId":"NetWorth_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetWorthModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NetWorthModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve net worth","tags":["NetWorth"]}},"/api/Password/HasUserSetPassword":{"post":{"deprecated":false,"operationId":"Password_HasUserSetPassword","responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"}},"summary":"Determines if the currently logged in user has set their own password","tags":["Password"]}},"/api/Password/PasswordRequirements":{"get":{"deprecated":false,"operationId":"Password_PasswordRequirements","responses":{"200":{"description":"OK"},"500":{"description":"InternalServerError"}},"summary":"Gets the password complexity requirements","tags":["Password"]}},"/api/Password/Reset":{"post":{"deprecated":false,"operationId":"Password_ResetByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordModel"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest"}},"summary":"Resets the password for the supplied user name","tags":["Password"]}},"/api/Password/Set":{"post":{"deprecated":false,"operationId":"Password_SetByModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPasswordModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SetPasswordModel"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"}},"summary":"Sets the password for the currently logged in user","tags":["Password"]}},"/api/PlanInformation":{"get":{"deprecated":false,"description":"This operation retrieves the high level plan information for a given plan","operationId":"PlanInformation_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanInformationModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PlanInformationModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve plan information","tags":["PlanInformation"]}},"/api/PlanStatuses":{"get":{"deprecated":false,"description":"This operation retrieves the data statuses of the published plan if on demand updates\r\n are enabled","operationId":"PlanStatuses_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3)","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanStatusesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PlanStatusesModel"}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan status access"},"404":{"description":"Object not found"}},"summary":"Retrieve plan data statuses","tags":["PlanStatuses"]}},"/api/PortfolioAccounts":{"get":{"deprecated":false,"description":"This operation retrieves a list of all of the portfolio accounts in the plan.","operationId":"PortfolioAccounts_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccountsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccountsModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve portfolio accounts","tags":["PortfolioAccounts"]}},"/api/PortfolioAccounts/{id}":{"get":{"deprecated":false,"description":"This operation retrieves a portfolio account from the plan.","operationId":"PortfolioAccounts_GetByIdPlanid","parameters":[{"description":"ID of portfolio account to retrieve","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccountModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccountModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve a portfolio account","tags":["PortfolioAccounts"]}},"/api/ProjectedAnnualSummary":{"get":{"deprecated":false,"description":"This operation retrieves an object containing annual summary information \r\n for each year of the projected plan.","operationId":"ProjectedAnnualSummary_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectedAnnualSummariesModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProjectedAnnualSummariesModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected annual summaries","tags":["ProjectedAnnualSummary"]}},"/api/ProjectedAnnualSummary/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an object containing annual summary information \r\n for a single specified year of the projected plan.","operationId":"ProjectedAnnualSummary_GetByIdPlanid","parameters":[{"description":"Index into the list of annual projections","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectedAnnualSummaryModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProjectedAnnualSummaryModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected annual summary by id","tags":["ProjectedAnnualSummary"]}},"/api/ProjectedCashFlow":{"get":{"deprecated":false,"description":"This operation retrieves an object containing cash flow information \r\n for each year of the projected plan.","operationId":"ProjectedCashFlow_GetByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowProjectionsModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CashFlowProjectionsModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected cash flow","tags":["ProjectedCashFlow"]}},"/api/ProjectedCashFlow/{id}":{"get":{"deprecated":false,"description":"This operation retrieves an object containing cash flow information \r\n for a single specified year of the projected plan.","operationId":"ProjectedCashFlow_GetByIdPlanid","parameters":[{"description":"Index into the list of annual projections","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowProjectionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CashFlowProjectionModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve projected cash flow by id","tags":["ProjectedCashFlow"]}},"/api/ProjectedGoals/AssetsFundingGoals":{"get":{"deprecated":false,"description":"This operation retrieves the assets funding each goal throughout the plan years","operationId":"ProjectedGoals_GetAssetsFundingGoalsByPlanid","parameters":[{"description":"Id of the plan to retrieve data from (e.g. 1001-11-3).","in":"query","name":"planId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetsFundingGoalModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/AssetsFundingGoalModel"}}}},"202":{"description":"Plan migration is processing"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized for plan data access"},"404":{"description":"Object not found"}},"summary":"Retrieve assets funding goals over time","tags":["ProjectedGoals"]}},"/api/ProjectedGoals/NeedsVsAbilities":{"get":{"deprecated":false,"description":"This operation retrieves a needs and abilities da