/api/GoalAdjustments/Retirement/Calculations

Perform calculations

• planId (query, required) — Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

/api/auth/ResumeSession

Validate and extend the duration of a session

/api/Advisors

Retrieve Advisors

/api/Advisors/{householdId}/{clientId}

Retrieve Advisors for a Client

• householdId (path, required) — Integer id of the household
• clientId (path, required) — Guid id of the client.

/api/Advisors/{id}

Retrieve an Advisor

• id (path, required) — Guid id of the advisor

/api/Assumptions

Retrieve plan assumptions

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/BusinessEntities

Retrieve business entities

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/BusinessEntities/{id}

Retrieve a business entity

• id (path, required) — ID of business entity to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/Calculations/MonteCarlo

Retrieve Monte Carlo results from standalone calc service

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/DefinedBenefitPensions

Retrieve defined benefit pensions

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/DefinedBenefitPensions/{id}

Retrieve a definedBenefitPension

• id (path, required) — ID of defined benefit pension to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/Eula/Accept

Accepts the EULA

/api/Family

Retrieve family

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/GoalAdjustments/Education/{id}/Adjustments

Retrieve the adjustments

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

/api/GoalAdjustments/Education/{id}/Calculations

Perform calculations

• id (path, required) — The id of the goal to retrieve adjustments for.
• planId (query, required) — Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

/api/GoalAdjustments/GoalSuccessRates

Returns a list of goals with their relevant success rates.

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

/api/GoalAdjustments/MajorPurchase/{id}/Adjustments

Retrieve the adjustments

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

/api/GoalAdjustments/MajorPurchase/{id}/Calculations

Perform calculations

• id (path, required) — The id of the goal to retrieve adjustments for.
• planId (query, required) — Id of the Plan to retrieve or update data for (e.g. 1001-11-3).

/api/GoalAdjustments/Restrictions

Returns a list of goal adjustment restrictions.

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

/api/GoalAdjustments/Retirement/Adjustments

Retrieve the adjustments

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

/api/GoalAdjustments/{id}/WhatAreMyOptions

Returns WAMO values for current goal

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

/api/Goals

Retrieve goals

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/Goals/{id}

Retrieve goals

• id (path, required) — ID of goal to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/HoldingCompanies

Retrieve holding companies

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/HoldingCompanies/{id}

Retrieve a holding company

• id (path, required) — ID of holding company to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/Households

Retrieve all Households associated with the user

• householdId (query) — The Id of the specific household to retrieve

/api/Liabilities

Retrieve liabilities

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/Liabilities/{id}

Retrieve a liability

• id (path, required) — ID of liability to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/LifestyleAssets

Retrieve lifestyle assets

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/LifestyleAssets/{id}

Retrieve lifestyle assets

• id (path, required) — ID of lifestyle asset to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/LivePlan/Goals

Retrieves all goals from the live plan

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

/api/LivePlan/Goals/Funding

Retrieve a list of funding accounts

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

/api/LivePlan/Goals/{id}/WhatAreMyOptions

Retrieve WAMO values for a given goal

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

/api/LivePlan/NetWorth/Accounts

Retrieves accounts for a given plan

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

/api/LivePlan/NetWorth/Liabilities

Retrieves liabilities for a given plan

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

/api/LivePlan/NetWorth/LifestyleAssets

Retrieves lifestyle assets for a given plan

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

/api/LivePlan/NetWorth/RealEstate

Retrieves real estate accounts for a given plan

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

/api/LivePlan/Projections/NetWorth

Retrieves net worth projections

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

/api/LivePlan/Projections/{id}/NeedsVsAbilities

Retrieves needs vs abilities projections

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

/api/NetWorth

Retrieve net worth

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/Password/HasUserSetPassword

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

/api/Password/PasswordRequirements

Gets the password complexity requirements

/api/Password/Reset

Resets the password for the supplied user name

/api/Password/Set

Sets the password for the currently logged in user

/api/PlanInformation

Retrieve plan information

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/PlanStatuses

Retrieve plan data statuses

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3)

/api/PortfolioAccounts

Retrieve portfolio accounts

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/PortfolioAccounts/{id}

Retrieve a portfolio account

• id (path, required) — ID of portfolio account to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedAnnualSummary

Retrieve projected annual summaries

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedAnnualSummary/{id}

Retrieve projected annual summary by id

• id (path, required) — Index into the list of annual projections
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedCashFlow

Retrieve projected cash flow

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedCashFlow/{id}

Retrieve projected cash flow by id

• id (path, required) — Index into the list of annual projections
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedGoals/AssetsFundingGoals

Retrieve assets funding goals over time

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedGoals/NeedsVsAbilities

Retrieve needs vs abilities data

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedNetWorth

Retrieve projected net worth

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ProjectedNetWorth/{id}

Retrieve projected net worth by id

• id (path, required) — Index into the list of annual projections
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/RestrictedStocks

Retrieve restricted stocks

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/RestrictedStocks/{id}

Retrieve a restricted stock

• id (path, required) — ID of restricted stock to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/ServiceInformation/Statistics

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

/api/StockOptions

Retrieve stock options

• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/StockOptions/{id}

Retrieve a stock option

• id (path, required) — ID of stock option to retrieve
• planId (query, required) — Id of the plan to retrieve data from (e.g. 1001-11-3).

/api/auth/Login

Start a session with the DomainProviders user store

/api/auth/LoginConfiguration

Gets the login rules

/api/auth/Logout