LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.ITransactionPortfoliosApiAsync Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.ITransactionPortfoliosApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< AdjustHoldingAdjustHoldingsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string >? reconciliationMethods=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 AdjustHoldings: Adjust holdings More...
 
System.Threading.Tasks.Task< ApiResponse< AdjustHolding > > AdjustHoldingsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string >? reconciliationMethods=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 AdjustHoldings: Adjust holdings More...
 
System.Threading.Tasks.Task< BatchAdjustHoldingsResponseBatchAdjustHoldingsAsync (string scope, string code, string successMode, Dictionary< string, AdjustHoldingForDateRequest > requestBody, List< string >? reconciliationMethods=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] BatchAdjustHoldings: Batch adjust holdings More...
 
System.Threading.Tasks.Task< ApiResponse< BatchAdjustHoldingsResponse > > BatchAdjustHoldingsWithHttpInfoAsync (string scope, string code, string successMode, Dictionary< string, AdjustHoldingForDateRequest > requestBody, List< string >? reconciliationMethods=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] BatchAdjustHoldings: Batch adjust holdings More...
 
System.Threading.Tasks.Task< CreateTradeTicketsResponseBatchCreateTradeTicketsAsync (string scope, string code, List< LusidTradeTicket > lusidTradeTicket, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] BatchCreateTradeTickets: Batch Create Trade Tickets More...
 
System.Threading.Tasks.Task< ApiResponse< CreateTradeTicketsResponse > > BatchCreateTradeTicketsWithHttpInfoAsync (string scope, string code, List< LusidTradeTicket > lusidTradeTicket, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] BatchCreateTradeTickets: Batch Create Trade Tickets More...
 
System.Threading.Tasks.Task< BatchUpsertPortfolioTransactionsResponseBatchUpsertTransactionsAsync (string scope, string code, string successMode, Dictionary< string, TransactionRequest > requestBody, bool? preserveProperties=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] BatchUpsertTransactions: Batch upsert transactions More...
 
System.Threading.Tasks.Task< ApiResponse< BatchUpsertPortfolioTransactionsResponse > > BatchUpsertTransactionsWithHttpInfoAsync (string scope, string code, string successMode, Dictionary< string, TransactionRequest > requestBody, bool? preserveProperties=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] BatchUpsertTransactions: Batch upsert transactions More...
 
System.Threading.Tasks.Task< VersionedResourceListOfOutputTransactionBuildTransactionsAsync (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 BuildTransactions: Build transactions More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfOutputTransaction > > BuildTransactionsWithHttpInfoAsync (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 BuildTransactions: Build transactions More...
 
System.Threading.Tasks.Task< DeletedEntityResponseCancelAdjustHoldingsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CancelAdjustHoldings: Cancel adjust holdings More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > CancelAdjustHoldingsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CancelAdjustHoldings: Cancel adjust holdings More...
 
System.Threading.Tasks.Task< DeletedEntityResponseCancelTransactionsAsync (string scope, string code, List< string > transactionIds, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CancelTransactions: Cancel transactions More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > CancelTransactionsWithHttpInfoAsync (string scope, string code, List< string > transactionIds, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CancelTransactions: Cancel transactions More...
 
System.Threading.Tasks.Task< PortfolioCreatePortfolioAsync (string scope, CreateTransactionPortfolioRequest createTransactionPortfolioRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreatePortfolio: Create portfolio More...
 
System.Threading.Tasks.Task< ApiResponse< Portfolio > > CreatePortfolioWithHttpInfoAsync (string scope, CreateTransactionPortfolioRequest createTransactionPortfolioRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreatePortfolio: Create portfolio More...
 
System.Threading.Tasks.Task< LusidTradeTicketCreateTradeTicketAsync (string scope, string code, LusidTradeTicket? lusidTradeTicket=default(LusidTradeTicket?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateTradeTicket: Create Trade Ticket More...
 
System.Threading.Tasks.Task< ApiResponse< LusidTradeTicket > > CreateTradeTicketWithHttpInfoAsync (string scope, string code, LusidTradeTicket? lusidTradeTicket=default(LusidTradeTicket?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateTradeTicket: Create Trade Ticket More...
 
System.Threading.Tasks.Task< DeleteCustodianAccountsResponseDeleteCustodianAccountsAsync (string scope, string code, List< ResourceId > resourceId, string? deleteMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts More...
 
System.Threading.Tasks.Task< ApiResponse< DeleteCustodianAccountsResponse > > DeleteCustodianAccountsWithHttpInfoAsync (string scope, string code, List< ResourceId > resourceId, string? deleteMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeletePropertiesFromTransactionAsync (string scope, string code, string transactionId, List< string > propertyKeys, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeletePropertiesFromTransaction: Delete properties from transaction More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeletePropertiesFromTransactionWithHttpInfoAsync (string scope, string code, string transactionId, List< string > propertyKeys, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeletePropertiesFromTransaction: Delete properties from transaction More...
 
System.Threading.Tasks.Task< VersionedResourceListOfA2BDataRecordGetA2BDataAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetA2BData: Get A2B data More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfA2BDataRecord > > GetA2BDataWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetA2BData: Get A2B data More...
 
System.Threading.Tasks.Task< VersionedResourceListOfA2BMovementRecordGetA2BMovementsAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetA2BMovements: Get an A2B report at the movement level for the given portfolio. More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfA2BMovementRecord > > GetA2BMovementsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetA2BMovements: Get an A2B report at the movement level for the given portfolio. More...
 
System.Threading.Tasks.Task< BucketedCashFlowResponseGetBucketedCashFlowsAsync (string scope, string code, BucketedCashFlowRequest? bucketedCashFlowRequest=default(BucketedCashFlowRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios More...
 
System.Threading.Tasks.Task< ApiResponse< BucketedCashFlowResponse > > GetBucketedCashFlowsWithHttpInfoAsync (string scope, string code, BucketedCashFlowRequest? bucketedCashFlowRequest=default(BucketedCashFlowRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios More...
 
System.Threading.Tasks.Task< CustodianAccountGetCustodianAccountAsync (string scope, string code, string custodianAccountScope, string custodianAccountCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetCustodianAccount: Get Custodian Account More...
 
System.Threading.Tasks.Task< ApiResponse< CustodianAccount > > GetCustodianAccountWithHttpInfoAsync (string scope, string code, string custodianAccountScope, string custodianAccountCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetCustodianAccount: Get Custodian Account More...
 
System.Threading.Tasks.Task< PortfolioDetailsGetDetailsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetDetails: Get details More...
 
System.Threading.Tasks.Task< ApiResponse< PortfolioDetails > > GetDetailsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetDetails: Get details More...
 
System.Threading.Tasks.Task< VersionedResourceListOfHoldingContributorGetHoldingContributorsAsync (string scope, string code, long holdingId, DateTimeOrCutLabel? effectiveDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? fromTradeDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTradeDate=default(DateTimeOrCutLabel?), bool? includeHistoric=default(bool?), string? taxLotId=default(string?), int? limit=default(int?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetHoldingContributors: Get Holdings Contributors More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfHoldingContributor > > GetHoldingContributorsWithHttpInfoAsync (string scope, string code, long holdingId, DateTimeOrCutLabel? effectiveDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? fromTradeDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTradeDate=default(DateTimeOrCutLabel?), bool? includeHistoric=default(bool?), string? taxLotId=default(string?), int? limit=default(int?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetHoldingContributors: Get Holdings Contributors More...
 
System.Threading.Tasks.Task< VersionedResourceListOfPortfolioHoldingGetHoldingsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetHoldings: Get holdings More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfPortfolioHolding > > GetHoldingsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetHoldings: Get holdings More...
 
System.Threading.Tasks.Task< HoldingsAdjustmentGetHoldingsAdjustmentAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetHoldingsAdjustment: Get holdings adjustment More...
 
System.Threading.Tasks.Task< ApiResponse< HoldingsAdjustment > > GetHoldingsAdjustmentWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetHoldingsAdjustment: Get holdings adjustment More...
 
System.Threading.Tasks.Task< VersionedResourceListWithWarningsOfPortfolioHoldingGetHoldingsWithOrdersAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetHoldingsWithOrders: Get holdings with orders More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListWithWarningsOfPortfolioHolding > > GetHoldingsWithOrdersWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetHoldingsWithOrders: Get holdings with orders More...
 
System.Threading.Tasks.Task< ResourceListOfInstrumentCashFlowGetPortfolioCashFlowsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowStart=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowEnd=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), bool? excludeUnsettledTrades=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [BETA] GetPortfolioCashFlows: Get portfolio cash flows More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfInstrumentCashFlow > > GetPortfolioCashFlowsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowStart=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowEnd=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), bool? excludeUnsettledTrades=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [BETA] GetPortfolioCashFlows: Get portfolio cash flows More...
 
System.Threading.Tasks.Task< ResourceListOfPortfolioCashLadderGetPortfolioCashLadderAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), bool? excludeUnsettledTrades=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPortfolioCashLadder: Get portfolio cash ladder More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfPortfolioCashLadder > > GetPortfolioCashLadderWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), bool? excludeUnsettledTrades=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPortfolioCashLadder: Get portfolio cash ladder More...
 
System.Threading.Tasks.Task< ResourceListOfPortfolioCashFlowGetPortfolioCashStatementAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPortfolioCashStatement: Get portfolio cash statement More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfPortfolioCashFlow > > GetPortfolioCashStatementWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPortfolioCashStatement: Get portfolio cash statement More...
 
System.Threading.Tasks.Task< ResourceListOfChangeHistoryGetTransactionHistoryAsync (string scope, string code, string transactionId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetTransactionHistory: Get the history of a transaction More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfChangeHistory > > GetTransactionHistoryWithHttpInfoAsync (string scope, string code, string transactionId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetTransactionHistory: Get the history of a transaction More...
 
System.Threading.Tasks.Task< VersionedResourceListOfTransactionGetTransactionsAsync (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), string? page=default(string?), int? limit=default(int?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetTransactions: Get transactions More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfTransaction > > GetTransactionsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), string? page=default(string?), int? limit=default(int?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetTransactions: Get transactions More...
 
System.Threading.Tasks.Task< ResourceListOfTransactionGetUpsertablePortfolioCashFlowsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowStart=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowEnd=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), bool? excludeUnsettledTrades=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [BETA] GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows. More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfTransaction > > GetUpsertablePortfolioCashFlowsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowStart=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? windowEnd=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), bool? excludeUnsettledTrades=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [BETA] GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows. More...
 
System.Threading.Tasks.Task< PagedResourceListOfCustodianAccountListCustodianAccountsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListCustodianAccounts: List Custodian Accounts More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCustodianAccount > > ListCustodianAccountsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListCustodianAccounts: List Custodian Accounts More...
 
System.Threading.Tasks.Task< ResourceListOfHoldingsAdjustmentHeaderListHoldingsAdjustmentsAsync (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListHoldingsAdjustments: List holdings adjustments More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfHoldingsAdjustmentHeader > > ListHoldingsAdjustmentsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListHoldingsAdjustments: List holdings adjustments More...
 
System.Threading.Tasks.Task< PortfolioDetailsPatchPortfolioDetailsAsync (string scope, string code, List< Operation > operation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchPortfolioDetails: Patch portfolio details More...
 
System.Threading.Tasks.Task< ApiResponse< PortfolioDetails > > PatchPortfolioDetailsWithHttpInfoAsync (string scope, string code, List< Operation > operation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchPortfolioDetails: Patch portfolio details More...
 
System.Threading.Tasks.Task< UpsertPortfolioTransactionsResponseResolveInstrumentAsync (string scope, string code, string instrumentIdentifierType, string instrumentIdentifierValue, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), bool? reResolve=default(bool?), Dictionary< string, string >? requestBody=default(Dictionary< string, string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ResolveInstrument: Resolve instrument More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertPortfolioTransactionsResponse > > ResolveInstrumentWithHttpInfoAsync (string scope, string code, string instrumentIdentifierType, string instrumentIdentifierValue, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), bool? reResolve=default(bool?), Dictionary< string, string >? requestBody=default(Dictionary< string, string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ResolveInstrument: Resolve instrument More...
 
System.Threading.Tasks.Task< AdjustHoldingSetHoldingsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string >? reconciliationMethods=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 SetHoldings: Set holdings More...
 
System.Threading.Tasks.Task< ApiResponse< AdjustHolding > > SetHoldingsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string >? reconciliationMethods=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 SetHoldings: Set holdings More...
 
System.Threading.Tasks.Task< CustodianAccountsUpsertResponseUpsertCustodianAccountsAsync (string scope, string code, List< CustodianAccountRequest > custodianAccountRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertCustodianAccounts: Upsert Custodian Accounts More...
 
System.Threading.Tasks.Task< ApiResponse< CustodianAccountsUpsertResponse > > UpsertCustodianAccountsWithHttpInfoAsync (string scope, string code, List< CustodianAccountRequest > custodianAccountRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertCustodianAccounts: Upsert Custodian Accounts More...
 
System.Threading.Tasks.Task< CustodianAccountPropertiesUpsertCustodianAccountsPropertiesAsync (string scope, string code, string custodianAccountScope, string custodianAccountCode, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertCustodianAccountsProperties: Upsert custodian accounts properties More...
 
System.Threading.Tasks.Task< ApiResponse< CustodianAccountProperties > > UpsertCustodianAccountsPropertiesWithHttpInfoAsync (string scope, string code, string custodianAccountScope, string custodianAccountCode, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertCustodianAccountsProperties: Upsert custodian accounts properties More...
 
System.Threading.Tasks.Task< PortfolioDetailsUpsertPortfolioDetailsAsync (string scope, string code, CreatePortfolioDetails createPortfolioDetails, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertPortfolioDetails: Upsert portfolio details More...
 
System.Threading.Tasks.Task< ApiResponse< PortfolioDetails > > UpsertPortfolioDetailsWithHttpInfoAsync (string scope, string code, CreatePortfolioDetails createPortfolioDetails, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertPortfolioDetails: Upsert portfolio details More...
 
System.Threading.Tasks.Task< UpsertTransactionPropertiesResponseUpsertTransactionPropertiesAsync (string scope, string code, string transactionId, Dictionary< string, PerpetualProperty > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertTransactionProperties: Upsert transaction properties More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertTransactionPropertiesResponse > > UpsertTransactionPropertiesWithHttpInfoAsync (string scope, string code, string transactionId, Dictionary< string, PerpetualProperty > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertTransactionProperties: Upsert transaction properties More...
 
System.Threading.Tasks.Task< UpsertPortfolioTransactionsResponseUpsertTransactionsAsync (string scope, string code, List< TransactionRequest > transactionRequest, bool? preserveProperties=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertTransactions: Upsert transactions More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertPortfolioTransactionsResponse > > UpsertTransactionsWithHttpInfoAsync (string scope, string code, List< TransactionRequest > transactionRequest, bool? preserveProperties=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertTransactions: Upsert transactions More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ AdjustHoldingsAsync()

System.Threading.Tasks.Task<AdjustHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.AdjustHoldingsAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >?  reconciliationMethods = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

AdjustHoldings: Adjust holdings

Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AdjustHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ AdjustHoldingsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AdjustHolding> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.AdjustHoldingsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >?  reconciliationMethods = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

AdjustHoldings: Adjust holdings

Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AdjustHolding)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BatchAdjustHoldingsAsync()

System.Threading.Tasks.Task<BatchAdjustHoldingsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BatchAdjustHoldingsAsync ( string  scope,
string  code,
string  successMode,
Dictionary< string, AdjustHoldingForDateRequest requestBody,
List< string >?  reconciliationMethods = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] BatchAdjustHoldings: Batch adjust holdings

Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime in each request. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each adjustment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyThe selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of BatchAdjustHoldingsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BatchAdjustHoldingsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<BatchAdjustHoldingsResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BatchAdjustHoldingsWithHttpInfoAsync ( string  scope,
string  code,
string  successMode,
Dictionary< string, AdjustHoldingForDateRequest requestBody,
List< string >?  reconciliationMethods = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] BatchAdjustHoldings: Batch adjust holdings

Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime in each request. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each adjustment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyThe selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (BatchAdjustHoldingsResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BatchCreateTradeTicketsAsync()

System.Threading.Tasks.Task<CreateTradeTicketsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BatchCreateTradeTicketsAsync ( string  scope,
string  code,
List< LusidTradeTicket lusidTradeTicket,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] BatchCreateTradeTickets: Batch Create Trade Tickets

Batch create trade tickets. Each ticket is broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
lusidTradeTicketthe trade tickets to create
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CreateTradeTicketsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BatchCreateTradeTicketsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CreateTradeTicketsResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BatchCreateTradeTicketsWithHttpInfoAsync ( string  scope,
string  code,
List< LusidTradeTicket lusidTradeTicket,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] BatchCreateTradeTickets: Batch Create Trade Tickets

Batch create trade tickets. Each ticket is broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
lusidTradeTicketthe trade tickets to create
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CreateTradeTicketsResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BatchUpsertTransactionsAsync()

System.Threading.Tasks.Task<BatchUpsertPortfolioTransactionsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BatchUpsertTransactionsAsync ( string  scope,
string  code,
string  successMode,
Dictionary< string, TransactionRequest requestBody,
bool?  preserveProperties = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] BatchUpsertTransactions: Batch upsert transactions

Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each transaction in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBodyThe payload describing the transactions to be created or updated.
preservePropertiesIf set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated. (optional, default to true)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of BatchUpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BatchUpsertTransactionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<BatchUpsertPortfolioTransactionsResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BatchUpsertTransactionsWithHttpInfoAsync ( string  scope,
string  code,
string  successMode,
Dictionary< string, TransactionRequest requestBody,
bool?  preserveProperties = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] BatchUpsertTransactions: Batch upsert transactions

Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each transaction in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBodyThe payload describing the transactions to be created or updated.
preservePropertiesIf set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated. (optional, default to true)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (BatchUpsertPortfolioTransactionsResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BuildTransactionsAsync()

System.Threading.Tasks.Task<VersionedResourceListOfOutputTransaction> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BuildTransactionsAsync ( string  scope,
string  code,
TransactionQueryParameters  transactionQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
int?  limit = default(int?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

BuildTransactions: Build transactions

Builds and returns all transactions that affect the holdings of a portfolio over a given interval of effective time into a set of output transactions. This includes transactions automatically generated by LUSID such as holding adjustments.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionQueryParametersThe query queryParameters which control how the output transactions are built.
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Transaction&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfOutputTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BuildTransactionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfOutputTransaction> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.BuildTransactionsWithHttpInfoAsync ( string  scope,
string  code,
TransactionQueryParameters  transactionQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
int?  limit = default(int?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

BuildTransactions: Build transactions

Builds and returns all transactions that affect the holdings of a portfolio over a given interval of effective time into a set of output transactions. This includes transactions automatically generated by LUSID such as holding adjustments.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionQueryParametersThe query queryParameters which control how the output transactions are built.
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Transaction&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfOutputTransaction)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelAdjustHoldingsAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CancelAdjustHoldingsAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CancelAdjustHoldings: Cancel adjust holdings

Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective datetime. This should be used to undo holding adjustments made via set holdings or adjust holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holding adjustments should be undone.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelAdjustHoldingsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CancelAdjustHoldingsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CancelAdjustHoldings: Cancel adjust holdings

Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective datetime. This should be used to undo holding adjustments made via set holdings or adjust holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holding adjustments should be undone.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelTransactionsAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CancelTransactionsAsync ( string  scope,
string  code,
List< string >  transactionIds,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CancelTransactions: Cancel transactions

Cancel one or more transactions from the transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdsThe IDs of the transactions to cancel.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelTransactionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CancelTransactionsWithHttpInfoAsync ( string  scope,
string  code,
List< string >  transactionIds,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CancelTransactions: Cancel transactions

Cancel one or more transactions from the transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdsThe IDs of the transactions to cancel.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CreatePortfolioAsync()

System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CreatePortfolioAsync ( string  scope,
CreateTransactionPortfolioRequest  createTransactionPortfolioRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CreatePortfolio: Create portfolio

Create a transaction portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the transaction portfolio.
createTransactionPortfolioRequestThe definition of the transaction portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Portfolio

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CreatePortfolioWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Portfolio> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CreatePortfolioWithHttpInfoAsync ( string  scope,
CreateTransactionPortfolioRequest  createTransactionPortfolioRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

CreatePortfolio: Create portfolio

Create a transaction portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the transaction portfolio.
createTransactionPortfolioRequestThe definition of the transaction portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Portfolio)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CreateTradeTicketAsync()

System.Threading.Tasks.Task<LusidTradeTicket> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CreateTradeTicketAsync ( string  scope,
string  code,
LusidTradeTicket lusidTradeTicket = default(LusidTradeTicket?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateTradeTicket: Create Trade Ticket

Upsert a trade ticket. Broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two. It can be viewed as a utility function or part of a workflow more familiar to users with OTC systems than flow and equity trading ones.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
lusidTradeTicketthe trade ticket to upsert (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of LusidTradeTicket

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CreateTradeTicketWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<LusidTradeTicket> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.CreateTradeTicketWithHttpInfoAsync ( string  scope,
string  code,
LusidTradeTicket lusidTradeTicket = default(LusidTradeTicket?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateTradeTicket: Create Trade Ticket

Upsert a trade ticket. Broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two. It can be viewed as a utility function or part of a workflow more familiar to users with OTC systems than flow and equity trading ones.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
lusidTradeTicketthe trade ticket to upsert (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (LusidTradeTicket)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ DeleteCustodianAccountsAsync()

System.Threading.Tasks.Task<DeleteCustodianAccountsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.DeleteCustodianAccountsAsync ( string  scope,
string  code,
List< ResourceId resourceId,
string?  deleteMode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts

Delete one or more custodian accounts from the Transaction Portfolios. Soft deletion marks the custodian account as inactive While the Hard deletion is deleting the custodian account. The batch limit per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolios.
codeThe code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios.
resourceIdThe scope and codes of the custodian accounts to delete.
deleteModeThe delete mode to use (defaults to &#39;Soft&#39;). (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeleteCustodianAccountsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ DeleteCustodianAccountsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeleteCustodianAccountsResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.DeleteCustodianAccountsWithHttpInfoAsync ( string  scope,
string  code,
List< ResourceId resourceId,
string?  deleteMode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts

Delete one or more custodian accounts from the Transaction Portfolios. Soft deletion marks the custodian account as inactive While the Hard deletion is deleting the custodian account. The batch limit per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolios.
codeThe code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios.
resourceIdThe scope and codes of the custodian accounts to delete.
deleteModeThe delete mode to use (defaults to &#39;Soft&#39;). (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeleteCustodianAccountsResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ DeletePropertiesFromTransactionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.DeletePropertiesFromTransactionAsync ( string  scope,
string  code,
string  transactionId,
List< string >  propertyKeys,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

DeletePropertiesFromTransaction: Delete properties from transaction

Delete one or more properties from a single transaction in a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction from which to delete properties.
propertyKeysThe property keys of the properties to delete. These must be from the &quot;Transaction&quot; domain and have the format {domain}/{scope}/{code}, for example &quot;Transaction/strategy/quantsignal&quot;.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ DeletePropertiesFromTransactionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.DeletePropertiesFromTransactionWithHttpInfoAsync ( string  scope,
string  code,
string  transactionId,
List< string >  propertyKeys,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

DeletePropertiesFromTransaction: Delete properties from transaction

Delete one or more properties from a single transaction in a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction from which to delete properties.
propertyKeysThe property keys of the properties to delete. These must be from the &quot;Transaction&quot; domain and have the format {domain}/{scope}/{code}, for example &quot;Transaction/strategy/quantsignal&quot;.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetA2BDataAsync()

System.Threading.Tasks.Task<VersionedResourceListOfA2BDataRecord> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetA2BDataAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetA2BData: Get A2B data

Get an A2B report for the given portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio to retrieve the A2B report for.
codeThe code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfA2BDataRecord

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetA2BDataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfA2BDataRecord> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetA2BDataWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetA2BData: Get A2B data

Get an A2B report for the given portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio to retrieve the A2B report for.
codeThe code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfA2BDataRecord)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetA2BMovementsAsync()

System.Threading.Tasks.Task<VersionedResourceListOfA2BMovementRecord> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetA2BMovementsAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetA2BMovements: Get an A2B report at the movement level for the given portfolio.

Get an A2B report at the movement level for the given portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio to retrieve the A2B movement report for.
codeThe code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfA2BMovementRecord

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetA2BMovementsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfA2BMovementRecord> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetA2BMovementsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetA2BMovements: Get an A2B report at the movement level for the given portfolio.

Get an A2B report at the movement level for the given portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio to retrieve the A2B movement report for.
codeThe code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfA2BMovementRecord)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetBucketedCashFlowsAsync()

System.Threading.Tasks.Task<BucketedCashFlowResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetBucketedCashFlowsAsync ( string  scope,
string  code,
BucketedCashFlowRequest bucketedCashFlowRequest = default(BucketedCashFlowRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios

We bucket/aggregate a transaction portfolio&#39;s instruments by date or tenor specified in the request. The cashflows are grouped by both instrumentId and currency. If you want transactional level cashflow, please use the &#39;GetUpsertableCashFlows&#39; endpoint. If you want instrument cashflow, please use the &#39;GetPortfolioCashFlows&#39; endpoint. Note that these endpoints do not apply bucketing.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
bucketedCashFlowRequestRequest specifying the bucketing of cashflows (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of BucketedCashFlowResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetBucketedCashFlowsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<BucketedCashFlowResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetBucketedCashFlowsWithHttpInfoAsync ( string  scope,
string  code,
BucketedCashFlowRequest bucketedCashFlowRequest = default(BucketedCashFlowRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios

We bucket/aggregate a transaction portfolio&#39;s instruments by date or tenor specified in the request. The cashflows are grouped by both instrumentId and currency. If you want transactional level cashflow, please use the &#39;GetUpsertableCashFlows&#39; endpoint. If you want instrument cashflow, please use the &#39;GetPortfolioCashFlows&#39; endpoint. Note that these endpoints do not apply bucketing.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
bucketedCashFlowRequestRequest specifying the bucketing of cashflows (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (BucketedCashFlowResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetCustodianAccountAsync()

System.Threading.Tasks.Task<CustodianAccount> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetCustodianAccountAsync ( string  scope,
string  code,
string  custodianAccountScope,
string  custodianAccountCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetCustodianAccount: Get Custodian Account

Retrieve the definition of a particular Custodian Account which is part of a Transaction Portfolios.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolio.
codeThe code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.
custodianAccountScopeThe scope of the Custodian Account.
custodianAccountCodeThe code of the Custodian Account.
effectiveAtThe effective datetime or cut label at which to retrieve the Custodian Account properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;CustodianAccount&#39; domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example &#39;CustodianAccount/Manager/Id&#39;. If not provided will return all the entitled properties for that Custodian Account. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CustodianAccount

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetCustodianAccountWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustodianAccount> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetCustodianAccountWithHttpInfoAsync ( string  scope,
string  code,
string  custodianAccountScope,
string  custodianAccountCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetCustodianAccount: Get Custodian Account

Retrieve the definition of a particular Custodian Account which is part of a Transaction Portfolios.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolio.
codeThe code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.
custodianAccountScopeThe scope of the Custodian Account.
custodianAccountCodeThe code of the Custodian Account.
effectiveAtThe effective datetime or cut label at which to retrieve the Custodian Account properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;CustodianAccount&#39; domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example &#39;CustodianAccount/Manager/Id&#39;. If not provided will return all the entitled properties for that Custodian Account. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CustodianAccount)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetDetailsAsync()

System.Threading.Tasks.Task<PortfolioDetails> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetDetailsAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetDetails: Get details

Get certain details associated with a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the details of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the details of the transaction portfolio. Defaults to returning the latest version of the details if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetDetailsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioDetails> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetDetailsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetDetails: Get details

Get certain details associated with a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the details of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the details of the transaction portfolio. Defaults to returning the latest version of the details if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PortfolioDetails)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingContributorsAsync()

System.Threading.Tasks.Task<VersionedResourceListOfHoldingContributor> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingContributorsAsync ( string  scope,
string  code,
long  holdingId,
DateTimeOrCutLabel effectiveDate = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel fromTradeDate = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toTradeDate = default(DateTimeOrCutLabel?),
bool?  includeHistoric = default(bool?),
string?  taxLotId = default(string?),
int?  limit = default(int?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetHoldingContributors: Get Holdings Contributors

Lists all transactions that affect the holdings of a portfolio over a given effective interval. This includes transactions automatically generated by LUSID such as holding adjustments.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
holdingIdThe unique holding identifier
effectiveDateEffective date (optional)
fromTradeDateThe from trade date, defaults to first time this holding is opened, lower bound for transactions (optional)
toTradeDateThe to trade date upper bound date, defaults to effectiveDate. upper bound for transactions (optional)
includeHistoricIf true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened. (optional, default to false)
taxLotIdConstrains the Holding Contributors to those which contributed to the specified tax lot. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetHoldingContributors. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfHoldingContributor

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingContributorsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfHoldingContributor> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingContributorsWithHttpInfoAsync ( string  scope,
string  code,
long  holdingId,
DateTimeOrCutLabel effectiveDate = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel fromTradeDate = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toTradeDate = default(DateTimeOrCutLabel?),
bool?  includeHistoric = default(bool?),
string?  taxLotId = default(string?),
int?  limit = default(int?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetHoldingContributors: Get Holdings Contributors

Lists all transactions that affect the holdings of a portfolio over a given effective interval. This includes transactions automatically generated by LUSID such as holding adjustments.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
holdingIdThe unique holding identifier
effectiveDateEffective date (optional)
fromTradeDateThe from trade date, defaults to first time this holding is opened, lower bound for transactions (optional)
toTradeDateThe to trade date upper bound date, defaults to effectiveDate. upper bound for transactions (optional)
includeHistoricIf true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened. (optional, default to false)
taxLotIdConstrains the Holding Contributors to those which contributed to the specified tax lot. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetHoldingContributors. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfHoldingContributor)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsAdjustmentAsync()

System.Threading.Tasks.Task<HoldingsAdjustment> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingsAdjustmentAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetHoldingsAdjustment: Get holdings adjustment

Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a holdings adjustment will only be returned if one exists for the specified effective datetime.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label of the holdings adjustment.
asAtThe asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified. (optional)
propertyKeysA list of property keys from the ‘Instrument&#39; domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example &#39;Instrument/system/Name&#39;. Note that properties from the &#39;Holding’ domain are automatically returned. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of HoldingsAdjustment

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsAdjustmentWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<HoldingsAdjustment> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingsAdjustmentWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetHoldingsAdjustment: Get holdings adjustment

Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a holdings adjustment will only be returned if one exists for the specified effective datetime.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label of the holdings adjustment.
asAtThe asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified. (optional)
propertyKeysA list of property keys from the ‘Instrument&#39; domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example &#39;Instrument/system/Name&#39;. Note that properties from the &#39;Holding’ domain are automatically returned. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (HoldingsAdjustment)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsAsync()

System.Threading.Tasks.Task<VersionedResourceListOfPortfolioHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingsAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
bool?  byTaxlots = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetHoldings: Get holdings

Calculate holdings for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Holding Type, use &quot;holdingType eq &#39;p&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Holding&quot;, &quot;Custodian Account&quot; or &quot;Portfolio&quot; domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfPortfolioHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfPortfolioHolding> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
bool?  byTaxlots = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetHoldings: Get holdings

Calculate holdings for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Holding Type, use &quot;holdingType eq &#39;p&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Holding&quot;, &quot;Custodian Account&quot; or &quot;Portfolio&quot; domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfPortfolioHolding)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsWithOrdersAsync()

System.Threading.Tasks.Task<VersionedResourceListWithWarningsOfPortfolioHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingsWithOrdersAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
bool?  byTaxlots = default(bool?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetHoldingsWithOrders: Get holdings with orders

Get the holdings of a transaction portfolio. Create virtual holdings for any outstanding orders, and account for order state/fulfillment; that is, treat outstanding orders (and related records) as if they had been realised at moment of query.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Holding Type, use &quot;holdingType eq &#39;p&#39;&quot; For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Holding&quot; or &quot;Portfolio&quot; domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListWithWarningsOfPortfolioHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsWithOrdersWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListWithWarningsOfPortfolioHolding> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetHoldingsWithOrdersWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
bool?  byTaxlots = default(bool?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetHoldingsWithOrders: Get holdings with orders

Get the holdings of a transaction portfolio. Create virtual holdings for any outstanding orders, and account for order state/fulfillment; that is, treat outstanding orders (and related records) as if they had been realised at moment of query.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Holding Type, use &quot;holdingType eq &#39;p&#39;&quot; For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Holding&quot; or &quot;Portfolio&quot; domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListWithWarningsOfPortfolioHolding)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashFlowsAsync()

System.Threading.Tasks.Task<ResourceListOfInstrumentCashFlow> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetPortfolioCashFlowsAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowStart = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowEnd = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
bool?  excludeUnsettledTrades = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[BETA] GetPortfolioCashFlows: Get portfolio cash flows

Get the set of cash flows that occur in a window for the transaction portfolio&#39;s instruments. Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (optional)
windowStartThe lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date. (optional)
windowEndThe upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to &#39;max date&#39; if it is not specified (optional)
asAtThe asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
excludeUnsettledTradesIf absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set. (optional, default to false)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfInstrumentCashFlow

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashFlowsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfInstrumentCashFlow> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetPortfolioCashFlowsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowStart = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowEnd = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
bool?  excludeUnsettledTrades = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[BETA] GetPortfolioCashFlows: Get portfolio cash flows

Get the set of cash flows that occur in a window for the transaction portfolio&#39;s instruments. Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (optional)
windowStartThe lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date. (optional)
windowEndThe upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to &#39;max date&#39; if it is not specified (optional)
asAtThe asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
excludeUnsettledTradesIf absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set. (optional, default to false)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfInstrumentCashFlow)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashLadderAsync()

System.Threading.Tasks.Task<ResourceListOfPortfolioCashLadder> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetPortfolioCashLadderAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
bool?  excludeUnsettledTrades = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetPortfolioCashLadder: Get portfolio cash ladder

Get a cash ladder for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
effectiveAtThe valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
excludeUnsettledTradesIf absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set. (optional, default to false)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPortfolioCashLadder

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashLadderWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPortfolioCashLadder> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetPortfolioCashLadderWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
bool?  excludeUnsettledTrades = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetPortfolioCashLadder: Get portfolio cash ladder

Get a cash ladder for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
effectiveAtThe valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
excludeUnsettledTradesIf absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set. (optional, default to false)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPortfolioCashLadder)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashStatementAsync()

System.Threading.Tasks.Task<ResourceListOfPortfolioCashFlow> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetPortfolioCashStatementAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetPortfolioCashStatement: Get portfolio cash statement

Get a cash statement for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPortfolioCashFlow

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashStatementWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPortfolioCashFlow> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetPortfolioCashStatementWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetPortfolioCashStatement: Get portfolio cash statement

Get a cash statement for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPortfolioCashFlow)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetTransactionHistoryAsync()

System.Threading.Tasks.Task<ResourceListOfChangeHistory> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetTransactionHistoryAsync ( string  scope,
string  code,
string  transactionId,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetTransactionHistory: Get the history of a transaction

Get all of the changes that have happened to a transaction.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction to create or update.
asAtThe asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfChangeHistory

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetTransactionHistoryWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfChangeHistory> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetTransactionHistoryWithHttpInfoAsync ( string  scope,
string  code,
string  transactionId,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetTransactionHistory: Get the history of a transaction

Get all of the changes that have happened to a transaction.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction to create or update.
asAtThe asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfChangeHistory)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetTransactionsAsync()

System.Threading.Tasks.Task<VersionedResourceListOfTransaction> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetTransactionsAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromTransactionDate = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toTransactionDate = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
string?  page = default(string?),
int?  limit = default(int?),
bool?  showCancelledTransactions = default(bool?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetTransactions: Get transactions

Retrieve all the transactions that occurred during a particular time interval. If the portfolio is a derived transaction portfolio, the transactions returned are the union set of all transactions of the parent (and any grandparents, etc.) as well as those of the derived transaction portfolio itself.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromTransactionDateThe lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified. (optional)
toTransactionDateThe upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression with which to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot; For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39;, &#39;Transaction&#39;, &quot;LegalEntity&quot; or &quot;CustodianAccount&quot; domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example &#39;Instrument/system/Name&#39; or &#39;Transaction/strategy/quantsignal&#39;. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
limitWhen paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination. (optional)
showCancelledTransactionsOption to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetTransactionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfTransaction> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetTransactionsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromTransactionDate = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toTransactionDate = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
string?  page = default(string?),
int?  limit = default(int?),
bool?  showCancelledTransactions = default(bool?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetTransactions: Get transactions

Retrieve all the transactions that occurred during a particular time interval. If the portfolio is a derived transaction portfolio, the transactions returned are the union set of all transactions of the parent (and any grandparents, etc.) as well as those of the derived transaction portfolio itself.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromTransactionDateThe lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified. (optional)
toTransactionDateThe upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression with which to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot; For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39;, &#39;Transaction&#39;, &quot;LegalEntity&quot; or &quot;CustodianAccount&quot; domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example &#39;Instrument/system/Name&#39; or &#39;Transaction/strategy/quantsignal&#39;. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
limitWhen paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination. (optional)
showCancelledTransactionsOption to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfTransaction)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetUpsertablePortfolioCashFlowsAsync()

System.Threading.Tasks.Task<ResourceListOfTransaction> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetUpsertablePortfolioCashFlowsAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowStart = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowEnd = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
bool?  excludeUnsettledTrades = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[BETA] GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows.

Get the set of cash flows that occur in a window for the given portfolio instruments as a set of upsertable transactions (DTOs). Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows. In essence this is identical to the &#39;GetCashFlows&#39; endpoint but returns the cash flows as a set of transactions suitable for directly putting back into LUSID. There are a couple of important points: (1) Internally it can not be fully known where the user wishes to insert these transactions, e.g. portfolio and movement type. These are therefore defaulted to a sensible option; the user will likely need to change these. (2) Similarly, knowledge of any properties the user might wish to add to a transaction are unknown and consequently left empty. (3) The transaction id that is added is simply a concatenation of the original transaction id, instrument id and payment date and direction. The user can happily override this.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (optional)
windowStartThe lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time (optional)
windowEndThe upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to &#39;max date&#39; if it is not specified (optional)
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
excludeUnsettledTradesIf absent or set to true, unsettled trades will be excluded from the result set. If set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. (optional, default to true)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetUpsertablePortfolioCashFlowsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfTransaction> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.GetUpsertablePortfolioCashFlowsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowStart = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel windowEnd = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  recipeIdScope = default(string?),
string?  recipeIdCode = default(string?),
bool?  excludeUnsettledTrades = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[BETA] GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows.

Get the set of cash flows that occur in a window for the given portfolio instruments as a set of upsertable transactions (DTOs). Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows. In essence this is identical to the &#39;GetCashFlows&#39; endpoint but returns the cash flows as a set of transactions suitable for directly putting back into LUSID. There are a couple of important points: (1) Internally it can not be fully known where the user wishes to insert these transactions, e.g. portfolio and movement type. These are therefore defaulted to a sensible option; the user will likely need to change these. (2) Similarly, knowledge of any properties the user might wish to add to a transaction are unknown and consequently left empty. (3) The transaction id that is added is simply a concatenation of the original transaction id, instrument id and payment date and direction. The user can happily override this.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (optional)
windowStartThe lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time (optional)
windowEndThe upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to &#39;max date&#39; if it is not specified (optional)
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
excludeUnsettledTradesIf absent or set to true, unsettled trades will be excluded from the result set. If set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. (optional, default to true)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfTransaction)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ListCustodianAccountsAsync()

System.Threading.Tasks.Task<PagedResourceListOfCustodianAccount> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.ListCustodianAccountsAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListCustodianAccounts: List Custodian Accounts

List the custodian accounts in a Transaction Portfolios

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolio.
codeThe code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.
effectiveAtThe effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing custodian accounts; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Custodian Account type, specify &quot;code eq &#39;001&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;CustodianAccount&#39; domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example &#39;CustodianAccount/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfCustodianAccount

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ListCustodianAccountsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfCustodianAccount> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.ListCustodianAccountsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListCustodianAccounts: List Custodian Accounts

List the custodian accounts in a Transaction Portfolios

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolio.
codeThe code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.
effectiveAtThe effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing custodian accounts; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Custodian Account type, specify &quot;code eq &#39;001&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;CustodianAccount&#39; domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example &#39;CustodianAccount/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfCustodianAccount)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ListHoldingsAdjustmentsAsync()

System.Threading.Tasks.Task<ResourceListOfHoldingsAdjustmentHeader> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.ListHoldingsAdjustmentsAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

ListHoldingsAdjustments: List holdings adjustments

List the holdings adjustments made to the specified transaction portfolio over a specified interval of effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified. (optional)
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfHoldingsAdjustmentHeader

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ListHoldingsAdjustmentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfHoldingsAdjustmentHeader> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.ListHoldingsAdjustmentsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

ListHoldingsAdjustments: List holdings adjustments

List the holdings adjustments made to the specified transaction portfolio over a specified interval of effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified. (optional)
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfHoldingsAdjustmentHeader)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ PatchPortfolioDetailsAsync()

System.Threading.Tasks.Task<PortfolioDetails> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.PatchPortfolioDetailsAsync ( string  scope,
string  code,
List< Operation operation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] PatchPortfolioDetails: Patch portfolio details

Create or update certain details for a particular transaction portfolio. The behaviour is defined by the JSON Patch specification. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored. Currently supported properties are: SubHoldingKeys, BaseCurrency, AmortisationMethod

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
operationThe patch document.
effectiveAtThe effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ PatchPortfolioDetailsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioDetails> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.PatchPortfolioDetailsWithHttpInfoAsync ( string  scope,
string  code,
List< Operation operation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] PatchPortfolioDetails: Patch portfolio details

Create or update certain details for a particular transaction portfolio. The behaviour is defined by the JSON Patch specification. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored. Currently supported properties are: SubHoldingKeys, BaseCurrency, AmortisationMethod

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
operationThe patch document.
effectiveAtThe effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PortfolioDetails)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ResolveInstrumentAsync()

System.Threading.Tasks.Task<UpsertPortfolioTransactionsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.ResolveInstrumentAsync ( string  scope,
string  code,
string  instrumentIdentifierType,
string  instrumentIdentifierValue,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
bool?  reResolve = default(bool?),
Dictionary< string, string >?  requestBody = default(Dictionary< string, string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] ResolveInstrument: Resolve instrument

Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified period of time. Also update the instrument identifiers with the given instrument identifiers collection.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
instrumentIdentifierTypeThe instrument identifier type.
instrumentIdentifierValueThe value for the given instrument identifier.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (optional)
reResolveWhen set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved. (optional, default to false)
requestBodyThe dictionary with the instrument identifiers to be updated on the transaction and holdings. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ResolveInstrumentWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertPortfolioTransactionsResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.ResolveInstrumentWithHttpInfoAsync ( string  scope,
string  code,
string  instrumentIdentifierType,
string  instrumentIdentifierValue,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
bool?  reResolve = default(bool?),
Dictionary< string, string >?  requestBody = default(Dictionary< string, string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] ResolveInstrument: Resolve instrument

Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified period of time. Also update the instrument identifiers with the given instrument identifiers collection.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
instrumentIdentifierTypeThe instrument identifier type.
instrumentIdentifierValueThe value for the given instrument identifier.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (optional)
reResolveWhen set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved. (optional, default to false)
requestBodyThe dictionary with the instrument identifiers to be updated on the transaction and holdings. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertPortfolioTransactionsResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ SetHoldingsAsync()

System.Threading.Tasks.Task<AdjustHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.SetHoldingsAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >?  reconciliationMethods = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

SetHoldings: Set holdings

Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe complete set of target holdings for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AdjustHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ SetHoldingsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AdjustHolding> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.SetHoldingsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >?  reconciliationMethods = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

SetHoldings: Set holdings

Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe complete set of target holdings for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AdjustHolding)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertCustodianAccountsAsync()

System.Threading.Tasks.Task<CustodianAccountsUpsertResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertCustodianAccountsAsync ( string  scope,
string  code,
List< CustodianAccountRequest custodianAccountRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertCustodianAccounts: Upsert Custodian Accounts

Create or update Custodian Accounts in the Transaction Portfolios. A Custodian Account will be updated if it already exists and created if it does not. The batch limit per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolio.
codeThe code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.
custodianAccountRequestA list of Custodian Accounts to be created or updated.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CustodianAccountsUpsertResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertCustodianAccountsPropertiesAsync()

System.Threading.Tasks.Task<CustodianAccountProperties> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertCustodianAccountsPropertiesAsync ( string  scope,
string  code,
string  custodianAccountScope,
string  custodianAccountCode,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertCustodianAccountsProperties: Upsert custodian accounts properties

Update or insert one or more properties onto a single custodian account. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain &#39;CustodianAccount&#39;. Upserting a property that exists for a Transaction Portfolios, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolios to update or insert the properties onto.
codeThe code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.
custodianAccountScopeThe scope of the Custodian Account to update or insert the properties onto.
custodianAccountCodeThe unique ID of the custodian account to create or update properties for.
requestBodyThe properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. &quot;CustodianAccount/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CustodianAccountProperties

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertCustodianAccountsPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustodianAccountProperties> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertCustodianAccountsPropertiesWithHttpInfoAsync ( string  scope,
string  code,
string  custodianAccountScope,
string  custodianAccountCode,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertCustodianAccountsProperties: Upsert custodian accounts properties

Update or insert one or more properties onto a single custodian account. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain &#39;CustodianAccount&#39;. Upserting a property that exists for a Transaction Portfolios, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolios to update or insert the properties onto.
codeThe code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.
custodianAccountScopeThe scope of the Custodian Account to update or insert the properties onto.
custodianAccountCodeThe unique ID of the custodian account to create or update properties for.
requestBodyThe properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. &quot;CustodianAccount/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CustodianAccountProperties)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertCustodianAccountsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustodianAccountsUpsertResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertCustodianAccountsWithHttpInfoAsync ( string  scope,
string  code,
List< CustodianAccountRequest custodianAccountRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertCustodianAccounts: Upsert Custodian Accounts

Create or update Custodian Accounts in the Transaction Portfolios. A Custodian Account will be updated if it already exists and created if it does not. The batch limit per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Transaction Portfolio.
codeThe code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.
custodianAccountRequestA list of Custodian Accounts to be created or updated.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CustodianAccountsUpsertResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertPortfolioDetailsAsync()

System.Threading.Tasks.Task<PortfolioDetails> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertPortfolioDetailsAsync ( string  scope,
string  code,
CreatePortfolioDetails  createPortfolioDetails,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertPortfolioDetails: Upsert portfolio details

Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
createPortfolioDetailsThe details to create or update for the specified transaction portfolio.
effectiveAtThe effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertPortfolioDetailsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioDetails> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertPortfolioDetailsWithHttpInfoAsync ( string  scope,
string  code,
CreatePortfolioDetails  createPortfolioDetails,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertPortfolioDetails: Upsert portfolio details

Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
createPortfolioDetailsThe details to create or update for the specified transaction portfolio.
effectiveAtThe effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PortfolioDetails)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionPropertiesAsync()

System.Threading.Tasks.Task<UpsertTransactionPropertiesResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertTransactionPropertiesAsync ( string  scope,
string  code,
string  transactionId,
Dictionary< string, PerpetualProperty requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertTransactionProperties: Upsert transaction properties

Create or update one or more transaction properties for a single transaction in the transaction portfolio. Each property will be updated if it already exists and created if it does not. Both transaction and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction to create or update properties for.
requestBodyThe properties and their associated values to create or update.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertTransactionPropertiesResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertTransactionPropertiesResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertTransactionPropertiesWithHttpInfoAsync ( string  scope,
string  code,
string  transactionId,
Dictionary< string, PerpetualProperty requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertTransactionProperties: Upsert transaction properties

Create or update one or more transaction properties for a single transaction in the transaction portfolio. Each property will be updated if it already exists and created if it does not. Both transaction and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction to create or update properties for.
requestBodyThe properties and their associated values to create or update.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertTransactionPropertiesResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionsAsync()

System.Threading.Tasks.Task<UpsertPortfolioTransactionsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertTransactionsAsync ( string  scope,
string  code,
List< TransactionRequest transactionRequest,
bool?  preserveProperties = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertTransactions: Upsert transactions

Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. The maximum number of transactions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionRequestA list of transactions to be created or updated.
preservePropertiesIf set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated. (optional, default to true)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertPortfolioTransactionsResponse> > Lusid.Sdk.Api.ITransactionPortfoliosApiAsync.UpsertTransactionsWithHttpInfoAsync ( string  scope,
string  code,
List< TransactionRequest transactionRequest,
bool?  preserveProperties = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertTransactions: Upsert transactions

Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. The maximum number of transactions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionRequestA list of transactions to be created or updated.
preservePropertiesIf set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated. (optional, default to true)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertPortfolioTransactionsResponse)

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.


The documentation for this interface was generated from the following file: