Contents

  1. Support
  2. API Overview
  3. Endpoint Documentation

Developers Getting Started Guide for the OrionApi

Support

Orion is committed to providing quick response to questions.  Please post questions. Use the button below to submit a question.

You are looking to build an integration with the Orion Platform.  Well, you have made an excellent choice.  You have the back-end of the premier portfolio accounting system at your http fingertips!  To make sure we get started on the right step, here are the getting started best practices.

Welcome to the Developers Portal.  To get the full api and integration documentation, you must have api credentials.  If you do not yet have api credentials, please reach out to your technical contact at Orion for assistance.

  1. Introductory call.  Please reach out to our SME-Integrations team to schedule a call, SME-Integrations@orion.com.  The agenda should somewhat follow the following.
    1. Welcome and Team Introductions.
    2. Paperwork.  Lets make sure we have the appropriate NDA on file.
    3. Lets discuss your integration.  We want to know what you want to accomplish, and the workflows you see necessary to get there.  This starts with you leading the conversation, but can also be brainstorming between both teams if it is necessary to flush more details.
    4. Authentication.  This is always the first step in an integration.  There are many options for authentication our 2 systems.  We should discuss our options, and choose the best one.
    5. Orion’s Recommendation.  Now we know what you want to accomplish.  We will provide you with links to specific documentation for just what you need.  This will save you a lot of time of reading through pages of documentation.
    6. On going support.  We have different types of support, so let’s just set expectations on how we will work together.  This can be using Email, or Phone calls.

For full API documentation and help guides login here.

Sumbit a question

API Overview

The OrionApi is a fully functional api for the Orion Portfolio Accounting System.  The API provides functionality for:

Portfolio

Retrieve, Update, and Create Portfolio records, and associated data.  This includes Households, Registrations, Financial Account Records, Assets, transactions as well as Documents, Notes, Suitability, and all the other related portfolio information.

Trading

Retrieve, Update, and Create Models, assign models to accounts. Use this domain to generate trades using all the Orion trading applications such as rebalance, trade to target percent, quick trade, excel uploads, global ticker swap and more. The trade orders can be retrieved, and submitted through custodial files, or real time FIX trade connections.

Billing

Retrieve, Update, and Create Billing information such as Fee schedules, payout schedules, adjustments, account billing instructions, related billing households.  Also get generated bill information such as Receivables, payables, and invoices.

Reporting

Ability to run Orion’s standard reports, as well as reports that have been created using Report Builder.  These reports can be run to PDF, and downloaded, saved to Orions report inbox, or saved to Cloud Storage such as DropBox, and BOX.NET.  Report data can also be queried such as tax cost basis, performance, Values, and Activity.

Orion Connect

Orion Connect allows a calling application to launch the Orion UI.  For example, if you want to launch the Orion Household Overview for a specific household from your own application, this can be done by using the Api Token.  You can also embed Orion Connect UI components within iFrames in web applications.

Test Orion Credentials

Orion credentials are required for accessing the Orion API.  These credentials are available upon request.  Please contact us to request access.

BASE API Endpoints

Base api endpoint is the base url required to make all api calls.  These base urls is what should be stored in a configuration file or table so they can be easily changed between test and production environments, or if a new version of the api is deployed (v2).

Test:

https://testapi.orionadvisor.com/api/v1

Production:

https://api.orionadvisor.com/api/v1

This is an example of launching the Orion Connect Household Overview page in a browser.

Code:


string url = OrionApi.OrionConnectLinks.HouseholdOverview( Entity.Client, clientId );
 
Process.Start(url);

This is an example for creating a new client (household) record.

Code:


// fill out the client verbose properties, and save changes.
_clientVerbose.portfolio.representativeId = (int)cboRep.SelectedValue;
_clientVerbose.portfolio.firstName = txtCientFName.Text;
_clientVerbose.portfolio.lastName = txtClientLName.Text;
_clientVerbose.portfolio.name = txtClientFullName.Text;
 
_clientVerbose.portfolio.address1 = txtClientAddr1.Text;
_clientVerbose.portfolio.address2 = txtClientAddr2.Text;
_clientVerbose.portfolio.city = txtClientCity.Text;
_clientVerbose.portfolio.state = txtClientState.Text;
_clientVerbose.portfolio.zip = txtClientZip.Text;
 
_clientVerbose = OrionApi.Portfolio.ClientSave( _clientVerbose );