Purpose: The basic data for aggregated accounts (Plaid) linked to an Orion financial plan data can be retrieved from Orion’s API.
Simple Use Case: Firm wants to pull outside accounts through the API to analyze clients trends with heldaway cash or investment accounts.
Scope and Outputs: The aggregated account data is available from Orion’s Net Worth endpoint for Clients who have been set up in Orion planning and have outside account linked by the Client.
This endpoint will return all assets and liabilities that make up the net worth. The results will need to be filtered AFTER receiving the response based on “isAggregated”: true
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:
- Authenticate to Orion Connect API
- GET call to Net Worth Endpoint
- Filter response based on “isAggregated”: true
Process Steps:
- 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.
- Perform a GET call to the Net Worth endpoint: /v1/Integrations/Advizr/NetWorth/{clientId}
- Once the records are received, isolate the data set where isAggregated = true.