Purpose: Data produced by the proposal features in Orion’s Advisor Portal (Element) can be reviewed and downloaded through the API. This includes current and previous versions of a proposal.
Simple Use Case: Firm wants to review a list of proposals prepared by an Advisor and then download the current version into an archive database for oversight.
Scope and Outputs: Currently, this requires the integration between Orion Planning and Element as a limitation, as well as requiring the feature to be toggled on. This will return a list of generated proposals from the list endpoint, returning values for ProposalId, Name, NewHouseholdId, Version, and the CreatedDate fields. Using the proposalId and version out of the previous endpoint, you’re able to download the proposal from that point in time.
Process Overview:
- View a list of pregenerated proposals
- Download a proposal from a previous point in time
Process Steps:
- GET an Element Token. This token is unique to the element platform and is different from an Orion Connect and must be acquired to make calls to the Element API.
Example call for Element Token: (NOTE: The credentials must be passed as base 64 encoded values. )
fetch("https://api.orionelement.com/v1/token", {
"headers": {
"accept": "application/json, text/plain, */*",
"accept-language": "en-US,en;q=0.9",
"content-type": "application/x-www-form-urlencoded",
"deviceid": "ZmY0OThiZmMtZGVjOC0zZGE0LWRhNjUtNDUwYjQzN2RkMTFm",
"sec-ch-ua": "\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"91\", \"Chromium\";v=\"91\"",
"sec-ch-ua-mobile": "?0",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "same-site",
"x-auth_type": "2FA"
},
"referrer": "https://dev.orionelement.com/",
"referrerPolicy": "strict-origin-when-cross-origin",
"body": "grant_type=password&username={{base64EncodedUserName}}==&password={{base64EncodedPassword",
"method": "POST",
"mode": "cors",
"credentials": "omit"
})
- GET the entire list of Proposals to choose from.
Example Call To Get All Existing Proposals
fetch("https://api.orionelement.com/v1/Proposals/{{orionPlanningHouseholdId}}/List", {
"headers": {
"accept": "application/json, text/plain, */*",
"accept-language": "en-US,en;q=0.9",
"authorization": "{{elementToken}}",
"sec-ch-ua": "\"Chromium\";v=\"92\", \" Not A;Brand\";v=\"99\", \"Google Chrome\";v=\"92\"",
"sec-ch-ua-mobile": "?0",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "same-site"
},
"referrer": "https://www.orionelement.com/",
"referrerPolicy": "strict-origin-when-cross-origin",
"body": null,
"method": "GET",
"mode": "cors",
"credentials": "include"
});
- GET to retrieve the stored proposal by Orion Planning Household ID.
Example Call To Download An Existing Proposal by the proposal ID from the List Proposal endpoint
fetch("https://api.orionelement.com/v1/Proposals/{{proposalId}}_{{version}}", {
"headers": {
"accept": "application/pdf, */*",
"accept-language": "en-US,en;q=0.9",
"authorization": "{{elementToken}}",
"sec-ch-ua": "\"Chromium\";v=\"92\", \" Not A;Brand\";v=\"99\", \"Google Chrome\";v=\"92\"",
"sec-ch-ua-mobile": "?0",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "same-site"
},
"referrer": "https://www.orionelement.com/",
"referrerPolicy": "strict-origin-when-cross-origin",
"body": null,
"method": "GET",
"mode": "cors",
"credentials": "include"
});
Process Tips or Controls:
- For a first time proposal on a new prospect, if there is enough data to generate a proposal, this process will create that proposal.
- Within the application, an Advisor must complete new account step, fill out account detail and model and have reached “Step – Download Proposal” to generate a proposal.