Development Guides

Orion Planning – Net Worth

Purpose: Net Worth data can be retrieved from Orion’s API for Orion Planning, including assets and liabilities which are linked from Orion Connect or from aggregation (Plaid).

Simple Use Case: Firms plans to pull the individual assets and liabilities from a household’s plan to create a customized balance sheet report.

Scope and Outputs: The Net Worth endpoint will only return data for Clients who have been set up in Orion planning and have assets or liabilities associated to the plan either because they have been entered by the client manually, linked via account aggregation (Plaid), or linked to accounts from Orion Connect.

The output does not include a summary for the net worth but all details needed to create a summary are present.

Here is the expected response:

{
    “id”: “”, This is the unique ID for the record
    "assetOrLiability": 0, 0 = Asset, 1 = Liability
    "typeGroup": "", Group Type selected
    "type": "", Type description
    "description": "", Description for record
    "owner": "", Owner from plan
    "balance": 0, Balance of record
    "positions": null,
    "assetAllocations": null,
    "goals": null,
    "hypotheticalReturn": null,
    "isAggregated": false, If true, this record comes through aggregation (Plaid)
    "isOrion": false If true, this record is synced from Orion Connect
  },

Process Overview:

  1. Authenticate to Orion Connect API
  2. GET call to Net Worth Endpoint

Process Steps:

  1. While Orion Planning does use its own independent API for some features, the Orion Connect API provides all of the key data points supported. Therefore, authenticating to the Orion Connect platform is all that is needed to call the Orion Planning endpoints.
  2. Perform a GET call to the Net Worth endpoint: /v1/Integrations/Advizr/NetWorth/{clientId}