Purpose: This article will outline how to create a new Representative entity within the Orion system. In Orion Connect the Representatives are the registered advisor that has a book of business within a firm. That book of business in the Orion system are Households. All households in the Orion system must be assigned to a Representative record upon creation.
Simple Use Case: A firm wants to create new Representative records in Orion and link them via custom fields to an Advisor Portal or CRM that they administer.
Scope and Outputs: This will allow you to create data for new representative entities in Orion and provide details on the required items for entity creation.
Process Overview:
- Compose the information for the representative to be created.
- Send the required data to Orion to create the new representative.
Process Steps:
- Use the appropriate GET for the Representative data.
GET /Portfolio/Representatives/Verbose/New
- POST the data back to the appropriate endpoint with the required data included.
POST /Portfolio/Representatives/Verbose
Required information:
– firstName
– lastName
– name (usually just firstname lastname).
– Number (this is the registered representatives registration number)
– BrokerDealerId (this is located in Firm Profile under Broker/Dealers or the list can be pulled here: GET /Portfolio/BrokerDealers)
The following sample payload includes the required fields for reference and would create a Representative named Test Representative.
{
"portfolio":{
"brokerDealerId":3,
"wholesalerId":null,
"payeeId":-1,
"payoutOverride":null,
"riaId":null,
"wholesaler401KId":null,
"planAdministratorId":null,
"custodianId":null,
"createdDate":null,
"copyToRep":false,
"isRIA":false,
"riaName":null,
"royalTCode":null,
"hasADV":false,
"hasU4":false,
"isActive":true,
"isDstDwnld":false,
"branchID":null,
"oldRep_ID":null,
"number":"ABC123",
"impDate":null,
"createdBy":null,
"editedDate":null,
"firstTransactionDate":null,
"editedBy":null,
"startDate":"2021-10-21T05:00:00.000Z",
"repStatus":"Active/No Issues",
"firmName":null,
"actgLedgerNum":null,
"isDefault":false,
"importKey":null,
"raAmount":null,
"raDate":null,
"isRAActive":null,
"repRestrict":null,
"custodianPortalId":null,
"name":"Test Representative",
"salutation":null,
"address1":null,
"address2":null,
"address3":null,
"zip":null,
"homePhone":null,
"homePhoneExt":null,
"fax":null,
"faxExt":null,
"pager":null,
"pagerExt":null,
"mobilePhone":null,
"businessPhone":null,
"businessPhoneExt":null,
"otherPhone":null,
"otherPhoneExt":null,
"reportName":null,
"company":null,
"jobTitle":null,
"ssN_TaxID":null,
"gender":null,
"dob":null,
"webAddress":null,
"lastName":"Representative",
"firstName":"Test",
"id":0,
"city":null,
"state":null,
"email":null,
"repNasds":null,
"repOnHolds":null,
"repStates":[],
"payoutDashNotCompliance":false},
"id":0
}
The response is a fully populated Representative record along with the system generated “Id” for the new record.