You can create an investment account entity to link an investor record to one or more portfolios storing investments.
Methods
Data fields and properties
This section supplements the API documentation and on-screen help text in the LUSID web app.
Fields
An investment account must have at least one user-defined property identifier in the identifiers
collection. It can have more than one.
An investment account must have an accountType
of either:
Personal
, in which caseaccountHolders
must identify a single investor record with an underlying investor type ofPerson
.Corporate
, in which caseaccountHolders
must identify a single investor record with an underlying investor type ofLegalEntity
.JointPersonal
, in which caseaccountHolders
can identify multiple investor records providing they all have an underlying investor type ofPerson
.JointCorporate
, in which caseaccountHolders
can identify multiple investor records providing they all have an underlying investor type ofLegalEntity
.JointMixed
, in which caseaccountHolders
should identify at least two investor records, one with an underlying investor type ofPerson
, and one with an underlying investor type ofLegalEntity
. There can be more investor records of either type.
An investment account should reference at least one portfolio in the investmentPortfolios
collection. The key
field enables you to provide a more friendly display name than may be possible amalgamating the portfolioScope
and portfolioCode
. It must be unique with the investment account.
Properties
You can optionally extend the data model of an investment account by adding custom properties from the InvestmentAccount
domain. Soon you should be able to add or remove properties independently using dedicated APIs.
Subsequent updates
Once created, you can call the same UpsertInvestmentAccounts API again to change any attribute. To delete an investment account, call the DeleteInvestmentAccount
API and specify one of its user-defined property identifiers.