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

Inheritance diagram for Lusid.Sdk.Api.ITransactionPortfoliosApiAsync:

Public Member Functions
System.Threading.Tasks.Task< AdjustHolding >	AdjustHoldingsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string > reconciliationMethods=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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 >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Adjust holdings More...

System.Threading.Tasks.Task< VersionedResourceListOfOutputTransaction >	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), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Build transactions More...

System.Threading.Tasks.Task< DeletedEntityResponse >	CancelAdjustHoldingsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Cancel adjust holdings More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	CancelAdjustHoldingsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Cancel adjust holdings More...

System.Threading.Tasks.Task< DeletedEntityResponse >	CancelTransactionsAsync (string scope, string code, List< string > transactionIds, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Cancel transactions More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	CancelTransactionsWithHttpInfoAsync (string scope, string code, List< string > transactionIds, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Cancel transactions More...

System.Threading.Tasks.Task< Portfolio >	CreatePortfolioAsync (string scope, CreateTransactionPortfolioRequest createTransactionPortfolioRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create portfolio More...

System.Threading.Tasks.Task< ApiResponse< Portfolio > >	CreatePortfolioWithHttpInfoAsync (string scope, CreateTransactionPortfolioRequest createTransactionPortfolioRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create portfolio More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePropertiesFromTransactionAsync (string scope, string code, string transactionId, List< string > propertyKeys, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Delete properties from transaction More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePropertiesFromTransactionWithHttpInfoAsync (string scope, string code, string transactionId, List< string > propertyKeys, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Delete properties from transaction More...

System.Threading.Tasks.Task< PortfolioDetails >	GetDetailsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get details More...

System.Threading.Tasks.Task< ApiResponse< PortfolioDetails > >	GetDetailsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get details More...

System.Threading.Tasks.Task< VersionedResourceListOfPortfolioHolding >	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get holdings More...

System.Threading.Tasks.Task< HoldingsAdjustment >	GetHoldingsAdjustmentAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get holdings adjustment More...

System.Threading.Tasks.Task< ApiResponse< HoldingsAdjustment > >	GetHoldingsAdjustmentWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get holdings adjustment More...

System.Threading.Tasks.Task< ResourceListOfPortfolioCashFlow >	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), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio cash statement More...

System.Threading.Tasks.Task< VersionedResourceListOfTransaction >	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get transactions More...

System.Threading.Tasks.Task< ResourceListOfHoldingsAdjustmentHeader >	ListHoldingsAdjustmentsAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), DateTimeOrCutLabel toEffectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	List holdings adjustments More...

System.Threading.Tasks.Task< UpsertPortfolioTransactionsResponse >	ResolveInstrumentAsync (string scope, string code, string instrumentIdentifierType, string instrumentIdentifierValue, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), Dictionary< string, string > requestBody=default(Dictionary< string, string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Resolve instrument More...

System.Threading.Tasks.Task< ApiResponse< UpsertPortfolioTransactionsResponse > >	ResolveInstrumentWithHttpInfoAsync (string scope, string code, string instrumentIdentifierType, string instrumentIdentifierValue, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), Dictionary< string, string > requestBody=default(Dictionary< string, string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Resolve instrument More...

System.Threading.Tasks.Task< AdjustHolding >	SetHoldingsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string > reconciliationMethods=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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 >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Set holdings More...

System.Threading.Tasks.Task< PortfolioDetails >	UpsertPortfolioDetailsAsync (string scope, string code, CreatePortfolioDetails createPortfolioDetails, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert portfolio details More...

System.Threading.Tasks.Task< ApiResponse< PortfolioDetails > >	UpsertPortfolioDetailsWithHttpInfoAsync (string scope, string code, CreatePortfolioDetails createPortfolioDetails, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert portfolio details More...

System.Threading.Tasks.Task< UpsertTransactionPropertiesResponse >	UpsertTransactionPropertiesAsync (string scope, string code, string transactionId, Dictionary< string, PerpetualProperty > requestBody, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert transaction properties More...

System.Threading.Tasks.Task< ApiResponse< UpsertTransactionPropertiesResponse > >	UpsertTransactionPropertiesWithHttpInfoAsync (string scope, string code, string transactionId, Dictionary< string, PerpetualProperty > requestBody, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert transaction properties More...

System.Threading.Tasks.Task< UpsertPortfolioTransactionsResponse >	UpsertTransactionsAsync (string scope, string code, List< TransactionRequest > transactionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert transactions More...

System.Threading.Tasks.Task< ApiResponse< UpsertPortfolioTransactionsResponse > >	UpsertTransactionsWithHttpInfoAsync (string scope, string code, List< TransactionRequest > transactionRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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 >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequest	The selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethods	Optional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
cancellationToken	Cancellation 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 >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequest	The selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethods	Optional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AdjustHolding)

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)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionQueryParameters	The query queryParameters which control how the output transactions are built.
asAt	The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
cancellationToken	Cancellation 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)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionQueryParameters	The query queryParameters which control how the output transactions are built.
asAt	The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label at which the holding adjustments should be undone.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label at which the holding adjustments should be undone.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Cancel transactions

Cancel one or more transactions from the transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIds	The IDs of the transactions to cancel.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Cancel transactions

Cancel one or more transactions from the transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIds	The IDs of the transactions to cancel.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Create portfolio

Create a transaction portfolio in a particular scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope in which to create the transaction portfolio.
createTransactionPortfolioRequest	The definition of the transaction portfolio.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Create portfolio

Create a transaction portfolio in a particular scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope in which to create the transaction portfolio.
createTransactionPortfolioRequest	The definition of the transaction portfolio.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Portfolio)

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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Delete properties from transaction

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionId	The unique ID of the transaction from which to delete properties.
propertyKeys	The property keys of the properties to delete. These must be from the "Transaction" domain and have the format {domain}/{scope}/{code}, for example "Transaction/strategy/quantsignal".
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Delete properties from transaction

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionId	The unique ID of the transaction from which to delete properties.
propertyKeys	The property keys of the properties to delete. These must be from the "Transaction" domain and have the format {domain}/{scope}/{code}, for example "Transaction/strategy/quantsignal".
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Get details

Get certain details associated with a transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The 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)
asAt	The 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)
cancellationToken	Cancellation 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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Get details

Get certain details associated with a transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The 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)
asAt	The 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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioDetails)

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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label of the holdings adjustment.
asAt	The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified. (optional)
cancellationToken	Cancellation 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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label of the holdings adjustment.
asAt	The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified. (optional)
cancellationToken	Cancellation 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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Get holdings

Calculate holdings for a transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The 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)
asAt	The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Holding Type, use "holdingType eq 'p'". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Holding" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example "Instrument/system/Name" or "Holding/system/Cost". (optional)
byTaxlots	Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
cancellationToken	Cancellation 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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Get holdings

Calculate holdings for a transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The 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)
asAt	The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Holding Type, use "holdingType eq 'p'". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Holding" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example "Instrument/system/Name" or "Holding/system/Cost". (optional)
byTaxlots	Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (VersionedResourceListOfPortfolioHolding)

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)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio cash statement

Get a cash statement for a transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAt	The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAt	The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAt	The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScope	The scope of the given recipeId (optional)
recipeIdCode	The code of the given recipeID (optional)
cancellationToken	Cancellation 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)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio cash statement

Get a cash statement for a transaction portfolio.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAt	The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAt	The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAt	The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScope	The scope of the given recipeId (optional)
recipeIdCode	The code of the given recipeID (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPortfolioCashFlow)

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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromTransactionDate	The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified. (optional)
toTransactionDate	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAt	The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the 'Instrument' or 'Transaction' domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'. (optional)
page	The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
cancellationToken	Cancellation 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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromTransactionDate	The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified. (optional)
toTransactionDate	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAt	The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the 'Instrument' or 'Transaction' domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'. (optional)
page	The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (VersionedResourceListOfTransaction)

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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

List holdings adjustments

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromEffectiveAt	The 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)
toEffectiveAt	The 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)
asAt	The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified. (optional)
cancellationToken	Cancellation 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?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

List holdings adjustments

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromEffectiveAt	The 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)
toEffectiveAt	The 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)
asAt	The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfHoldingsAdjustmentHeader)

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)`,
		Dictionary< string, string >	requestBody = `default(Dictionary< string, string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
instrumentIdentifierType	The instrument identifier type.
instrumentIdentifierValue	The value for the given instrument identifier.
fromEffectiveAt	The 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)
requestBody	The dictionary with the instrument identifiers to be updated on the transaction and holdings. (optional)
cancellationToken	Cancellation 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)`,
		Dictionary< string, string >	requestBody = `default(Dictionary< string, string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
instrumentIdentifierType	The instrument identifier type.
instrumentIdentifierValue	The value for the given instrument identifier.
fromEffectiveAt	The 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)
requestBody	The dictionary with the instrument identifiers to be updated on the transaction and holdings. (optional)
cancellationToken	Cancellation 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 >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequest	The complete set of target holdings for the transaction portfolio.
reconciliationMethods	Optional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
cancellationToken	Cancellation 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 >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAt	The effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequest	The complete set of target holdings for the transaction portfolio.
reconciliationMethods	Optional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AdjustHolding)

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)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
createPortfolioDetails	The details to create or update for the specified transaction portfolio.
effectiveAt	The 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)
cancellationToken	Cancellation 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)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
createPortfolioDetails	The details to create or update for the specified transaction portfolio.
effectiveAt	The 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)
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionId	The unique ID of the transaction to create or update properties for.
requestBody	The properties and their associated values to create or update.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionId	The unique ID of the transaction to create or update properties for.
requestBody	The properties and their associated values to create or update.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionRequest	A list of transactions to be created or updated.
cancellationToken	Cancellation 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,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the transaction portfolio.
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionRequest	A list of transactions to be created or updated.
cancellationToken	Cancellation 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:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Api/TransactionPortfoliosApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AdjustHoldingsAsync()

◆ AdjustHoldingsWithHttpInfoAsync()

◆ BuildTransactionsAsync()

◆ BuildTransactionsWithHttpInfoAsync()

◆ CancelAdjustHoldingsAsync()

◆ CancelAdjustHoldingsWithHttpInfoAsync()

◆ CancelTransactionsAsync()

◆ CancelTransactionsWithHttpInfoAsync()

◆ CreatePortfolioAsync()

◆ CreatePortfolioWithHttpInfoAsync()

◆ DeletePropertiesFromTransactionAsync()

◆ DeletePropertiesFromTransactionWithHttpInfoAsync()

◆ GetDetailsAsync()

◆ GetDetailsWithHttpInfoAsync()

◆ GetHoldingsAdjustmentAsync()

◆ GetHoldingsAdjustmentWithHttpInfoAsync()

◆ GetHoldingsAsync()

◆ GetHoldingsWithHttpInfoAsync()

◆ GetPortfolioCashStatementAsync()

◆ GetPortfolioCashStatementWithHttpInfoAsync()

◆ GetTransactionsAsync()

◆ GetTransactionsWithHttpInfoAsync()

◆ ListHoldingsAdjustmentsAsync()

◆ ListHoldingsAdjustmentsWithHttpInfoAsync()

◆ ResolveInstrumentAsync()

◆ ResolveInstrumentWithHttpInfoAsync()

◆ SetHoldingsAsync()

◆ SetHoldingsWithHttpInfoAsync()

◆ UpsertPortfolioDetailsAsync()

◆ UpsertPortfolioDetailsWithHttpInfoAsync()

◆ UpsertTransactionPropertiesAsync()

◆ UpsertTransactionPropertiesWithHttpInfoAsync()

◆ UpsertTransactionsAsync()

◆ UpsertTransactionsWithHttpInfoAsync()