@datafire/naviplancentral_plan v5.0.0

@datafire/naviplancentral_plan

Client library for NaviPlan API

Installation and Usage

npm install --save @datafire/naviplancentral_plan

let naviplancentral_plan = require('@datafire/naviplancentral_plan').create();

.then(data => {
  console.log(data);
});

Description

An API for accessing NaviPlan plan data for a client.

Actions

Advisors_Get

This operation retrieves a list of all of the Advisors in the plan.

naviplancentral_plan.Advisors_Get(null, context)

Input

This action has no parameters

Output

• output AdvisorsModel

Advisors_GetByHouseholdidClientid

This operation retrieves a list of all of the Advisors for the client.

naviplancentral_plan.Advisors_GetByHouseholdidClientid({
  "householdId": 0,
  "clientId": ""
}, context)

Input

• input object
  • householdId required integer: Integer id of the household
  • clientId required string: Guid id of the client.

Output

• output AdvisorsModel

Advisors_GetById

This operation retrieves an Advisor from the plan.

naviplancentral_plan.Advisors_GetById({
  "id": ""
}, context)

Input

• input object
  • id required string: Guid id of the advisor

Output

• output AdvisorModel

Assumptions_GetByPlanid

This operation retrieves an object containing all assumptions for the specified plan.

naviplancentral_plan.Assumptions_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output AssumptionsModel

BusinessEntities_GetByPlanid

This operation retrieves a list of all of the business entities in the plan.

naviplancentral_plan.BusinessEntities_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output BusinessEntitiesModel

BusinessEntities_GetByIdPlanid

This operation retrieves a business entity from the plan.

naviplancentral_plan.BusinessEntities_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of business entity to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output BusinessEntityModel

Calculations_GetByPlanid

Currently just stubbed out, POC in development

naviplancentral_plan.Calculations_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output boolean

DefinedBenefitPensions_GetByPlanid

This operation retrieves a list of all of the defined benefit pensions in the plan.

naviplancentral_plan.DefinedBenefitPensions_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output DefinedBenefitPensionsModel

DefinedBenefitPensions_GetByIdPlanid

This operation retrieves a defined benefit pension from the plan.

naviplancentral_plan.DefinedBenefitPensions_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of defined benefit pension to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output DefinedBenefitPensionModel

Eula_Accept

Accepts the EULA

naviplancentral_plan.Eula_Accept(null, context)

Input

This action has no parameters

Output

Output schema unknown

Family_GetByPlanid

This operation retrieves an object containing all familymembers for the specified plan.

naviplancentral_plan.Family_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output FamilyModel

GoalAdjustments_GetEducationByIdClientidPlanid

This function retrieves a goal and the adjustments made to it

naviplancentral_plan.GoalAdjustments_GetEducationByIdClientidPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: The id of the goal to retrieve adjustments for.
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsEducationGoalAdjustmentsModel

GoalAdjustments_PostEducationByIdGoaladjustmentsPlanid

This function returns the posted object and the adjusted calculation values

naviplancentral_plan.GoalAdjustments_PostEducationByIdGoaladjustmentsPlanid({
  "id": 0,
  "goalAdjustments": {},
  "planId": ""
}, context)

Input

• input object
  • id required integer: The id of the goal to retrieve adjustments for.
  • goalAdjustments required AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments

GoalAdjustments_GetGoalSuccessRatesByClientidPlanid

Returns a list of goals with their relevant success rates.

naviplancentral_plan.GoalAdjustments_GetGoalSuccessRatesByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateResultsModel

GoalAdjustments_GetMajorPurchaseByIdClientidPlanid

This function retrieves a goal and the adjustments made to it

naviplancentral_plan.GoalAdjustments_GetMajorPurchaseByIdClientidPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: The id of the goal to retrieve adjustments for.
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsMajorPurchaseGoalAdjustmentsModel

GoalAdjustments_PostMajorPurchaseByIdGoaladjustmentsPlanid

This function returns the posted object and the adjusted calculation values

naviplancentral_plan.GoalAdjustments_PostMajorPurchaseByIdGoaladjustmentsPlanid({
  "id": 0,
  "goalAdjustments": {},
  "planId": ""
}, context)

Input

• input object
  • id required integer: The id of the goal to retrieve adjustments for.
  • goalAdjustments required AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments

GoalAdjustments_GetGoalAdjustmentRestrictionsByClientidPlanid

This function returns a list of adjustment restrictions for all goals.

naviplancentral_plan.GoalAdjustments_GetGoalAdjustmentRestrictionsByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsResultModel

GoalAdjustments_GetRetirementByClientidPlanid

This function retrieves a goal and the adjustments made to it for a particular client

naviplancentral_plan.GoalAdjustments_GetRetirementByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsRetirementGoalAdjustmentsModel

GoalAdjustments_PostRetirementByGoaladjustmentsPlanid

This function returns the posted object and the adjusted calculation values

naviplancentral_plan.GoalAdjustments_PostRetirementByGoaladjustmentsPlanid({
  "goalAdjustments": {},
  "planId": ""
}, context)

Input

• input object
  • goalAdjustments required AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments

GoalAdjustments_GetWhatAreMyOptionsByIdClientidPlanid

Returns WAMO values for current goal

naviplancentral_plan.GoalAdjustments_GetWhatAreMyOptionsByIdClientidPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: The id of the goal to retrieve WAMO values for.
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel

Goals_GetByPlanid

This operation retrieves a list of all of the goals in the plan.

naviplancentral_plan.Goals_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output GoalsModel

Goals_GetByIdPlanid

This operation retrieves a goal from the plan.

naviplancentral_plan.Goals_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of goal to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output GoalModel

HoldingCompanies_GetByPlanid

This operation retrieves a list of all of the holding companies in the plan.

naviplancentral_plan.HoldingCompanies_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output HoldingCompaniesModel

HoldingCompanies_GetByIdPlanid

This operation retrieves a holding company from the plan.

naviplancentral_plan.HoldingCompanies_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of holding company to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output HoldingCompanyModel

Households_GetByHouseholdid

This operation retrieves a list of households the current user has access to or one household specified by a householdId parameter

naviplancentral_plan.Households_GetByHouseholdid({}, context)

Input

• input object
  • householdId integer: The Id of the specific household to retrieve

Output

• output HouseholdsModel

Liabilities_GetByPlanid

This operation retrieves a list of all of the liabilities in the plan.

naviplancentral_plan.Liabilities_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output LiabilitiesModel

Liabilities_GetByIdPlanid

This operation retrieves a liability from the plan.

naviplancentral_plan.Liabilities_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of liability to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output LiabilityModel

LifestyleAssets_GetByPlanid

This operation retrieves a list of all of the lifestyle assets in the plan.

naviplancentral_plan.LifestyleAssets_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output LifestyleAssetsModel

LifestyleAssets_GetByIdPlanid

This operation retrieves a lifestyle asset from the plan.

naviplancentral_plan.LifestyleAssets_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of lifestyle asset to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output LifestyleAssetModel

LivePlan_GetGoalsByClientidPlanid

Retrieves all goals from the live plan

naviplancentral_plan.LivePlan_GetGoalsByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalsModelsLiveGoalBaseModel

LivePlan_GetGoalFundingListByClientidPlanid

This function retrieves a list of funding accounts for the goals in the plan

naviplancentral_plan.LivePlan_GetGoalFundingListByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalsModelsGoalFundingListModel

LivePlan_GetWhatAreMyOptionsByIdClientidPlanid

This function retrieves the WAMO values for the specified goal

naviplancentral_plan.LivePlan_GetWhatAreMyOptionsByIdClientidPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: The id of the goal
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel

LivePlan_GetAccountsByClientidPlanid

Retrieves accounts for a given plan

naviplancentral_plan.LivePlan_GetAccountsByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiNetWorthModelsAccountBaseModel

LivePlan_GetLiabilitiesByClientidPlanid

Retrieves liabilities for a given plan

naviplancentral_plan.LivePlan_GetLiabilitiesByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiNetWorthModelsLiabilityBaseModel

LivePlan_GetLifestyleAssetsByClientidPlanid

Retrieves lifestyle assets for a given plan

naviplancentral_plan.LivePlan_GetLifestyleAssetsByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetBaseModel

LivePlan_GetRealEstateAssetsByClientidPlanid

Retrieves real estate accounts for a given plan

naviplancentral_plan.LivePlan_GetRealEstateAssetsByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiNetWorthModelsRealEstateBaseModel

LivePlan_GetProjectedNetWorthByClientidPlanid

Retrieves net worth projections

naviplancentral_plan.LivePlan_GetProjectedNetWorthByClientidPlanid({
  "planId": ""
}, context)

Input

• input object
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsModel

LivePlan_GetProjectedNeedsVsAbilitiesByIdClientidPlanid

Retrieves needs vs abilities projections

naviplancentral_plan.LivePlan_GetProjectedNeedsVsAbilitiesByIdClientidPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Output

• output AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsModel

NetWorth_GetByPlanid

This operation retrieves an object containing net worth values for specific dates within the plan: Plan Start Date Retirement Date * Plan End Date.

naviplancentral_plan.NetWorth_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output NetWorthModel

Password_HasUserSetPassword

Determines if the currently logged in user has set their own password

naviplancentral_plan.Password_HasUserSetPassword(null, context)

Input

This action has no parameters

Output

Output schema unknown

Password_PasswordRequirements

Gets the password complexity requirements

naviplancentral_plan.Password_PasswordRequirements(null, context)

Input

This action has no parameters

Output

Output schema unknown

Password_ResetByModel

Resets the password for the supplied user name

naviplancentral_plan.Password_ResetByModel({
  "model": {
    "userName": "",
    "locale": ""
  }
}, context)

Input

• input object
  • model required ResetPasswordModel

Output

Output schema unknown

Password_SetByModel

Sets the password for the currently logged in user

naviplancentral_plan.Password_SetByModel({
  "model": {}
}, context)

Input

• input object
  • model required SetPasswordModel

Output

Output schema unknown

PlanInformation_GetByPlanid

This operation retrieves the high level plan information for a given plan

naviplancentral_plan.PlanInformation_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output PlanInformationModel

PlanStatuses_GetByPlanid

This operation retrieves the data statuses of the published plan if on demand updates are enabled

naviplancentral_plan.PlanStatuses_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3)

Output

• output PlanStatusesModel

PortfolioAccounts_GetByPlanid

This operation retrieves a list of all of the portfolio accounts in the plan.

naviplancentral_plan.PortfolioAccounts_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output PortfolioAccountsModel

PortfolioAccounts_GetByIdPlanid

This operation retrieves a portfolio account from the plan.

naviplancentral_plan.PortfolioAccounts_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of portfolio account to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output PortfolioAccountModel

ProjectedAnnualSummary_GetByPlanid

This operation retrieves an object containing annual summary information for each year of the projected plan.

naviplancentral_plan.ProjectedAnnualSummary_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output ProjectedAnnualSummariesModel

ProjectedAnnualSummary_GetByIdPlanid

This operation retrieves an object containing annual summary information for a single specified year of the projected plan.

naviplancentral_plan.ProjectedAnnualSummary_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: Index into the list of annual projections
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output ProjectedAnnualSummaryModel

ProjectedCashFlow_GetByPlanid

This operation retrieves an object containing cash flow information for each year of the projected plan.

naviplancentral_plan.ProjectedCashFlow_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output CashFlowProjectionsModel

ProjectedCashFlow_GetByIdPlanid

This operation retrieves an object containing cash flow information for a single specified year of the projected plan.

naviplancentral_plan.ProjectedCashFlow_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: Index into the list of annual projections
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output CashFlowProjectionModel

ProjectedGoals_GetAssetsFundingGoalsByPlanid

This operation retrieves the assets funding each goal throughout the plan years

naviplancentral_plan.ProjectedGoals_GetAssetsFundingGoalsByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output AssetsFundingGoalModel

ProjectedGoals_GetNeedsVsAbilitiesByPlanid

This operation retrieves a needs and abilities data for all goals throughout the plan years.

naviplancentral_plan.ProjectedGoals_GetNeedsVsAbilitiesByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output NeedsVsAbilitiesModel

ProjectedNetWorth_GetByPlanid

This operation retrieves an object containing net worth information for each year of the projected plan. These are EOY numbers.

naviplancentral_plan.ProjectedNetWorth_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output NetWorthProjectionsModel

ProjectedNetWorth_GetByIdPlanid

This operation retrieves an object containing net worth information for a single specified year of the projected plan. These are EOY numbers.

naviplancentral_plan.ProjectedNetWorth_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: Index into the list of annual projections
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output NetWorthProjectionModel

RestrictedStocks_GetByPlanid

This operation retrieves a list of all of the restricted stocks in the plan.

naviplancentral_plan.RestrictedStocks_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output RestrictedStocksModel

RestrictedStocks_GetByIdPlanid

This operation retrieves a restricted stock from the plan.

naviplancentral_plan.RestrictedStocks_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of restricted stock to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output RestrictedStockModel

ServiceInformation_Statistics

This resource can be used to check the status of the service.

naviplancentral_plan.ServiceInformation_Statistics(null, context)

Input

This action has no parameters

Output

• output ServiceInformation

StockOptions_GetByPlanid

This operation retrieves a list of all of the stock options in the plan.

naviplancentral_plan.StockOptions_GetByPlanid({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output StockOptionsModel

StockOptions_GetByIdPlanid

This operation retrieves a stock option from the plan.

naviplancentral_plan.StockOptions_GetByIdPlanid({
  "id": 0,
  "planId": ""
}, context)

Input

• input object
  • id required integer: ID of stock option to retrieve
  • planId required string: Id of the plan to retrieve data from (e.g. 1001-11-3).

Output

• output StockOptionModel

Auth_LoginByModel

Start a session with the DomainProviders user store

naviplancentral_plan.Auth_LoginByModel({
  "model": {}
}, context)

Input

• input object
  • model required LoginModel

Output

• output PublicSessionInfoModel

Auth_PasswordRequirements

Gets the login rules

naviplancentral_plan.Auth_PasswordRequirements(null, context)

Input

This action has no parameters

Output

Output schema unknown

Auth_Logout

naviplancentral_plan.Auth_Logout(null, context)

Input

This action has no parameters

Output

Output schema unknown

Auth_ResumeSession

Validate and extend the duration of a session

naviplancentral_plan.Auth_ResumeSession(null, context)

Input

This action has no parameters

Output

• output PublicSessionInfoModel

Definitions

AdvicentDomainLogicGoalWhatIfEducationGoalAdjustments

• AdvicentDomainLogicGoalWhatIfEducationGoalAdjustments object
  • duration number
  • expensesCovered number
  • lumpSumContribution number
  • lumpSumDate string
  • monthlySavingsContribution number

AdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments

• AdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments object
  • lumpSumContribution number
  • lumpSumDate string
  • monthlySavingsContribution number
  • targetDate string
  • totalNeed number

AdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments

• AdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments object
  • clientRetirementAge number
  • coClientRetirementAge number
  • discretionaryExpenseCoverage number
  • fixedExpenseCoverage number
  • lumpSumContribution number
  • lumpSumDate string
  • monthlySavingsContribution number

AdvicentNaviPlanRestApiGoalAdjustmentsCalcProjection

• AdvicentNaviPlanRestApiGoalAdjustmentsCalcProjection object
  • projectedAbilities number
  • projectedNeed number
  • projectedRetirementAssetValues number
  • year integer

AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

• AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections object
  • goalId integer
  • percentCovered number
  • projections array
    • items AdvicentNaviPlanRestApiGoalAdjustmentsCalcProjection

AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments object
  • adjustedValues AdvicentDomainLogicGoalWhatIfEducationGoalAdjustments
  • created string
  • goalId integer

AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments object
  • adjustedValues AdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments
  • created string
  • goalId integer

AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments object
  • adjustedValues AdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments
  • created string
  • goalId integer

AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments object
  • goalAdjustments AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments
  • projectedResults AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments object
  • goalAdjustments AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments
  • projectedResults AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsCoverageProjectionsResultModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments object
  • goalAdjustments AdvicentNaviPlanRestApiGoalAdjustmentsGoalAdjustmentsResultAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments
  • projectedResults AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

AdvicentNaviPlanRestApiGoalAdjustmentsModelsEducationGoalAdjustmentsModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsEducationGoalAdjustmentsModel object
  • adjustedValues AdvicentDomainLogicGoalWhatIfEducationGoalAdjustments
  • created string
  • goalId integer
  • projectedResults AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfEducationGoalAdjustments object
  • adjustedValues AdvicentDomainLogicGoalWhatIfEducationGoalAdjustments

AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments object
  • adjustedValues AdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments

AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalAdjustmentsModelAdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments object
  • adjustedValues AdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments

AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateModel object
  • description string
  • goalId integer
  • successRate number

AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateResultsModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateResultsModel object
  • goalSuccessRateResults array
    • items AdvicentNaviPlanRestApiGoalAdjustmentsModelsGoalSuccessRateModel

AdvicentNaviPlanRestApiGoalAdjustmentsModelsMajorPurchaseGoalAdjustmentsModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsMajorPurchaseGoalAdjustmentsModel object
  • adjustedValues AdvicentDomainLogicGoalWhatIfMajorPurchaseGoalAdjustments
  • created string
  • goalId integer
  • projectedResults AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsEducationRestriction

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsEducationRestriction object
  • canChangeDuration boolean
  • goalId integer

AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsResultModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsResultModel object
  • educationRestrictions array
    • items AdvicentNaviPlanRestApiGoalAdjustmentsModelsRestrictionsEducationRestriction

AdvicentNaviPlanRestApiGoalAdjustmentsModelsRetirementGoalAdjustmentsModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsRetirementGoalAdjustmentsModel object
  • adjustedValues AdvicentDomainLogicGoalWhatIfRetirementGoalAdjustments
  • created string
  • goalId integer
  • projectedResults AdvicentNaviPlanRestApiGoalAdjustmentsCoverageProjections

AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel

• AdvicentNaviPlanRestApiGoalAdjustmentsModelsWhatAreMyOptionsModel object
  • additionalMonthlySavings number
  • clientRetirementAge integer
  • clientRetirementAgeDate string
  • coClientRetirementAge integer
  • coClientRetirementAgeDate string
  • expenseCoverageDollars number
  • expenseCoveragePercentage number
  • lumpSumSavings number
  • purchaseDate string

AdvicentNaviPlanRestApiGoalsModelsGoalFundingAccount

• AdvicentNaviPlanRestApiGoalsModelsGoalFundingAccount object
  • accountId integer
  • description string
  • fundingAmount number

AdvicentNaviPlanRestApiGoalsModelsGoalFundingListItem

• AdvicentNaviPlanRestApiGoalsModelsGoalFundingListItem object
  • description string
  • fundingAccounts array
    • items AdvicentNaviPlanRestApiGoalsModelsGoalFundingAccount
  • goalId integer

AdvicentNaviPlanRestApiGoalsModelsGoalFundingListModel

• AdvicentNaviPlanRestApiGoalsModelsGoalFundingListModel object
  • goals array
    • items AdvicentNaviPlanRestApiGoalsModelsGoalFundingListItem

AdvicentNaviPlanRestApiGoalsModelsLiveGoalBase

• AdvicentNaviPlanRestApiGoalsModelsLiveGoalBase object
  • amount number
  • coveragePercentage number
  • description string
  • endDate string
  • id integer
  • inflationRate number
  • owners array
    • items AdvicentNaviPlanRestApiModelsOwnerModel
  • startDate string
  • type string

AdvicentNaviPlanRestApiGoalsModelsLiveGoalBaseModel

• AdvicentNaviPlanRestApiGoalsModelsLiveGoalBaseModel object
  • clientDescription string
  • clientId integer
  • goals array
    • items AdvicentNaviPlanRestApiGoalsModelsLiveGoalBase
  • planDescription string
  • planLastUpdateTime string

AdvicentNaviPlanRestApiModelsOwnerModel

• AdvicentNaviPlanRestApiModelsOwnerModel object
  • firstName string
  • id integer
  • lastName string

AdvicentNaviPlanRestApiNetWorthModelsAccountBaseModel

• AdvicentNaviPlanRestApiNetWorthModelsAccountBaseModel object
  • accounts array
    • items AdvicentNaviPlanRestApiNetWorthModelsAccountModel

AdvicentNaviPlanRestApiNetWorthModelsAccountModel

• AdvicentNaviPlanRestApiNetWorthModelsAccountModel object
  • description string
  • holdings array
    • items AdvicentNaviPlanRestApiNetWorthModelsHoldingModel
  • id integer
  • legacyId string
  • owner AdvicentNaviPlanRestApiModelsOwnerModel
  • type integer

AdvicentNaviPlanRestApiNetWorthModelsHoldingModel

• AdvicentNaviPlanRestApiNetWorthModelsHoldingModel object
  • description string
  • marketValue number
  • valuationDate string

AdvicentNaviPlanRestApiNetWorthModelsLiabilityBaseModel

• AdvicentNaviPlanRestApiNetWorthModelsLiabilityBaseModel object
  • liabilities array
    • items AdvicentNaviPlanRestApiNetWorthModelsLiabilityModel

AdvicentNaviPlanRestApiNetWorthModelsLiabilityModel

• AdvicentNaviPlanRestApiNetWorthModelsLiabilityModel object
  • description string
  • endDate string
  • id integer
  • legacyId string
  • outstandingPrincipal number
  • outstandingPrincipalAsOfDate string
  • owner AdvicentNaviPlanRestApiModelsOwnerModel
  • startDate string
  • type integer

AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetBaseModel

• AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetBaseModel object
  • lifestyleAssets array
    • items AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetModel

AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetModel

• AdvicentNaviPlanRestApiNetWorthModelsLifestyleAssetModel object
  • description string
  • id integer
  • owner AdvicentNaviPlanRestApiModelsOwnerModel
  • purchaseDate string
  • purchaseValue number
  • type integer
  • valuationDate string
  • valuationValue number

AdvicentNaviPlanRestApiNetWorthModelsRealEstateBaseModel

• AdvicentNaviPlanRestApiNetWorthModelsRealEstateBaseModel object
  • realEstateAssets array
    • items AdvicentNaviPlanRestApiNetWorthModelsRealEstateModel

AdvicentNaviPlanRestApiNetWorthModelsRealEstateModel

• AdvicentNaviPlanRestApiNetWorthModelsRealEstateModel object
  • description string
  • id integer
  • legacyId string
  • marketValue number
  • owner AdvicentNaviPlanRestApiModelsOwnerModel
  • purchaseAmount number
  • purchaseDate string
  • valuationDate string

AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsModel

• AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsModel object
  • goalId integer
  • percentCovered number
  • projections array
    • items AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsYear

AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsYear

• AdvicentNaviPlanRestApiProjectionsModelsNeedsVsAbilitiesProjectionsYear object
  • projectedAbilities number
  • projectedNeed number
  • year integer

AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsModel

• AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsModel object
  • netWorthProjections array
    • items AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsYearModel

AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsYearModel

• AdvicentNaviPlanRestApiProjectionsModelsNetWorthProjectionsYearModel object
  • endOfYearRetirementAssets number
  • endOfYearTotalAssets number
  • year integer

AdvisorModel

• AdvisorModel object
  • addressLine1 string
  • addressLine2 string
  • advisorId string
  • advisorTitle string
  • businessPhone string
  • cellPhone string
  • city string
  • emailAddress string
  • faxPhone string
  • firstName string
  • homePhone string
  • lastName string
  • links array
    • items ObjectLink
  • middleName string
  • officeName string
  • officeWebsite string
  • pagerNumber string
  • postalCode string
  • stateProvince string

AdvisorsModel

• AdvisorsModel object
  • advisors array
    • items AdvisorModel

AssetsFundingGoalModel

• AssetsFundingGoalModel object
  • links array
    • items ObjectLink
  • projections array
    • items ProjectedGoalsSummary[AssetsFundingGoalSummary]

AssetsFundingGoalSummary

• AssetsFundingGoalSummary object
  • contributions IAccumulationCategoryData
  • endOfYearAssets IAccumulationCategoryData
  • goalType string
  • growthAndReinvestments IAccumulationCategoryData
  • identifier integer
  • netWithdrawals number
  • withdrawals IAccumulationCategoryData

AssumptionsModel

• AssumptionsModel object
  • assumptions IAssumptions
  • links array
    • items ObjectLink

BenefitCurrencyWithGrowth

• BenefitCurrencyWithGrowth object
  • benefitType string (values: DeathBenefit, MonthlyBenefit, DailyBenefit, MaximumBenefit, WeeklyBenefit, AnnualBenefit, LumpSum)
  • value CurrencyWithGrowth

BusinessEntitiesModel

• BusinessEntitiesModel object
  • businessEntities array
    • items IBusinessEntity
  • links array
    • items ObjectLink

BusinessEntityModel

• BusinessEntityModel object
  • businessEntity IBusinessEntity
  • links array
    • items ObjectLink

CashFlowProjectionModel

• CashFlowProjectionModel object
  • cashFlow ProjectedCashFlowSummary
  • links array
    • items ObjectLink

CashFlowProjectionsModel

• CashFlowProjectionsModel object
  • links array
    • items ObjectLink
  • projections array
    • items CashFlowProjectionModel

CashFlowSummary

• CashFlowSummary object
  • surplusDeficit number
  • totalIncome number
  • totalOutflowsWithTaxes number
  • totalOutflowsWithoutTaxes number
  • totalTaxes number

ClientPlanSelectorParams

• ClientPlanSelectorParams object: Parameters to select a plan from a client file
  • clientId string: Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions.
  • planId required string: Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

Currency

• Currency object
  • formattedDecimal string
  • formattedNoDecimal string
  • raw number

CurrencyWithDate

• CurrencyWithDate object
  • date Date
  • formattedDecimal string
  • formattedNoDecimal string
  • raw number

CurrencyWithGrowth

• CurrencyWithGrowth object
  • formattedDecimal string
  • formattedNoDecimal string
  • growth GrowthRateValues
  • raw number

Date

• Date object
  • day integer
  • formatted string
  • formattedMMMMddyyyy string
  • formattedMMMdd string
  • formattedMMMddyyyy string
  • formattedMMMyyyy string
  • formattedNA string
  • month integer
  • toDateTime string
  • urlEncoded string
  • year integer

DefinedBenefitPensionModel

• DefinedBenefitPensionModel object
  • definedBenefitPension IDefinedBenefitPension
  • links array
    • items ObjectLink

DefinedBenefitPensionsModel

• DefinedBenefitPensionsModel object
  • definedBenefitPensions array
    • items IDefinedBenefitPension
  • links array
    • items ObjectLink

DescriptiveBoolean

• DescriptiveBoolean object
  • rawValue boolean
  • valueAsYesNo string

FamilyModel

• FamilyModel object
  • family IFamily
  • links array
    • items ObjectLink

FormattedDateRange

• FormattedDateRange object
  • endDate Date
  • startDate Date

FormattedEnumTypeDistributionDividendType

• FormattedEnumTypeDistributionDividendType object
  • value string (values: TaxableIneligible, NonTaxable, TaxableEligible)

FormattedEnumTypeFrequency

• FormattedEnumTypeFrequency object
  • value string (values: Annual, SemiAnnual, Quarterly, Bimonthly, Monthly, TwiceMonthly, BiWeekly, Weekly, Daily, Continuously, Onetime, EveryXYears)

FormattedEnumTypeGender

• FormattedEnumTypeGender object
  • value string (values: Male, Female)

FormattedEnumTypeInterCompanyDividendType

• FormattedEnumTypeInterCompanyDividendType object
  • value string (values: NonTaxable, NonTaxableCda, NonTaxableEligible, TaxableEligible, TaxableIneligible)

FormattedEnumTypeLiabilityType

• FormattedEnumTypeLiabilityType object
  • value string (values: Personal, Business, CreditCard, Mortgage, Vehicle, PolicyLoan)

FormattedEnumTypePayOffOptionsType

• FormattedEnumTypePayOffOptionsType object
  • value string (values: TransferToSurvivor, PayOffAtFirstDeath, PayOffAtOwnerDeath, InsuredForLife)

FormattedEnumTypePaymentType

• FormattedEnumTypePaymentType object
  • value string (values: InterestOnly, PrincipalAndInterest, SetPayment, LastPeriodPayment)

FormattedEnumTypePrivateCorporationShareType

• FormattedEnumTypePrivateCorporationShareType object
  • value string (values: Undefined, Common, Preferred)

FormattedEnumTypeSEPPDistributionMethod

• FormattedEnumTypeSEPPDistributionMethod object
  • value string (values: RequiredMinDistribution, Amortization, Annuitization)

FormattedEnumTypeSEPPLifeExpectancyTable

• FormattedEnumTypeSEPPLifeExpectancyTable object
  • value string (values: NOT_APPLICABLE_UPPER_CASE, SingleLifeExpectancy, NonSingleLifeExpectancy)

FormattedEnumTypeSavingsStrategyType

• FormattedEnumTypeSavingsStrategyType object
  • value string (values: PreTax, PostTax, Employer, Owner, Mandatory)

FormattedLifestyleType

• FormattedLifestyleType object
  • formatted string
  • value string (values: Undefined, PersonalUse, ListedPersonal, PrimaryResidence, SecondaryResidence, BusinessInterest, Automobile)

FormattedMaritalOrTaxFilingStatus

• FormattedMaritalOrTaxFilingStatus object
  • value string (values: Undefined, Single, HeadOfHousehold, MarriedFilingJointly, MarriedFilingSeparately, SingleParent, Married, CommonLaw, Partner, Divorced, Widowed, Separated)

GoalCoveragePercent

• GoalCoveragePercent object
  • formattedRaw number
  • raw number

GoalId

• GoalId object
  • id integer

GoalModel

• GoalModel object
  • goal IGoal
  • links array
    • items ObjectLink

GoalNeedsVsAbilitiesSummary

• GoalNeedsVsAbilitiesSummary object
  • abilities number
  • fixedNeeds number
  • fixedNeedsWithTaxes number
  • goalType string
  • identifier integer
  • totalNeeds number
  • totalNeedsWithTaxes number

GoalsModel

• GoalsModel object
  • goals array
    • items IGoal
  • links array
    • items ObjectLink

GrowthRateValues

• GrowthRateValues object
  • additionalGrowthPercent Percent
  • isInflationAdjusted boolean
  • totalGrowth Percent

HoldingCompaniesModel

• HoldingCompaniesModel object
  • holdingCompanies array
    • items IHoldingCompany
  • links array
    • items ObjectLink

HoldingCompanyModel

• HoldingCompanyModel object
  • holdingCompany IHoldingCompany
  • links array
    • items ObjectLink

HouseholdExternalModel

• HouseholdExternalModel object
  • accessiblePlans array
    • items PublishedPlanModel
  • clientDescription string
  • householdId integer
  • legacyClientId string

HouseholdModel

• HouseholdModel object
  • accessiblePlans array
    • items PublishedPlanModel
  • clientDescription string
  • householdId integer

HouseholdsExternalDataModel

• HouseholdsExternalDataModel object
  • externalHouseholdsData array
    • items HouseholdExternalModel

HouseholdsModel

• HouseholdsModel object
  • households array
    • items HouseholdModel
  • links array
    • items ObjectLink

IAccumulationCategoryData

• IAccumulationCategoryData object
  • allAssets Currency
  • lockedIn Currency
  • nonQualified Currency
  • qualified Currency
  • roth Currency
  • tfsa Currency

IActivityData

• IActivityData object
  • amountWithGrowth CurrencyWithGrowth
  • applicableDateRange FormattedDateRange
  • directTo string
  • frequency IFormattedFrequency

IAddress

• IAddress object
  • city string
  • combinedCityStateProvince string
  • country string
  • stateOrProvince string
  • stateOrProvinceAbbrev string
  • street1 string
  • street2 string
  • zipOrPostalCode string

IAssetCategories

• IAssetCategories object
  • allAssets array
    • items IValueDescriptionPair[Currency]
  • businessAssets INetWorthCategory
  • lifestyleAssets INetWorthCategory
  • nonQualifiedAnnuities INetWorthCategory
  • nonQualifiedAssets INetWorthCategory
  • privateCorporations INetWorthCategory
  • qualifiedAnnuities INetWorthCategory
  • qualifiedAssets INetWorthCategory
  • realEstate INetWorthCategory
  • totalAssets INetWorthCategory

IAssetClass

• IAssetClass object
  • index integer
  • maxConstraint Percent
  • minConstraint Percent
  • name string
  • parentSuperAssetClassIndex integer
  • weight IAssetClassWeight

IAssetClassWeight

• IAssetClassWeight object
  • dollarValue Currency
  • percentage Percent

IAssetId

• IAssetId object
  • rawId integer

IAssetMix

• IAssetMix object
  • assetClassDisplayLevel integer
  • assetClassInfoForDisplayLevel array
    • items integer
  • classes array
    • items IAssetClass
  • superAssetClasses array
    • items IAssetClass

IAssetValuation

• IAssetValuation object
  • costBasis Currency
  • marketValue Currency
  • valuationDate Date

IAssets

• IAssets object
  • allAssets IAssetCategories
  • clientAssets IAssetCategories
  • coClientAssets IAssetCategories
  • communityPropertyAssets IAssetCategories
  • jointAssets IAssetCategories

IAssumptions

• IAssumptions object
  • anyHeadAlreadyRetired boolean
  • bothRetired boolean
  • bucketing IBucketing
  • client IHeadAssumptions
  • coClient IHeadAssumptions
  • firstToDieDate Date
  • firstToDieMember string (values: Client, CoClient)
  • firstToRetireDate Date
  • inflationRate Percent
  • lastToDieDate Date
  • lastToDieMember string (values: Client, CoClient)
  • lastToRetireDate Date
  • retirementYearAdjustedIfAlreadyRetired Year
  • splitSurplusSavingsStrategiesEnabled boolean
  • taxMethod string (values: Average, Simplified, Detailed)

IBucketing

• IBucketing object
  • distributionBucketTargetBalance Currency
  • endDate Date
  • indexedAt Percent
  • returnRate Percent
  • standardDeviation Percent
  • startDate Date

IBusinessEntity

• IBusinessEntity object
  • activities array
    • items IBusinessEntityActivity
  • assetId IAssetId
  • businessType string (values: Undefined, LLC, Partnership, SCorporation, CCorporation)
  • businessTypeFormatted string
  • currentAnnualDistributions Currency
  • currentAnnualDividends Currency
  • currentAnnualGrowthRate Percent
  • currentAnnualNetIncome Currency
  • entityName string
  • liquidationEvent ILiquidationEvent
  • marketValuationDate Date
  • marketValue Currency
  • owner string
  • purchaseAmount Currency
  • purchaseDate Date
  • standardDeviation Percent

IBusinessEntityActivity

• IBusinessEntityActivity object
  • applicableDateRange FormattedDateRange
  • distributions Currency
  • expense Currency
  • frequency FormattedEnumType[Frequency]
  • income Currency
  • indexRate GrowthRateValues

IBusinessPhoneNumbers

• IBusinessPhoneNumbers object
  • business string
  • fax string

ICanadianGovernmentPensions

• ICanadianGovernmentPensions object
  • canadianOrQuebecPensionPlan Currency
  • oldAgeSecurity Currency

ICashFlow

• ICashFlow object
  • incomes ICashFlowIncomes
  • outflows ICashFlowOutflows
  • surplusDeficit Currency
  • taxes ITaxes

ICashFlowByOwner

• ICashFlowByOwner object
  • clientCashFlow ICashFlow
  • coClientCashFlow ICashFlow
  • totalCashFlow ICashFlow

ICashFlowCategory

• ICashFlowCategory object
  • isItemizedEnabled boolean
  • itemized array
    • items ICashFlowItem
  • total Currency

ICashFlowIncomes

• ICashFlowIncomes object
  • annuityPayments ICashFlowCategory
  • disabilityIncomes Currency
  • earnedIncome ICashFlowCategory
  • insuranceBenefits ICashFlowCategory
  • investmentIncomes ICashFlowCategory
  • lifestyleAssetLiquidations ICashFlowCategory
  • lockedInLiquidations Currency
  • longTermCareBenefits Currency
  • miscellaneousIncomes ICashFlowCategory
  • nonQualifiedLiquidations ICashFlowCategory
  • pension ICashFlowCategory
  • privateCorporations ICashFlowCategory
  • qualifiedLiquidations ICashFlowCategory
  • qualifiedLiquidationsNonRequiredMinimumDistributions ICashFlowCategory
  • requiredMinimumDistributions ICashFlowCategory
  • retirementIncome Currency
  • rothLiquidations Currency
  • socialSecurity ICashFlowCategory
  • tfsaLiquidations Currency
  • total ICashFlowCategory
  • withdrawals Currency

ICashFlowItem

• ICashFlowItem object
  • description string
  • descriptionWithOwner string
  • isCPP boolean
  • isOAS boolean
  • sourceId string
  • typeDescription string
  • value Currency

ICashFlowOutflows

• ICashFlowOutflows object
  • contributions Currency
  • educationExpenses ICashFlowCategory
  • employerExpenses ICashFlowCategory
  • employmentBusinessExpenses ICashFlowCategory
  • investmentExpenses ICashFlowCategory
  • lifestyleExpenses ICashFlowCategory
  • lifestyleExpensesDiscretionary ICashFlowCategory
  • lifestyleExpensesFixed ICashFlowCategory
  • lockedInContributions Currency
  • medicalExpenses ICashFlowCategory
  • miscellaneousExpenses ICashFlowCategory
  • miscellaneousExpensesDiscretionary ICashFlowCategory
  • miscellaneousExpensesFixed ICashFlowCategory
  • nonQualifiedContributions ICashFlowCategory
  • nonQualifiedReinvestments ICashFlowCategory
  • privateCorporationOutflows ICashFlowCategory
  • qualifiedContributions ICashFlowCategory
  • rothContributions Currency
  • surplusOutflows ICashFlowCategory
  • surplusSavings Currency
  • tfsaContributions Currency
  • totalNeeds Currency
  • totalWithTaxes Currency
  • totalWithoutTaxes Currency

ICommonShareClassDetails

• ICommonShareClassDetails object
  • shareClassStructure IShareClassStructure

IContributions

• IContributions object
  • interCompanyDividendsReceived array
    • items IInterCompanyDividendReceived
  • sharePurchases array
    • items ISharePurchase
  • shareholderLoans array
    • items IShareholderLoan

ICorporationRealEstateAsset

• ICorporationRealEstateAsset object
  • currentYearNetRentalIncome Currency
  • description string
  • id string
  • isActiveBusinessIncome DescriptiveBoolean
  • marketValueAsOf CurrencyWithDate
  • owner string (values: All, Head1, Head2, NonHead1, NonHead2, NonHead3, NonHead4, NonHead5, NonHead6, NonHead7, NonHead8, NonHead9, CommunityProperty, Joint, Other, AllDependents, AllFamilyMembers, Corporation)
  • preTaxGrowthRate Percent
  • purchaseAmount Currency
  • purchaseDate Date
  • standardDeviation Percent
  • startOfYearCostBasis Currency
  • startOfYearMarketValue Currency

IDebtModStrategies

• IDebtModStrategies object
  • lumpSumDebtModStrategies array
    • items ILumpSumDebtModStrategy
  • periodicDebtModStrategies array
    • items IPeriodicDebtModStrategy

IDefinedBenefitPension

• IDefinedBenefitPension object
  • benefit IOptionalField[Benefit[CurrencyWithGrowth]]
  • description string
  • isBenefitFormula boolean
  • isBenefitIntegratedWithCppQpp boolean
  • isFormulaIntegratedWithCppQpp boolean
  • owner string (values: Client, CoClient)
  • pensionType string
  • percentPayableToSurvivor Percent
  • projectedYearsOfService integer
  • startDate Date

IDependent

• IDependent object
  • address IAddress
  • ageAsOfPlanDate integer
  • birthdate Date
  • citizenship string
  • dependentOf string
  • dependentOfId string (values: All, Head1, Head2, NonHead1, NonHead2, NonHead3, NonHead4, NonHead5