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

Inheritance diagram for Lusid.Sdk.Api.IPortfolioGroupsApiAsync:

Public Member Functions
System.Threading.Tasks.Task< PortfolioGroup >	AddPortfolioToGroupAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Add portfolio to group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	AddPortfolioToGroupWithHttpInfoAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Add portfolio to group More...

System.Threading.Tasks.Task< PortfolioGroup >	AddSubGroupToGroupAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Add sub group to group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	AddSubGroupToGroupWithHttpInfoAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Add sub group to group More...

System.Threading.Tasks.Task< VersionedResourceListOfOutputTransaction >	BuildTransactionsForPortfolioGroupAsync (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))
	[EARLY ACCESS] Build transactions for transaction portfolios in a portfolio group More...

System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfOutputTransaction > >	BuildTransactionsForPortfolioGroupWithHttpInfoAsync (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))
	[EARLY ACCESS] Build transactions for transaction portfolios in a portfolio group More...

System.Threading.Tasks.Task< PortfolioGroup >	CreatePortfolioGroupAsync (string scope, CreatePortfolioGroupRequest createPortfolioGroupRequest=default(CreatePortfolioGroupRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create portfolio group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	CreatePortfolioGroupWithHttpInfoAsync (string scope, CreatePortfolioGroupRequest createPortfolioGroupRequest=default(CreatePortfolioGroupRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create portfolio group More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteGroupPropertiesAsync (string scope, string code, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete group properties More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteGroupPropertiesWithHttpInfoAsync (string scope, string code, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete group properties More...

System.Threading.Tasks.Task< PortfolioGroup >	DeletePortfolioFromGroupAsync (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete portfolio from group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	DeletePortfolioFromGroupWithHttpInfoAsync (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete portfolio from group More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePortfolioGroupAsync (string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete portfolio group More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePortfolioGroupWithHttpInfoAsync (string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete portfolio group More...

System.Threading.Tasks.Task< PortfolioGroup >	DeleteSubGroupFromGroupAsync (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete sub group from group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	DeleteSubGroupFromGroupWithHttpInfoAsync (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete sub group from group More...

System.Threading.Tasks.Task< PortfolioGroupProperties >	GetGroupPropertiesAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get group properties More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroupProperties > >	GetGroupPropertiesWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get group properties More...

System.Threading.Tasks.Task< VersionedResourceListOfPortfolioHolding >	GetHoldingsForPortfolioGroupAsync (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))
	[EARLY ACCESS] Get holdings for transaction portfolios in portfolio group More...

System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfPortfolioHolding > >	GetHoldingsForPortfolioGroupWithHttpInfoAsync (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))
	[EARLY ACCESS] Get holdings for transaction portfolios in portfolio group More...

System.Threading.Tasks.Task< PortfolioGroup >	GetPortfolioGroupAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	GetPortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio group More...

System.Threading.Tasks.Task< ResourceListOfProcessedCommand >	GetPortfolioGroupCommandsAsync (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio group commands More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfProcessedCommand > >	GetPortfolioGroupCommandsWithHttpInfoAsync (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio group commands More...

System.Threading.Tasks.Task< ExpandedGroup >	GetPortfolioGroupExpansionAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyFilter=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio group expansion More...

System.Threading.Tasks.Task< ApiResponse< ExpandedGroup > >	GetPortfolioGroupExpansionWithHttpInfoAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyFilter=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get portfolio group expansion More...

System.Threading.Tasks.Task< VersionedResourceListOfTransaction >	GetTransactionsForPortfolioGroupAsync (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 >), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get transactions for transaction portfolios in a portfolio group More...

System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfTransaction > >	GetTransactionsForPortfolioGroupWithHttpInfoAsync (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 >), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get transactions for transaction portfolios in a portfolio group More...

System.Threading.Tasks.Task< ResourceListOfPortfolioGroup >	ListPortfolioGroupsAsync (string scope, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List portfolio groups More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPortfolioGroup > >	ListPortfolioGroupsWithHttpInfoAsync (string scope, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List portfolio groups More...

System.Threading.Tasks.Task< PortfolioGroup >	UpdatePortfolioGroupAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), UpdatePortfolioGroupRequest updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Update portfolio group More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroup > >	UpdatePortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), UpdatePortfolioGroupRequest updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Update portfolio group More...

System.Threading.Tasks.Task< PortfolioGroupProperties >	UpsertGroupPropertiesAsync (string scope, string code, Dictionary< string, Property > requestBody=default(Dictionary< string, Property >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert group properties More...

System.Threading.Tasks.Task< ApiResponse< PortfolioGroupProperties > >	UpsertGroupPropertiesWithHttpInfoAsync (string scope, string code, Dictionary< string, Property > requestBody=default(Dictionary< string, Property >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert group properties 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

◆ AddPortfolioToGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.AddPortfolioToGroupAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Add portfolio to group

Add a single portfolio to a portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to add a portfolio to.
code	The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime from which the portfolio will be added to the group. (optional)
resourceId	The resource identifier of the portfolio to add to the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ AddPortfolioToGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.AddPortfolioToGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Add portfolio to group

Add a single portfolio to a portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to add a portfolio to.
code	The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime from which the portfolio will be added to the group. (optional)
resourceId	The resource identifier of the portfolio to add to the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ AddSubGroupToGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.AddSubGroupToGroupAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Add sub group to group

Add a portfolio group to a portfolio group as a sub group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to add a portfolio group to.
code	The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime from which the sub group will be added to the group. (optional)
resourceId	The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ AddSubGroupToGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.AddSubGroupToGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Add sub group to group

Add a portfolio group to a portfolio group as a sub group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to add a portfolio group to.
code	The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime from which the sub group will be added to the group. (optional)
resourceId	The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ BuildTransactionsForPortfolioGroupAsync()

System.Threading.Tasks.Task<VersionedResourceListOfOutputTransaction> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.BuildTransactionsForPortfolioGroupAsync	(	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)`
	)

[EARLY ACCESS] Build transactions for transaction portfolios in a portfolio group

Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.

Exceptions

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

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
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 filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (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.PortfolioGroupsApi.

◆ BuildTransactionsForPortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfOutputTransaction> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.BuildTransactionsForPortfolioGroupWithHttpInfoAsync	(	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)`
	)

[EARLY ACCESS] Build transactions for transaction portfolios in a portfolio group

Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.

Exceptions

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

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
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 filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (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.PortfolioGroupsApi.

◆ CreatePortfolioGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.CreatePortfolioGroupAsync	(	string	scope,
		CreatePortfolioGroupRequest	createPortfolioGroupRequest = `default(CreatePortfolioGroupRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Create portfolio group

Create a portfolio group in a specific scope.

Exceptions

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

Parameters

scope	The scope that the portfolio group will be created in.
createPortfolioGroupRequest	The definition and details of the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ CreatePortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.CreatePortfolioGroupWithHttpInfoAsync	(	string	scope,
		CreatePortfolioGroupRequest	createPortfolioGroupRequest = `default(CreatePortfolioGroupRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Create portfolio group

Create a portfolio group in a specific scope.

Exceptions

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

Parameters

scope	The scope that the portfolio group will be created in.
createPortfolioGroupRequest	The definition and details of the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteGroupPropertiesAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeleteGroupPropertiesAsync	(	string	scope,
		string	code,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete group properties

Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.

Exceptions

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

Parameters

scope	The scope of the group to delete properties from.
code	The code of the group to delete properties from. Together with the scope this uniquely identifies the group.
requestBody	The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain.
effectiveAt	The effective datetime or cut label at which to delete the properties. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteGroupPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeleteGroupPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete group properties

Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.

Exceptions

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

Parameters

scope	The scope of the group to delete properties from.
code	The code of the group to delete properties from. Together with the scope this uniquely identifies the group.
requestBody	The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain.
effectiveAt	The effective datetime or cut label at which to delete the properties. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioFromGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeletePortfolioFromGroupAsync	(	string	scope,
		string	code,
		string	portfolioScope,
		string	portfolioCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete portfolio from group

Remove a single portfolio from a portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to remove the portfolio from.
code	The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group.
portfolioScope	The scope of the portfolio being removed from the portfolio group.
portfolioCode	The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove.
effectiveAt	The effective datetime from which the portfolio will be removed from the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioFromGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeletePortfolioFromGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		string	portfolioScope,
		string	portfolioCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete portfolio from group

Remove a single portfolio from a portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to remove the portfolio from.
code	The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group.
portfolioScope	The scope of the portfolio being removed from the portfolio group.
portfolioCode	The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove.
effectiveAt	The effective datetime from which the portfolio will be removed from the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioGroupAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeletePortfolioGroupAsync	(	string	scope,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete portfolio group

Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio group to delete.
code	The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeletePortfolioGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete portfolio group

Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio group to delete.
code	The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteSubGroupFromGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeleteSubGroupFromGroupAsync	(	string	scope,
		string	code,
		string	subgroupScope,
		string	subgroupCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete sub group from group

Remove a single portfolio group (sub group) from a portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to remove the sub group from.
code	The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group.
subgroupScope	The scope of the sub group to remove from the portfolio group.
subgroupCode	The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group.
effectiveAt	The effective datetime from which the sub group will be removed from the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteSubGroupFromGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.DeleteSubGroupFromGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		string	subgroupScope,
		string	subgroupCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete sub group from group

Remove a single portfolio group (sub group) from a portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to remove the sub group from.
code	The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group.
subgroupScope	The scope of the sub group to remove from the portfolio group.
subgroupCode	The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group.
effectiveAt	The effective datetime from which the sub group will be removed from the portfolio group. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetGroupPropertiesAsync()

System.Threading.Tasks.Task<PortfolioGroupProperties> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetGroupPropertiesAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get group properties

List all the properties of a single portfolio group.

Exceptions

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

Parameters

scope	The scope of the group to list the properties for.
code	The code of the group to list the properties for. Together with the scope this uniquely identifies the group.
effectiveAt	The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroupProperties

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetGroupPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroupProperties> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetGroupPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get group properties

List all the properties of a single portfolio group.

Exceptions

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

Parameters

scope	The scope of the group to list the properties for.
code	The code of the group to list the properties for. Together with the scope this uniquely identifies the group.
effectiveAt	The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroupProperties)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetHoldingsForPortfolioGroupAsync()

System.Threading.Tasks.Task<VersionedResourceListOfPortfolioHolding> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetHoldingsForPortfolioGroupAsync	(	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)`
	)

[EARLY ACCESS] Get holdings for transaction portfolios in portfolio group

Get the holdings of transaction portfolios in specified portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Holding" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "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.PortfolioGroupsApi.

◆ GetHoldingsForPortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfPortfolioHolding> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetHoldingsForPortfolioGroupWithHttpInfoAsync	(	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)`
	)

[EARLY ACCESS] Get holdings for transaction portfolios in portfolio group

Get the holdings of transaction portfolios in specified portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Holding" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "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.PortfolioGroupsApi.

◆ GetPortfolioGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetPortfolioGroupAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio group

Retrieve the definition of a single portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to retrieve the definition for.
code	The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupCommandsAsync()

System.Threading.Tasks.Task<ResourceListOfProcessedCommand> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetPortfolioGroupCommandsAsync	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio group commands

Gets all the commands that modified a single portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to retrieve the commands for.
code	The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.
fromAsAt	The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAt	The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfProcessedCommand

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupCommandsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfProcessedCommand> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetPortfolioGroupCommandsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio group commands

Gets all the commands that modified a single portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to retrieve the commands for.
code	The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.
fromAsAt	The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAt	The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfProcessedCommand)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupExpansionAsync()

System.Threading.Tasks.Task<ExpandedGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetPortfolioGroupExpansionAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyFilter = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio group expansion

List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified.

Exceptions

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

Parameters

scope	The scope of the portfolio group to expand.
code	The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.
effectiveAt	The effective datetime at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional)
propertyFilter	The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ExpandedGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupExpansionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ExpandedGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetPortfolioGroupExpansionWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyFilter = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio group expansion

List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified.

Exceptions

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

Parameters

scope	The scope of the portfolio group to expand.
code	The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.
effectiveAt	The effective datetime at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional)
propertyFilter	The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ExpandedGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetPortfolioGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get portfolio group

Retrieve the definition of a single portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to retrieve the definition for.
code	The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetTransactionsForPortfolioGroupAsync()

System.Threading.Tasks.Task<VersionedResourceListOfTransaction> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetTransactionsForPortfolioGroupAsync	(	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 >)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get transactions for transaction portfolios in a portfolio group

Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.

Exceptions

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

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
fromTransactionDate	The lower bound effective datetime or cut label (inclusive) from which to retrieve the 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 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 filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (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 GetTransactions. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of VersionedResourceListOfTransaction

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetTransactionsForPortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfTransaction> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.GetTransactionsForPortfolioGroupWithHttpInfoAsync	(	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 >)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get transactions for transaction portfolios in a portfolio group

Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.

Exceptions

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

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
fromTransactionDate	The lower bound effective datetime or cut label (inclusive) from which to retrieve the 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 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 filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (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 GetTransactions. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (VersionedResourceListOfTransaction)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ ListPortfolioGroupsAsync()

System.Threading.Tasks.Task<ResourceListOfPortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.ListPortfolioGroupsAsync	(	string	scope,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] List portfolio groups

List all the portfolio groups in a single scope.

Exceptions

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

Parameters

scope	The scope to list the portfolio groups in.
effectiveAt	The effective datetime at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ ListPortfolioGroupsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.ListPortfolioGroupsWithHttpInfoAsync	(	string	scope,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] List portfolio groups

List all the portfolio groups in a single scope.

Exceptions

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

Parameters

scope	The scope to list the portfolio groups in.
effectiveAt	The effective datetime at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpdatePortfolioGroupAsync()

System.Threading.Tasks.Task<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.UpdatePortfolioGroupAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		UpdatePortfolioGroupRequest	updatePortfolioGroupRequest = `default(UpdatePortfolioGroupRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Update portfolio group

Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to update the definition for.
code	The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime at which to update the definition. (optional)
updatePortfolioGroupRequest	The updated portfolio group definition. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpdatePortfolioGroupWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroup> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.UpdatePortfolioGroupWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		UpdatePortfolioGroupRequest	updatePortfolioGroupRequest = `default(UpdatePortfolioGroupRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Update portfolio group

Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group.

Exceptions

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

Parameters

scope	The scope of the portfolio group to update the definition for.
code	The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime at which to update the definition. (optional)
updatePortfolioGroupRequest	The updated portfolio group definition. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroup)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpsertGroupPropertiesAsync()

System.Threading.Tasks.Task<PortfolioGroupProperties> Lusid.Sdk.Api.IPortfolioGroupsApiAsync.UpsertGroupPropertiesAsync	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody = `default(Dictionary< string, Property >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Upsert group properties

Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

scope	The scope of the group to update or insert the properties onto.
code	The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.
requestBody	The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioGroupProperties

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpsertGroupPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioGroupProperties> > Lusid.Sdk.Api.IPortfolioGroupsApiAsync.UpsertGroupPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody = `default(Dictionary< string, Property >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Upsert group properties

Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

scope	The scope of the group to update or insert the properties onto.
code	The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.
requestBody	The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioGroupProperties)

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

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/PortfolioGroupsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddPortfolioToGroupAsync()

◆ AddPortfolioToGroupWithHttpInfoAsync()

◆ AddSubGroupToGroupAsync()

◆ AddSubGroupToGroupWithHttpInfoAsync()

◆ BuildTransactionsForPortfolioGroupAsync()

◆ BuildTransactionsForPortfolioGroupWithHttpInfoAsync()

◆ CreatePortfolioGroupAsync()

◆ CreatePortfolioGroupWithHttpInfoAsync()

◆ DeleteGroupPropertiesAsync()

◆ DeleteGroupPropertiesWithHttpInfoAsync()

◆ DeletePortfolioFromGroupAsync()

◆ DeletePortfolioFromGroupWithHttpInfoAsync()

◆ DeletePortfolioGroupAsync()

◆ DeletePortfolioGroupWithHttpInfoAsync()

◆ DeleteSubGroupFromGroupAsync()

◆ DeleteSubGroupFromGroupWithHttpInfoAsync()

◆ GetGroupPropertiesAsync()

◆ GetGroupPropertiesWithHttpInfoAsync()

◆ GetHoldingsForPortfolioGroupAsync()

◆ GetHoldingsForPortfolioGroupWithHttpInfoAsync()

◆ GetPortfolioGroupAsync()

◆ GetPortfolioGroupCommandsAsync()

◆ GetPortfolioGroupCommandsWithHttpInfoAsync()

◆ GetPortfolioGroupExpansionAsync()

◆ GetPortfolioGroupExpansionWithHttpInfoAsync()

◆ GetPortfolioGroupWithHttpInfoAsync()

◆ GetTransactionsForPortfolioGroupAsync()

◆ GetTransactionsForPortfolioGroupWithHttpInfoAsync()

◆ ListPortfolioGroupsAsync()

◆ ListPortfolioGroupsWithHttpInfoAsync()

◆ UpdatePortfolioGroupAsync()

◆ UpdatePortfolioGroupWithHttpInfoAsync()

◆ UpsertGroupPropertiesAsync()

◆ UpsertGroupPropertiesWithHttpInfoAsync()