5.0.0 • Published 5 years ago

@datafire/naviplancentral_factfinder v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/naviplancentral_factfinder

Client library for Advicent.FactFinderService

Installation and Usage

npm install --save @datafire/naviplancentral_factfinder
let naviplancentral_factfinder = require('@datafire/naviplancentral_factfinder').create();

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

Description

An API for accessing the NaviPlan Fact Finder.

Actions

AccountTypes_GetByCountry

Description: This operation retrieves all Account Types for the specified country. Purpose: Provides access to the Account Types including id and type description.

naviplancentral_factfinder.AccountTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Account Types

Output

AccountTypes_GetById

Description: This operation retrieves all Account Types for the specified id. Purpose: Provides access to the Account Types including id and type description.

naviplancentral_factfinder.AccountTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Account Type used to retreive the Account Type information

Output

Accounts_GetAccountsByFactFinderIdByFactfinderidExternalsourceid

Description: This operation retrieves all Accounts for the specified Fact Finder ID and/or external source ID. Purpose: Provides access to the Account information including description and market value.

naviplancentral_factfinder.Accounts_GetAccountsByFactFinderIdByFactfinderidExternalsourceid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Accounts
    • externalSourceId string: The external ID used to filter Accounts

Output

Accounts_PostByModel

Description: The operation creates an Account. Purpose: Allows for creation of Accounts on a Fact Finder.

naviplancentral_factfinder.Accounts_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

Accounts_GetAccountHoldingsByAccountid

Retrieves all holdings in the specified Account.

naviplancentral_factfinder.Accounts_GetAccountHoldingsByAccountid({
  "accountId": 0
}, context)

Input

  • input object
    • accountId required integer: The ID of the Account used to retrieve the Account Holding data

Output

Accounts_PostAccountHoldingByAccountidModel

Creates a holding and adds it to an existing Account.

naviplancentral_factfinder.Accounts_PostAccountHoldingByAccountidModel({
  "accountId": 0,
  "model": {
    "description": ""
  }
}, context)

Input

  • input object
    • accountId required integer: The existing Account ID used to identify which Account to add the holding to
    • model required AccountHoldingModel

Output

Accounts_PutHoldingsByAccountidHoldings

Updates all holdings associated with an account

naviplancentral_factfinder.Accounts_PutHoldingsByAccountidHoldings({
  "accountId": 0,
  "holdings": {}
}, context)

Input

Output

Accounts_DeleteAccountHoldingByAccountidId

Description: This operation deletes a single Account Holding for the specified Account Holding ID and Account ID. Purpose: Provides the ability to remove individual holdings from a specified Account.

naviplancentral_factfinder.Accounts_DeleteAccountHoldingByAccountidId({
  "accountId": 0,
  "id": 0
}, context)

Input

  • input object
    • accountId required integer: The ID of the Account used to retrieve the Account data that the specified holding belongs to.
    • id required integer: The ID of the Account Holding used to delete the Account Holding

Output

Output schema unknown

Accounts_GetAccountHoldingByAccountidId

Description: This operation retrieves a single Account Holding for the specified Account Holding ID and Account ID. Purpose: Provides access to the Account Holding information including description and market value.

naviplancentral_factfinder.Accounts_GetAccountHoldingByAccountidId({
  "accountId": 0,
  "id": 0
}, context)

Input

  • input object
    • accountId required integer: The ID of the Account used to retrieve the Account Holding data
    • id required integer: The ID of the Account Holding used to retrieve the Account Holding data

Output

Accounts_PutByAccountidIdHolding

Updates a holding associated with an account

naviplancentral_factfinder.Accounts_PutByAccountidIdHolding({
  "accountId": 0,
  "id": 0,
  "holding": {
    "description": ""
  }
}, context)

Input

  • input object
    • accountId required integer: The account with the holding to be updated
    • id required integer: The id of the holding to update
    • holding required AccountHoldingModel

Output

Accounts_DeleteSavingsStrategiesByAccountid

Deletes all savings strategies tied to an account

naviplancentral_factfinder.Accounts_DeleteSavingsStrategiesByAccountid({
  "accountId": 0
}, context)

Input

  • input object
    • accountId required integer: Id of the account that holds the savings strategies

Output

Output schema unknown

Accounts_GetSavingsStrategiesByAccountIdByAccountid

Get all of the savings strategies for a specific account

naviplancentral_factfinder.Accounts_GetSavingsStrategiesByAccountIdByAccountid({
  "accountId": 0
}, context)

Input

  • input object
    • accountId required integer: The id of the account to retrieve the savings strategies from

Output

Accounts_PostSavingsStrategyByAccountidSavingsstrategy

Creates a savings strategy on a specific account

naviplancentral_factfinder.Accounts_PostSavingsStrategyByAccountidSavingsstrategy({
  "accountId": 0,
  "savingsStrategy": {}
}, context)

Input

  • input object
    • accountId required integer: Id of the account to create a savings strategy for
    • savingsStrategy required SavingsStrategyModel

Output

Accounts_DeleteSavingsStrategyByAccountidId

Deletes a specific savings strategy

naviplancentral_factfinder.Accounts_DeleteSavingsStrategyByAccountidId({
  "accountId": 0,
  "id": 0
}, context)

Input

  • input object
    • accountId required integer: Id of the account that holds the savings strategy
    • id required integer: Id of the savings strategy to be deleted

Output

Output schema unknown

Accounts_GetSavingsStrategiesByAccountIdAndSavingsStrategyIdByAccountidId

Get a specific savings strategy for an account

naviplancentral_factfinder.Accounts_GetSavingsStrategiesByAccountIdAndSavingsStrategyIdByAccountidId({
  "accountId": 0,
  "id": 0
}, context)

Input

  • input object
    • accountId required integer: The id of the account to retrieve the savings strategies from
    • id required integer: The id of the savings strategy to get

Output

Accounts_PutSavingsStrategyByAccountidIdSavingsstrategy

Updates a specific savings strategy

naviplancentral_factfinder.Accounts_PutSavingsStrategyByAccountidIdSavingsstrategy({
  "accountId": 0,
  "id": 0,
  "savingsStrategy": {}
}, context)

Input

  • input object
    • accountId required integer: Id of the account that holds the savings strategy
    • id required integer: Id of the savings strategy to update
    • savingsStrategy required SavingsStrategyModel

Output

Accounts_DeleteAccountById

Description: The operation removes an Account tied to a Fact Finder. Purpose: Allows for removal of an Account from a Fact Finder.

naviplancentral_factfinder.Accounts_DeleteAccountById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Account ID used to identify which Account to remove

Output

Output schema unknown

Accounts_GetById

Description: This operation retrieves a single Account for the specified Account ID. Purpose: Provides access to the Account information including description and market value.

naviplancentral_factfinder.Accounts_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Account used to retrieve the Account data

Output

Accounts_PutByIdModel

Description: The operation updates an Account, deletes associated saving strategies if the account type changes. Purpose: Allows for complete replacement of an Account on a Fact Finder.

naviplancentral_factfinder.Accounts_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Account ID used to identify which Account to update
    • model required AccountModel

Output

Clients_PostByModel

Description: This operation submits the Fact Finder data to an external system. Purpose: Allows Fact Finder data to be persisted in another system for that system's consumption and use.

naviplancentral_factfinder.Clients_PostByModel({
  "model": {
    "factFinderId": 0,
    "planAction": ""
  }
}, context)

Input

Output

CriticalIllnessInsurancePolicies_GetCriticalIllnessInsurancePoliciesByFactFinderIdByFactfinderid

Description: This operation retrieves all Critical Illness Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Critical Illness Insurance Policies including description and policy type.

naviplancentral_factfinder.CriticalIllnessInsurancePolicies_GetCriticalIllnessInsurancePoliciesByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Critical Illness Insurance Policies

Output

CriticalIllnessInsurancePolicies_PostByModel

Description: The operation creates a Critical Illness Insurance Policy. Purpose: Allows for creation of Critical Illness Insurance Policies on a Fact Finder.

naviplancentral_factfinder.CriticalIllnessInsurancePolicies_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

CriticalIllnessInsurancePolicies_DeleteById

Description: The operation removes a Critical Illness Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Critical Illness Insurance Policy from a Fact Finder.

naviplancentral_factfinder.CriticalIllnessInsurancePolicies_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Critical Illness Insurance Policy ID used to identify which Critical Illness Insurance Policy to remove

Output

Output schema unknown

CriticalIllnessInsurancePolicies_GetById

Description: This operation retrieves a single Critical Illness Insurance Policy for the specified Critical Illness Insurance Policy ID. Purpose: Provides access to the Critical Illness Insurance Policy including description and policy type.

naviplancentral_factfinder.CriticalIllnessInsurancePolicies_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Critical Illness Insurance Policy used to retreive the Critical Illness Insurance Policy

Output

CriticalIllnessInsurancePolicies_PutByIdModel

Description: The operation updates a Critical Illness Insurance Policy. Purpose: Allows for complete replacement of a Critical Illness Insurance Policy on a Fact Finder.

naviplancentral_factfinder.CriticalIllnessInsurancePolicies_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Critical Illness Insurance Policy ID used to identify which Critical Illness Insurance Policy to update
    • model required CriticalIllnessInsurancePolicyModel

Output

CriticalIllnessInsurancePolicyTypes_GetByCountry

Description: This operation retrieves all Critical Illness Insurance Policy Types for the specified country. Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.

naviplancentral_factfinder.CriticalIllnessInsurancePolicyTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Critical Illness Insurance Policy Types

Output

CriticalIllnessInsurancePolicyTypes_GetById

Description: This operation retrieves the Critical Illness Insurance Policy Type for the specified id. Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.

naviplancentral_factfinder.CriticalIllnessInsurancePolicyTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Critical Illness Insurance Policy Type used to retreive the Critical Illness Insurance Policy Type information

Output

DefinedBenefitPensions_GetDefinedBenefitPensionsByFactFinderIdByFactfinderid

Description: This operation retrieves all Defined Benefit Pensions for the specified Fact Finder ID. Purpose: Provides access to the Defined Benefit Pensions including description and start date.

naviplancentral_factfinder.DefinedBenefitPensions_GetDefinedBenefitPensionsByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Defined Benefit Pensions

Output

DefinedBenefitPensions_PostByModel

Description: The operation creates a Defined Benefit Pension. Purpose: Allows for creation of Defined Benefit Pensions on a Fact Finder.

naviplancentral_factfinder.DefinedBenefitPensions_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

DefinedBenefitPensions_DeleteDefinedBenefitPensionById

Description: The operation removes a Defined Benefit Pension tied to a Fact Finder. Purpose: Allows for removal of a Defined Benefit Pension from a Fact Finder.

naviplancentral_factfinder.DefinedBenefitPensions_DeleteDefinedBenefitPensionById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Defined Benefit Pension ID used to identify which Defined Benefit Pension to remove

Output

DefinedBenefitPensions_GetById

Description: This operation retrieves a single Defined Benefit Pension for the specified Defined Benefit Pension ID. Purpose: Provides access to the Defined Benefit Pension including description and start date.

naviplancentral_factfinder.DefinedBenefitPensions_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Defined Benefit Pension used to retreive the Defined Benefit Pension

Output

DefinedBenefitPensions_PutDefinedBenefitPensionByIdModel

Description: The operation updates a Defined Benefit Pension. Purpose: Allows for complete replacement of a Defined Benefit Pension on a Fact Finder.

naviplancentral_factfinder.DefinedBenefitPensions_PutDefinedBenefitPensionByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Defined Benefit Pension ID used to identify which Defined Benefit Pension to update
    • model required DefinedBenefitPensionModel

Output

Demographics_GetDemographicsByFactFinderIdByFactfinderid

Description: This operation retrieves all Demographic information for the specified Fact Finder ID. Purpose: Provides access to the Demographic information including city and state.

naviplancentral_factfinder.Demographics_GetDemographicsByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Demographic information

Output

Demographics_PostByModel

Description: The operation creates Demographic information. Purpose: Allows for creation of Demographic information on a Fact Finder.

naviplancentral_factfinder.Demographics_PostByModel({
  "model": {
    "jointAnalysis": true,
    "head1": {
      "firstName": "",
      "lastName": "",
      "birthDate": "",
      "gender": "",
      "taxFilingStatus": 0,
      "alreadyRetired": true
    },
    "factFinderId": 0,
    "city": "",
    "state": 0
  }
}, context)

Input

Output

Demographics_GetDependentsByDemographicid

Description: This operation retrieves all Dependents for the specified Demographic information ID. Purpose: Provides access to the Dependents including first and last name.

naviplancentral_factfinder.Demographics_GetDependentsByDemographicid({
  "demographicId": 0
}, context)

Input

  • input object
    • demographicId required integer: The ID of the Demographic information used to retrieve Dependents

Output

Demographics_PostByDemographicidModel

Description: The operation creates a Dependent. Purpose: Allows for creation of Dependents on a Fact Finder.

naviplancentral_factfinder.Demographics_PostByDemographicidModel({
  "demographicId": 0,
  "model": {
    "firstName": "",
    "lastName": "",
    "birthDate": "",
    "relationship": "",
    "dependentOf": ""
  }
}, context)

Input

  • input object
    • demographicId required integer: The ID of the Demographic information to add the Dependent to
    • model required DemographicsDependentModel

Output

Demographics_DeleteDependentByDemographicidId

Description: The operation removes a Dependent tied to a Fact Finder. Purpose: Allows for removal of a Dependent from a Fact Finder.

naviplancentral_factfinder.Demographics_DeleteDependentByDemographicidId({
  "demographicId": 0,
  "id": 0
}, context)

Input

  • input object
    • demographicId required integer: The ID of the Demographic information used to identify which Dependent to remove
    • id required integer: The Dependent ID used to identify which Dependent to remove

Output

Output schema unknown

Demographics_GetDependentByDemographicidId

Description: This operation retrieves a single Dependent for the specified Dependent ID. Purpose: Provides access to the Dependent including first and last name.

naviplancentral_factfinder.Demographics_GetDependentByDemographicidId({
  "demographicId": 0,
  "id": 0
}, context)

Input

  • input object
    • demographicId required integer: The ID of the Demographic information used to retrieve Dependents
    • id required integer: The ID of the Dependent used to retreive the Dependent

Output

Demographics_PutByDemographicidIdModel

Description: The operation updates a Dependent. Purpose: Allows for complete replacement of a Dependent on a Fact Finder.

naviplancentral_factfinder.Demographics_PutByDemographicidIdModel({
  "demographicId": 0,
  "id": 0,
  "model": {
    "firstName": "",
    "lastName": "",
    "birthDate": "",
    "relationship": "",
    "dependentOf": ""
  }
}, context)

Input

  • input object
    • demographicId required integer: The ID of the Demographic information used to identify which Dependent to update
    • id required integer: The existing Dependent ID used to identify which Dependent to update
    • model required DemographicsDependentModel

Output

Demographics_GetById

Description: This operation retrieves Demographic information for the specified Demographic information ID. Purpose: Provides access to the Demographic information including city and state.

naviplancentral_factfinder.Demographics_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Demographic information used to retreive the Demographic information

Output

Demographics_PutByIdModel

Description: The operation updates Demographic information. Purpose: Allows for complete replacement of Demographic information on a Fact Finder.

naviplancentral_factfinder.Demographics_PutByIdModel({
  "id": 0,
  "model": {
    "jointAnalysis": true,
    "head1": {
      "firstName": "",
      "lastName": "",
      "birthDate": "",
      "gender": "",
      "taxFilingStatus": 0,
      "alreadyRetired": true
    },
    "factFinderId": 0,
    "city": "",
    "state": 0
  }
}, context)

Input

  • input object
    • id required integer: The existing Demographic information ID used to identify which Demographic information to update
    • model required DemographicsModel

Output

DisabilityInsurancePolicies_GetDisabilityInsurancePoliciesByFactFinderIdByFactfinderid

Description: This operation retrieves all Disability Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Disability Insurance Policies including description and policy type.

naviplancentral_factfinder.DisabilityInsurancePolicies_GetDisabilityInsurancePoliciesByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Disability Insurance Policies

Output

DisabilityInsurancePolicies_PostByModel

Description: The operation creates a Disability Insurance Policy. Purpose: Allows for creation of Disability Insurance Policies on a Fact Finder.

naviplancentral_factfinder.DisabilityInsurancePolicies_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

DisabilityInsurancePolicies_DeleteById

Description: The operation removes a Disability Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Disability Insurance Policy from a Fact Finder.

naviplancentral_factfinder.DisabilityInsurancePolicies_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Disability Insurance Policy ID used to identify which Disability Insurance Policy to remove

Output

Output schema unknown

DisabilityInsurancePolicies_GetById

Description: This operation retrieves a single Disability Insurance Policy for the specified Disability Insurance Policy ID. Purpose: Provides access to the Disability Insurance Policy including description and policy type.

naviplancentral_factfinder.DisabilityInsurancePolicies_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Disability Insurance Policy used to retreive the Disability Insurance Policy

Output

DisabilityInsurancePolicies_PutByIdModel

Description: The operation updates a Disability Insurance Policy. Purpose: Allows for complete replacement of a Disability Insurance Policy on a Fact Finder.

naviplancentral_factfinder.DisabilityInsurancePolicies_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Disability Insurance Policy ID used to identify which Disability Insurance Policy to update
    • model required DisabilityInsurancePolicyModel

Output

DisabilityInsurancePolicyTypes_GetByCountry

Description: This operation retrieves all Disability Insurance Policy Types for the specified country. Purpose: Provides access to the Disability Insurance Policy Types including id and type description.

naviplancentral_factfinder.DisabilityInsurancePolicyTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Disability Insurance Policy Types

Output

DisabilityInsurancePolicyTypes_GetById

Description: This operation retrieves all Disability Insurance Policy Types for the specified id. Purpose: Provides access to the Disability Insurance Policy Types including id and type description.

naviplancentral_factfinder.DisabilityInsurancePolicyTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Disability Insurance Policy Type used to retreive the Disability Insurance Policy Type information

Output

EducationGoals_GetEducationGoalsByFactFinderIdByFactfinderid

Description: This operation retrieves all Education Goals for the specified Fact Finder ID. Purpose: Provides access to the Education Goals including description and projected cost.

naviplancentral_factfinder.EducationGoals_GetEducationGoalsByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Education Goals

Output

EducationGoals_PostByModel

Description: The operation creates an Education Goal. Purpose: Allows for creation of Education Goals on a Fact Finder.

naviplancentral_factfinder.EducationGoals_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

EducationGoals_GetEducationExpensesByEducationGoalIdByEducationgoalid

Description: This operation retrieves all Education Goal Expenses for the specified Education Goal ID. Purpose: Provides access to the Education Goal Expenses including description and annual cost.

naviplancentral_factfinder.EducationGoals_GetEducationExpensesByEducationGoalIdByEducationgoalid({
  "educationGoalId": 0
}, context)

Input

  • input object
    • educationGoalId required integer: The ID of the Education Goal used to retrieve Education Goal Expenses

Output

EducationGoals_PostByEducationgoalidModel

Description: The operation creates an Education Goal Expense. Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.

naviplancentral_factfinder.EducationGoals_PostByEducationgoalidModel({
  "educationGoalId": 0,
  "model": {}
}, context)

Input

  • input object
    • educationGoalId required integer: The Education Goal ID used to locate the Goal to add the expense to
    • model required EducationExpenseModel

Output

EducationGoals_DeleteByEducationgoalidId

Description: The operation removes an Education Goal Expense tied to a Fact Finder. Purpose: Allows for removal of an Education Goal Expense from a Fact Finder.

naviplancentral_factfinder.EducationGoals_DeleteByEducationgoalidId({
  "educationGoalId": 0,
  "id": 0
}, context)

Input

  • input object
    • educationGoalId required integer: The Education Goal ID used to locate the Goal to delete the Expense under
    • id required integer: The Education Goal Expense ID used to identify which Education Goal Expense to remove

Output

Output schema unknown

EducationGoals_GetEducationExpenseByEducationgoalidId

Description: This operation retrieves a single Education Goal Expense for the specified Education Goal Expense ID. Purpose: Provides access to the Education Goal Expense including description and annual cost.

naviplancentral_factfinder.EducationGoals_GetEducationExpenseByEducationgoalidId({
  "educationGoalId": 0,
  "id": 0
}, context)

Input

  • input object
    • educationGoalId required integer: The ID of the Education Goal used to retrieve Education Goal Expenses
    • id required integer: The ID of the Education Goal Expense used to retreive the Education Goal Expense

Output

EducationGoals_PutByEducationgoalidIdModel

Description: The operation updates an Education Goal Expense. Purpose: Allows for complete replacement of an Education Goal Expense on a Fact Finder.

naviplancentral_factfinder.EducationGoals_PutByEducationgoalidIdModel({
  "educationGoalId": 0,
  "id": 0,
  "model": {}
}, context)

Input

  • input object
    • educationGoalId required integer: The Education Goal ID used to locate the Goal to update the Expense under
    • id required integer: The existing Education Goal Expense ID used to identify which Education Goal Expense to update
    • model required EducationExpenseModel

Output

EducationGoals_DeleteById

Description: The operation removes an Education Goal tied to a Fact Finder. Purpose: Allows for removal of an Education Goal from a Fact Finder.

naviplancentral_factfinder.EducationGoals_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Education Goal ID used to identify which Education Goal to remove

Output

Output schema unknown

EducationGoals_GetById

Description: This operation retrieves a single Education Goal for the specified Education Goal ID. Purpose: Provides access to the Education Goal including description and projected cost.

naviplancentral_factfinder.EducationGoals_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Education Goal used to retreive the Education Goal

Output

EducationGoals_PutByIdModel

Description: The operation creates an Education Goal Expense. Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.

naviplancentral_factfinder.EducationGoals_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The Education Goal ID used to locate the Goal to add the Expense to
    • model required EducationGoalModel

Output

ExpenseTypes_GetByCountry

Description: This operation retrieves all Expense Types for the specified country. Purpose: Provides access to the Expense Types including id and type description.

naviplancentral_factfinder.ExpenseTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Expense Types

Output

ExpenseTypes_GetById

Description: This operation retrieves all Expense Types for the specified country. Purpose: Provides access to the Expense Types including id and type description.

naviplancentral_factfinder.ExpenseTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Expense Type used to retreive the Expense Type information

Output

Expenses_GetExpensesByFactFinderIdByFactfinderid

Description: This operation retrieves all Expenses for the specified Fact Finder ID. Purpose: Provides access to the Expenses including description and Expense type.

naviplancentral_factfinder.Expenses_GetExpensesByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Expenses

Output

Expenses_PostByModel

Description: The operation creates an Expense. Purpose: Allows for creation of Expenses on a Fact Finder.

naviplancentral_factfinder.Expenses_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

Expenses_DeleteById

Description: The operation removes an Expense tied to a Fact Finder. Purpose: Allows for removal of an Expense from a Fact Finder.

naviplancentral_factfinder.Expenses_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Expense ID used to identify which Expense to remove

Output

Output schema unknown

Expenses_GetById

Description: This operation retrieves a single Expense for the specified Expense ID. Purpose: Provides access to the Expense including description and Expense type.

naviplancentral_factfinder.Expenses_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Expense used to retreive the Expense

Output

Expenses_PutByIdModel

Description: The operation updates an Expense. Purpose: Allows for complete replacement of an Expense on a Fact Finder. Note: Expense type cannot be changed for expenses prepopulated from NaviPlan.

naviplancentral_factfinder.Expenses_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Expense ID used to identify which Expense to update
    • model required ExpenseModel

Output

FactFinders_GetByHouseholdIdByHouseholdid

Description: This operation retrieves all Fact Finders for the specified householdId, or if null, all households associated with the user. Purpose: Provides access to the Fact Finder including status.

naviplancentral_factfinder.FactFinders_GetByHouseholdIdByHouseholdid({}, context)

Input

  • input object
    • householdId integer: The ID of the household used to retrieve the fact finders. If not set, uses all households associated with the user

Output

FactFinders_PostByModel

Description: The operation creates a completely empty draft Fact Finder. Requirements: A householdId and list of modules must be provided. Purpose: Stages a Fact Finder for population.

naviplancentral_factfinder.FactFinders_PostByModel({
  "model": {
    "householdId": 0
  }
}, context)

Input

Output

FactFinders_PostPopulateByModel

Description: The operation creates a new Populated Fact Finder. Requirements: A householdId and list of modules must be provided. Purpose: Creation of a Fact Finder.

naviplancentral_factfinder.FactFinders_PostPopulateByModel({
  "model": {
    "householdId": 0
  }
}, context)

Input

Output

FactFinderModules_GetByFactfinderid

Description: This operation retrieves all Fact Finder Modules for the specified Fact Finder ID. Purpose: Provides access to the Fact Finder Modules including description and policy type.

naviplancentral_factfinder.FactFinderModules_GetByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Fact Finder Modules

Output

FactFinderModules_GetByFactfinderidId

Description: This operation retrieves a single Fact Finder Module for the specified Fact Finder Module ID. Purpose: Provides access to the Fact Finder Module including description and policy type.

naviplancentral_factfinder.FactFinderModules_GetByFactfinderidId({
  "factFinderId": 0,
  "id": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Fact Finder Module
    • id required integer: The ID of the Fact Finder Module used to retreive the Fact Finder Module

Output

FactFinderModules_PutByModelFactfinderidId

Description: The operation updates a Fact Finder Module. Purpose: Allows for complete replacement of a Fact Finder Module on a Fact Finder.

naviplancentral_factfinder.FactFinderModules_PutByModelFactfinderidId({
  "model": {
    "moduleName": ""
  },
  "factFinderId": 0,
  "id": 0
}, context)

Input

  • input object
    • model required FactFinderModuleModel
    • factFinderId required integer: The ID of the Fact Finder used to identify the Fact Finder Module to update
    • id required integer: The existing Fact Finder Module ID used to identify which Fact Finder Module to update

Output

FactFinders_GetSnapshotsByFactfinderid

Description: The operation retrieves Snapshots of a Fact Finder. Purpose: Allows for advisors to view all Snapshots taken of a Fact Finder.

naviplancentral_factfinder.FactFinders_GetSnapshotsByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder to retrieve Snapshots for

Output

FactFinders_PostSnapshotsByFactfinderid

Description: The operation creates a Snapshot of a Fact Finder. Purpose: Allows for advisors to compare the current fact finder to a snapshot prior to acceptance.

naviplancentral_factfinder.FactFinders_PostSnapshotsByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to create the Fact Finder Snapshot

Output

FactFinders_DeleteById

Description: This operation deletes a single Fact Finder for the specified Fact Finder ID. Purpose: Deletes the fact finder.

naviplancentral_factfinder.FactFinders_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Fact Finder to be deleted

Output

FactFinders_GetById

Description: This operation retrieves a single Fact Finder for the specified Fact Finder ID. Purpose: Provides access to the Fact Finder including status.

naviplancentral_factfinder.FactFinders_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Fact Finder used to retrieve the Fact Finder

Output

FactFinders_PutByIdModel

Description: The operation updates a Fact Finder. Purpose: Allows for the updating of a Fact Finder.

naviplancentral_factfinder.FactFinders_PutByIdModel({
  "id": 0,
  "model": {}
}, context)

Input

  • input object
    • id required integer: The existing Fact Finder ID used to identify which Fact Finder to update
    • model required FactFinderModel

Output

FactFinders_PutPopulateFactFinderByIdModel

Description: The operation populates a fact finder. Purpose: Allows for the population of a Fact Finder based on a NaviPlan plan or client. This operation cannot be performed on a Fact Finder more than once.

naviplancentral_factfinder.FactFinders_PutPopulateFactFinderByIdModel({
  "id": 0,
  "model": {}
}, context)

Input

  • input object
    • id required integer: The existing Fact Finder ID used to identify which Fact Finder to populate.
    • model required FactFinderPopulationModel

Output

FilingStatusTypes_GetByCountry

Description: This operation retrieves all Filing Status Types for the specified country. Purpose: Provides access to the Filing Status Types including id and type description.

naviplancentral_factfinder.FilingStatusTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Filing Status Types

Output

FilingStatusTypes_GetById

Description: This operation retrieves all Filing Status Type for the specified id. Purpose: Provides access to the Filing Status Types including id and type description.

naviplancentral_factfinder.FilingStatusTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Filing Status Type used to retreive the Filing Status Type information

Output

FrequencyTypes_GetByEntityCountry

Description: This operation retrieves all Frequency Types for the specified country and entity. Purpose: Provides access to the Frequency Types including id and type description.

naviplancentral_factfinder.FrequencyTypes_GetByEntityCountry({
  "entity": "",
  "country": ""
}, context)

Input

  • input object
    • entity required string (values: CriticalIllnessInsurancePolicies, DisabilityInsurancePoliciesPremium, DisabilityInsurancePoliciesBenefit, Expenses, Liabilities, LifeInsurancePolicies, LongTermCareInsurancePoliciesBenefit, LongTermCareInsurancePoliciesPremium, RealEstateAssets, RetirementExpenses, SavingsStrategies): The entity used to filter Frequency Types
    • country required string (values: UnitedStates, Canada): The country used to filter Frequency Types

Output

FrequencyTypes_GetById

Description: This operation retrieves the Frequency Type for the specified id. Purpose: Provides access to the Frequency Types including id and type description.

naviplancentral_factfinder.FrequencyTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Frequency Type used to retreive the Frequency Type information

Output

IncomeTypes_GetByCountry

Description: This operation retrieves all Income Types for the specified country. Purpose: Provides access to the Income Types including id and type description.

naviplancentral_factfinder.IncomeTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Income Types

Output

IncomeTypes_GetById

Description: This operation retrieves the Income Type for the specified id. Purpose: Provides access to the Income Types including id and type description.

naviplancentral_factfinder.IncomeTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Income Type used to retreive the Income Type information

Output

Incomes_GetIncomesByFactFinderIdByFactfinderid

Description: This operation retrieves all Incomes for the specified Fact Finder ID. Purpose: Provides access to the Incomes including annual amount and start date.

naviplancentral_factfinder.Incomes_GetIncomesByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Incomes

Output

Incomes_PostByModel

Description: The operation creates an Income. Purpose: Allows for creation of Incomes on a Fact Finder.

naviplancentral_factfinder.Incomes_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

Incomes_DeleteById

Description: The operation removes an Income tied to a Fact Finder. Purpose: Allows for removal of an Income from a Fact Finder.

naviplancentral_factfinder.Incomes_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Income ID used to identify which Income to remove

Output

Output schema unknown

Incomes_GetById

Description: This operation retrieves a single Income for the specified Income ID. Purpose: Provides access to the Income including annual amount and start date.

naviplancentral_factfinder.Incomes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Income used to retreive the Income

Output

Incomes_PutByIdModel

Description: The operation updates an Income. Purpose: Allows for complete replacement of an Income on a Fact Finder.

naviplancentral_factfinder.Incomes_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Income ID used to identify which Income to update
    • model required IncomeModel

Output

Liabilities_GetLiabilitiesByFactFinderIdByFactfinderidExternalsourceid

Description: This operation retrieves all Liabilities for the specified Fact Finder ID. Purpose: Provides access to the Liabilities including owner and type.

naviplancentral_factfinder.Liabilities_GetLiabilitiesByFactFinderIdByFactfinderidExternalsourceid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Liabilities
    • externalSourceId string: The external source ID used to filter Liabilities

Output

Liabilities_PostByModel

Description: The operation creates a Liability. Purpose: Allows for creation of Liabilities on a Fact Finder.

naviplancentral_factfinder.Liabilities_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

Liabilities_DeleteById

Description: The operation removes a Liability tied to a Fact Finder. Purpose: Allows for removal of a Liability from a Fact Finder.

naviplancentral_factfinder.Liabilities_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Liability ID used to identify which Liability to remove

Output

Output schema unknown

Liabilities_GetById

Description: This operation retrieves a single Liability for the specified Liability ID. Purpose: Provides access to the Liability including owner and type.

naviplancentral_factfinder.Liabilities_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Liability used to retreive the Liability

Output

Liabilities_PutByIdModel

Description: The operation updates a Liability. Purpose: Allows for complete replacement of a Liability on a Fact Finder.

naviplancentral_factfinder.Liabilities_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Liability ID used to identify which Liability to update
    • model required LiabilityModel

Output

LiabilityTypes_GetByCountry

Description: This operation retrieves all Liability Types for the specified country. Purpose: Provides access to the Liability Types including id and type description.

naviplancentral_factfinder.LiabilityTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Liability Types

Output

LiabilityTypes_GetById

Description: This operation retrieves the Liability Type for the specified id. Purpose: Provides access to the Liability Types including id and type description.

naviplancentral_factfinder.LiabilityTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Liability Type used to retreive the Liability Type information

Output

LifeInsurancePolicies_GetLifeInsurancePoliciesByFactFinderIdByFactfinderid

Description: This operation retrieves all Life Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Life Insurance Policies including description and policy type.

naviplancentral_factfinder.LifeInsurancePolicies_GetLifeInsurancePoliciesByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Life Insurance Policies

Output

LifeInsurancePolicies_PostByModel

Description: The operation creates a Life Insurance Policy. Purpose: Allows for creation of Life Insurance Policies on a Fact Finder.

naviplancentral_factfinder.LifeInsurancePolicies_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

LifeInsurancePolicies_DeleteById

Description: The operation removes a Life Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Life Insurance Policy and associated subaccounts from a Fact Finder.

naviplancentral_factfinder.LifeInsurancePolicies_DeleteById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The Life Insurance Policy ID used to identify which Life Insurance Policy to remove

Output

Output schema unknown

LifeInsurancePolicies_GetById

Description: This operation retrieves a single Life Insurance Policy for the specified Life Insurance Policy ID. Purpose: Provides access to the Life Insurance Policy including description and policy type.

naviplancentral_factfinder.LifeInsurancePolicies_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of the Life Insurance Policy used to retreive the Life Insurance Policy

Output

LifeInsurancePolicies_PutByIdModel

Description: The operation updates a Life Insurance Policy, deletes associated sub-accounts if the policy type changes. Purpose: Allows for complete replacement of a Life Insurance Policy on a Fact Finder.

naviplancentral_factfinder.LifeInsurancePolicies_PutByIdModel({
  "id": 0,
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

  • input object
    • id required integer: The existing Life Insurance Policy ID used to identify which Life Insurance Policy to update
    • model required LifeInsurancePolicyModel

Output

LifeInsurancePolicies_GetSubaccountsByLifeinsurancepolicyid

Description: Get all the subaccounts for an existing Life Insurance Policy. Purpose: Provides access to all the Life Insurance Policy subaccounts.

naviplancentral_factfinder.LifeInsurancePolicies_GetSubaccountsByLifeinsurancepolicyid({
  "lifeInsurancePolicyId": 0
}, context)

Input

  • input object
    • lifeInsurancePolicyId required integer: The ID of the Life Insurance Policy used to retrieve the Life Insurance Policy Subaccounts.

Output

LifeInsurancePolicies_PostSubaccountByLifeinsurancepolicyidModel

Description: Creates a subaccount and adds it to an existing Life Insurance Policy. Purpose: Allows for creation of subaccount on a Life Insurance Policy.

naviplancentral_factfinder.LifeInsurancePolicies_PostSubaccountByLifeinsurancepolicyidModel({
  "lifeInsurancePolicyId": 0,
  "model": {
    "description": ""
  }
}, context)

Input

  • input object
    • lifeInsurancePolicyId required integer: The ID of the Life Insurance Policy used to create the Life Insurance Policy Subaccount.
    • model required LifeInsurancePolicySubaccountModel

Output

LifeInsurancePolicies_DeleteSubaccountByLifeinsurancepolicyidId

Description: Deletes an existing Life Insurance Policy Subaccount for an existing Life Insurance Policy. Purpose: Allows for removal of a subaccount from a Life Insurance Policy.

naviplancentral_factfinder.LifeInsurancePolicies_DeleteSubaccountByLifeinsurancepolicyidId({
  "lifeInsurancePolicyId": 0,
  "id": 0
}, context)

Input

  • input object
    • lifeInsurancePolicyId required integer: The ID of the Life Insurance Policy used to delete the Life Insurance Policy Subaccount.
    • id required integer: The ID of the Life Insurance Policy Subaccount.

Output

Output schema unknown

LifeInsurancePolicies_GetSubaccountByLifeinsurancepolicyidId

Description: Get a specific subaccount for an existing Life Insurance Policy. Purpose: Provides access to the Life Insurance Policy subaccount.

naviplancentral_factfinder.LifeInsurancePolicies_GetSubaccountByLifeinsurancepolicyidId({
  "lifeInsurancePolicyId": 0,
  "id": 0
}, context)

Input

  • input object
    • lifeInsurancePolicyId required integer: The ID of the Life Insurance Policy used to retrieve the Life Insurance Policy Subaccount.
    • id required integer: The ID of the Life Insurance Policy Subaccount.

Output

LifeInsurancePolicies_PutSubaccountByLifeinsurancepolicyidIdModel

Description: Updates an existing Life Insurance Policy Subaccount for an existing Life Insurance Policy. Purpose: Allows for complete replacement of a subaccount on a Life Insurance Policy.

naviplancentral_factfinder.LifeInsurancePolicies_PutSubaccountByLifeinsurancepolicyidIdModel({
  "lifeInsurancePolicyId": 0,
  "id": 0,
  "model": {
    "description": ""
  }
}, context)

Input

  • input object
    • lifeInsurancePolicyId required integer: The ID of the Life Insurance Policy used to update the Life Insurance Policy Subaccount.
    • id required integer: The ID of the Life Insurance Policy Subaccount.
    • model required LifeInsurancePolicySubaccountModel

Output

LifeInsurancePolicyTypes_GetByCountry

Description: This operation retrieves all Life Insurance Policy Types for the specified country. Purpose: Provides access to the Life Insurance Policy Types including id and type description.

naviplancentral_factfinder.LifeInsurancePolicyTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Life Insurance Policy Types

Output

LifeInsurancePolicyTypes_GetById

Description: This operation retrieves the Life Insurance Policy Type for the specified id. Purpose: Provides access to the Life Insurance Policy Types including id and type description.

naviplancentral_factfinder.LifeInsurancePolicyTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Life Insurance Policy Type used to retreive the Life Insurance Policy Type information

Output

LifestyleAssetTypes_GetByCountry

Description: This operation retrieves all Lifestyle Asset Types for the specified country. Purpose: Provides access to the Lifestyle Asset Types including id and type description.

naviplancentral_factfinder.LifestyleAssetTypes_GetByCountry({
  "country": ""
}, context)

Input

  • input object
    • country required string (values: UnitedStates, Canada): The country used to filter Lifestyle Asset Types

Output

LifestyleAssetTypes_GetById

Description: This operation retrieves the Lifestyle Asset Type for the specified id. Purpose: Provides access to the Lifestyle Asset Types including id and type description.

naviplancentral_factfinder.LifestyleAssetTypes_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The ID of Lifestyle Asset Type used to retreive the Lifestyle Asset Type information

Output

LifestyleAssets_GetLifestyleAssetsByFactFinderIdByFactfinderid

Description: This operation retrieves all Lifestyle Assets for the specified Fact Finder ID. Purpose: Provides access to the Lifestyle Assets including description and market value.

naviplancentral_factfinder.LifestyleAssets_GetLifestyleAssetsByFactFinderIdByFactfinderid({
  "factFinderId": 0
}, context)

Input

  • input object
    • factFinderId required integer: The ID of the Fact Finder used to retrieve Lifestyle Assets

Output

LifestyleAssets_PostByModel

Description: The operation creates a Lifestyle Asset. Purpose: Allows for creation of Lifestyle Assets on a Fact Finder.

naviplancentral_factfinder.LifestyleAssets_PostByModel({
  "model": {
    "factFinderId": 0,
    "description": ""
  }
}, context)

Input

Output

datafire
@everything-registry/sub-chunk-222@infinitebrahmanuniverse/nolb-_datafire_n@zalastax/nolb-_datafire_n
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago

2.0.0

8 years ago