Views:

You can use the Lusid.* providers supplied by FINBOURNE to interact with investment data stored in LUSID itself.

Providing you have suitable access control permissions, you can:

  • Retrieve entities such as portfolios, instruments and transactions from LUSID—and optionally also properties decorated onto those entities—for analysis.
  • Calculate holdings, valuations and performance returns on demand. You can also access system information such as logs, scopes and property types.
  • Write certain types of investment data back into LUSID. You must construct a valid table of data in your Luminesce query and use a special toWrite parameter on the provider to actually write data to LUSID. The query returns a table indicating whether each record has been successfully upserted or not.

Instruments

See a list of all the supported instrument types. Not all have read/write providers yet.

To interact with...Read using the ... providerWrite using the ... provider
Instruments of any type (basic definition, not full economic)Lusid.InstrumentLusid.Instrument.Writer
BondsLusid.Instrument.BondLusid.Instrument.Bond.Writer
Complex bondsLusid.Instrument.ComplexBondLusid.Instrument.ComplexBond.Writer
Inflation-linked bondsLusid.Instrument.InflationLinkedBondLusid.Instrument.InflationLinkedBond.Writer
Amortising loansLusid.Instrument.SimpleCashFlowLoanLusid.Instrument.SimpleCashFlowLoan.Writer
CapFloorsLusid.Instrument.CapFloorLusid.Instrument.CapFloor.Writer
CFDsLusid.Instrument.ContractForDifferenceLusid.Instrument.ContractForDifference.Writer
CDSsLusid.Instrument.CreditDefaultSwapLusid.Instrument.CreditDefaultSwap.Writer
EquitiesLusid.Instrument.EquityLusid.Instrument.Equity.Writer
Equity optionsLusid.Instrument.EquityOptionLusid.Instrument.EquityOption.Writer
Equity swapsLusid.Instrument.EquitySwapLusid.Instrument.EquitySwap.Writer
Exchange-traded optionsLusid.Instrument.ExchangeTradedOptionLusid.Instrument.ExchangeTradedOption.Writer
Forward rate agreementsLusid.Instrument.ForwardRateAgreementLusid.Instrument.ForwardRateAgreement.Writer
Funding legsLusid.Instrument.FundingLegLusid.Instrument.FundingLeg.Writer
Fund share classesLusid.Instrument.FundShareClassLusid.Instrument.FundShareClass.Writer
FuturesLusid.Instrument.FutureLusid.Instrument.Future.Writer
FX forwardsLusid.Instrument.FxForwardLusid.Instrument.FxForward.Writer
FX optionsLusid.Instrument.FxOptionLusid.Instrument.FxOption.Writer
FX swapsLusid.Instrument.FxSwapLusid.Instrument.FxSwap.Writer
Interest rate swapsLusid.Instrument.InterestRateSwapLusid.Instrument.InterestRateSwap.Writer
Interest rate swaptionsLusid.Instrument.InterestRateSwaptionLusid.Instrument.InterestRateSwaption.Writer 
ReposLusid.Instrument.RepoLusid.Instrument.Repo.Writer
Term depositsLusid.Instrument.TermDepositLusid.Instrument.TermDeposit.Writer
Simple instruments (no full economic definition)Lusid.Instrument.SimpleInstrumentLusid.Instrument.SimpleInstrument.Writer

Portfolios

To interact with...Read using the ... providerWrite using the ... provider
Portfolios of any kindLusid.PortfolioLusid.Portfolio.Writer
Input transactions added to a transaction portfolioLusid.Portfolio.TxnLusid.Portfolio.Txn.Writer
Instrument resolution for transactions and holdings Lusid.Portfolio.ResolveInstrument
Output transactionsLusid.Portfolio.Txn.Output 
Constituents in a reference portfolioLusid.Portfolio.ConstituentLusid.Portfolio.Constituent.Writer
Holdings in a transaction portfolioLusid.Portfolio.HoldingLusid.Portfolio.Holding.Writer
All the portfolios in a portfolio groupLusid.PortfolioGroupLusid.PortfolioGroup.Writer
Performance returns for portfoliosLusid.Portfolio.ReturnLusid.Portfolio.Return.Writer
Aggregated performance returnsLusid.Portfolio.AggregatedReturn 
Change historyLusid.Portfolio.Change 

Corporate actions

To interact with...Read using the ... providerWrite using the ... provider
Corporate actionsLusid.CorporateActionLusid.CorporateAction.Writer
Corporate action sourcesLusid.CorporateAction.SourceLusid.CorporateAction.Source.Writer

Market data

To interact with...Read using the ... providerWrite using the ... provider
Prices and spot rates in the LUSID Quote StoreLusid.Instrument.QuoteLusid.Instrument.Quote.Writer

Valuation and reconciliation

To interact with...Read using the ... providerWrite using the ... provider
Valuation reportsLusid.Portfolio.Valuation 
A2B reports (PnL)Lusid.Portfolio.AtoB 
Bucketed cash flowsLusid.Portfolio.BucketedCashFlow 
Cash laddersLusid.Portfolio.CashLadder 
RecipesLusid.Valuation.Recipe 
Metrics/queryable keysLusid.Portfolio.Valuation.Measure 
ManifestsLusid.Logs.Valuations.Manifest 
Holding or valuation reconciliationsLusid.Portfolio.Reconciliation.Generic 

Financial reports/fund accounting

To interact with...Read using the ... providerWrite using the ... provider
FundsLusid.FundLusid.Fund.Writer
Fund valuation pointsLusid.Fund.ValuationPointLusid.Fund.ValuationPoint.Writer
Fee typesLusid.FeeTypeLusid.FeeType.Writer
Fees for fundsLusid.Fund.FeeLusid.Fund.Fee.Writer
ABORs (Accounting book of records)Lusid.AborLusid.Abor.Writer
Accounting diaries in ABORsLusid.AccountingDiaryLusid.AccountingDiary.Writer
ABOR configuration modulesLusid.AborConfigurationLusid.AborConfiguration.Writer
Charts of accounts (CoAs)Lusid.ChartOfAccountsLusid.ChartOfAccounts.Writer
General ledger accounts in CoAsLusid.ChartOfAccounts.AccountLusid.ChartOfAccounts.Account.Writer
Posting modules in CoAsLusid.PostingModuleLusid.PostingModule.Writer
Posting rules in posting modulesLusid.PostingModule.RuleLusid.PostingModule.Rule.Writer
Cleardown modules in CoAsLusid.CleardownModuleLusid.CleardownModule.Writer
Cleardown rules in cleardown modulesLusid.CleardownModule.RuleLusid.CleardownModule.Rule.Writer
General ledger profiles in CoAsLusid.GeneralLedgerProfileLusid.GeneralLedgerProfile.Writer
Mappings in general ledger profilesLusid.GeneralLedgerProfile.MappingLusid.GeneralLedgerProfile.Mapping.Writer
Journal entry linesLusid.Abor.JELine 
Trial balancesLusid.Abor.TrialBalance 
Fund valuation point data (GAV and NAV)Lusid.Fund.ValuationPointData 
Fund valuation point fee data (to calculate NAV from GAV)Lusid.Fund.ValuationPointData.Fee 

Properties

You can either use the dedicated property providers below, or alternatively configure the entity providers in the tables above to first 'inline' properties and/or identifiers so you can then interact with them in the same way as entity data fields. Tips for using Luminesce to write properties.

To interact with...Read using the ... providerWrite using the ... provider
Properties on instruments, portfolios, portfolio groups, legal entities and person entitiesLusid.PropertyLusid.Property.Writer
Instrument properties (and market identifiers)Lusid.Instrument.PropertyNot currently available. Use Lusid.Property.Writer instead.
Holding propertiesLusid.Portfolio.Holding.PropertyNot available. Use Lusid.Portfolio.Holding.Writer instead, having inlined properties first.
Transaction propertiesLusid.Portfolio.Txn.PropertyLusid.Portfolio.Txn.Property.Writer
Property types and derived property typesLusid.Property.DefinitionLusid.Property.Definition.Writer
Data typesLusid.DataTypeLusid.DataType.Writer

Scopes, transaction types, cut labels and calendars

To interact with...Read using the ... providerWrite using the ... provider
ScopesLusid.Scope 
Transaction typesLusid.TransactionType 
SidesLusid.TransactionType.SideDefinition 
Cut labelsLusid.CutLabelLusid.CutLabel.Writer
CalendarsLusid.CalendarLusid.Calendar.Writer
Dates in calendarsLusid.Calendar.DateLusid.Calendar.Date.Writer

Order management system (OMS)

To interact with...Read using the ... providerWrite using the ... provider
OrdersLusid.PortfolioOrderLusid.PortfolioOrder.Writer
Order instructionsLusid.OrderInstructionLusid.OrderInstructon.Writer
Order blocksLusid.BlockLusid.Block.Writer
AllocationsLusid.AllocationLusid.Allocation.Writer
ExecutionsLusid.ExecutionLusid.Execution.Writer
PlacementsLusid.PlacementLusid.Placement.Writer
Fee rulesLusid.FeeRuleLusid.FeeRule.Writer

People, legal entities and relationships

To interact with...Read using the ... providerWrite using the ... provider
PersonsLusid.PersonLusid.Person.Writer
Legal entitiesLusid.LegalEntityLusid.LegalEntity.Writer
RelationshipsLusid.RelationshipLusid.Relationship.Writer
Relationship typesLusid.Relationship.DefinitionLusid.Relationship.Definition.Writer

Custom entities

By default, Luminesce knows nothing about your custom entities, so providers for them do not exist out-of-the-box. You must create a read/write provider pair for each type of custom entity you wish to interact with. Find out more about this.

To interact with...Read using the ... providerWrite using the ... provider
Custom entity typesLusid.CustomEntity.DefinitionLusid.CustomEntity.Definition.Writer
Access metadata for custom entitiesLusid.CustomEntity.AccessMetadataLusid.CustomEntity.AccessMetadata.Writer

Structured Result Store data

To interact with...Read using the ... providerWrite using the ... provider
Structured result store dataLusid.UnitResult.StructuredResultLusid.UnitResult.StructuredResult.Writer
Atomised results (virtual documents)Lusid.UnitResult.AtomisedResult 

Logs

To interact with...Read using the ... providerWrite using the ... provider
HTTP 5xx server error responsesLusid.Logs.Error 
HTTP 4xx client error responsesLusid.Logs.Failure 
Requests to any application in the FINBOURNE platformLusid.Logs.AppRequest 
Successful requests to LUSID onlyLusid.Logs.Request 
Request and response contentsLusid.Logs.RequestResponse 
Access requests (policy and license-related failures)Lusid.Logs.Metrics.Entitlement