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

Inheritance diagram for Lusid.Sdk.Api.PortfolioGroupsApi:

[legend]

Public Member Functions
	PortfolioGroupsApi ()
	Initializes a new instance of the PortfolioGroupsApi class. More...

	PortfolioGroupsApi (String basePath)
	Initializes a new instance of the PortfolioGroupsApi class. More...

	PortfolioGroupsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the PortfolioGroupsApi class using Configuration object More...

	PortfolioGroupsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the PortfolioGroupsApi class using a Configuration object and client instance. More...

String	GetBasePath ()
	Gets the base path of the API client. More...

PortfolioGroup	AddPortfolioToGroup (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId))
	[EARLY ACCESS] Add portfolio to group Add a single portfolio to a portfolio group. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	AddPortfolioToGroupWithHttpInfo (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId))
	[EARLY ACCESS] Add portfolio to group Add a single portfolio to a portfolio group. More...

async 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 Add a single portfolio to a portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Add a single portfolio to a portfolio group. More...

PortfolioGroup	AddSubGroupToGroup (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId))
	[EARLY ACCESS] Add sub group to group Add a portfolio group to a portfolio group as a sub group. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	AddSubGroupToGroupWithHttpInfo (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), ResourceId resourceId=default(ResourceId))
	[EARLY ACCESS] Add sub group to group Add a portfolio group to a portfolio group as a sub group. More...

async 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 Add a portfolio group to a portfolio group as a sub group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Add a portfolio group to a portfolio group as a sub group. More...

VersionedResourceListOfOutputTransaction	BuildTransactionsForPortfolioGroup (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))
	[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. More...

Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfOutputTransaction >	BuildTransactionsForPortfolioGroupWithHttpInfo (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))
	[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. More...

async 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 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...

PortfolioGroup	CreatePortfolioGroup (string scope, CreatePortfolioGroupRequest createPortfolioGroupRequest=default(CreatePortfolioGroupRequest))
	[EARLY ACCESS] Create portfolio group Create a portfolio group in a specific scope. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	CreatePortfolioGroupWithHttpInfo (string scope, CreatePortfolioGroupRequest createPortfolioGroupRequest=default(CreatePortfolioGroupRequest))
	[EARLY ACCESS] Create portfolio group Create a portfolio group in a specific scope. More...

async 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 Create a portfolio group in a specific scope. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > >	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. More...

DeletedEntityResponse	DeleteGroupProperties (string scope, string code, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	[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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteGroupPropertiesWithHttpInfo (string scope, string code, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	[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. More...

async 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 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...

PortfolioGroup	DeletePortfolioFromGroup (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?))
	[EARLY ACCESS] Delete portfolio from group Remove a single portfolio from a portfolio group. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	DeletePortfolioFromGroupWithHttpInfo (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?))
	[EARLY ACCESS] Delete portfolio from group Remove a single portfolio from a portfolio group. More...

async 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 Remove a single portfolio from a portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Remove a single portfolio from a portfolio group. More...

DeletedEntityResponse	DeletePortfolioGroup (string scope, string code)
	[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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeletePortfolioGroupWithHttpInfo (string scope, string code)
	[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. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	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. More...

PortfolioGroup	DeleteSubGroupFromGroup (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?))
	[EARLY ACCESS] Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	DeleteSubGroupFromGroupWithHttpInfo (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOffset? effectiveAt=default(DateTimeOffset?))
	[EARLY ACCESS] Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group. More...

async 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 Remove a single portfolio group (sub group) from a portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Remove a single portfolio group (sub group) from a portfolio group. More...

PortfolioGroupProperties	GetGroupProperties (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get group properties List all the properties of a single portfolio group. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroupProperties >	GetGroupPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get group properties List all the properties of a single portfolio group. More...

async 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 List all the properties of a single portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the properties of a single portfolio group. More...

VersionedResourceListOfPortfolioHolding	GetHoldingsForPortfolioGroup (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?))
	[EARLY ACCESS] Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group. More...

Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfPortfolioHolding >	GetHoldingsForPortfolioGroupWithHttpInfo (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?))
	[EARLY ACCESS] Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group. More...

async 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 Get the holdings of transaction portfolios in specified portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Get the holdings of transaction portfolios in specified portfolio group. More...

PortfolioGroup	GetPortfolioGroup (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get portfolio group Retrieve the definition of a single portfolio group. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	GetPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get portfolio group Retrieve the definition of a single portfolio group. More...

async 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 Retrieve the definition of a single portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Retrieve the definition of a single portfolio group. More...

ResourceListOfProcessedCommand	GetPortfolioGroupCommands (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string filter=default(string))
	[EARLY ACCESS] Get portfolio group commands Gets all the commands that modified a single portfolio group. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfProcessedCommand >	GetPortfolioGroupCommandsWithHttpInfo (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string filter=default(string))
	[EARLY ACCESS] Get portfolio group commands Gets all the commands that modified a single portfolio group. More...

async 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 Gets all the commands that modified a single portfolio group. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Gets all the commands that modified a single portfolio group. More...

ExpandedGroup	GetPortfolioGroupExpansion (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyFilter=default(List< string >))
	[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. More...

Lusid.Sdk.Client.ApiResponse< ExpandedGroup >	GetPortfolioGroupExpansionWithHttpInfo (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyFilter=default(List< string >))
	[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. More...

async 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 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...

VersionedResourceListOfTransaction	GetTransactionsForPortfolioGroup (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))
	[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. More...

Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfTransaction >	GetTransactionsForPortfolioGroupWithHttpInfo (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))
	[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. More...

async 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 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...

ResourceListOfPortfolioGroup	ListPortfolioGroups (string scope, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string))
	[EARLY ACCESS] List portfolio groups List all the portfolio groups in a single scope. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfPortfolioGroup >	ListPortfolioGroupsWithHttpInfo (string scope, DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string))
	[EARLY ACCESS] List portfolio groups List all the portfolio groups in a single scope. More...

async 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 List all the portfolio groups in a single scope. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the portfolio groups in a single scope. More...

PortfolioGroup	UpdatePortfolioGroup (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), UpdatePortfolioGroupRequest updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest))
	[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. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroup >	UpdatePortfolioGroupWithHttpInfo (string scope, string code, DateTimeOffset? effectiveAt=default(DateTimeOffset?), UpdatePortfolioGroupRequest updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest))
	[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. More...

async 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 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...

PortfolioGroupProperties	UpsertGroupProperties (string scope, string code, Dictionary< string, Property > requestBody=default(Dictionary< string, Property >))
	[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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

Lusid.Sdk.Client.ApiResponse< PortfolioGroupProperties >	UpsertGroupPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property > requestBody=default(Dictionary< string, Property >))
	[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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

async 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 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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

Constructor & Destructor Documentation

◆ PortfolioGroupsApi() [1/4]

Lusid.Sdk.Api.PortfolioGroupsApi.PortfolioGroupsApi ( )

inline

Initializes a new instance of the PortfolioGroupsApi class.

Returns

◆ PortfolioGroupsApi() [2/4]

Lusid.Sdk.Api.PortfolioGroupsApi.PortfolioGroupsApi ( String basePath )

inline

Initializes a new instance of the PortfolioGroupsApi class.

Returns

◆ PortfolioGroupsApi() [3/4]

Lusid.Sdk.Api.PortfolioGroupsApi.PortfolioGroupsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the PortfolioGroupsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ PortfolioGroupsApi() [4/4]

Lusid.Sdk.Api.PortfolioGroupsApi.PortfolioGroupsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the PortfolioGroupsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ AddPortfolioToGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.AddPortfolioToGroup	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ AddPortfolioToGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ AddPortfolioToGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.AddPortfolioToGroupWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ AddPortfolioToGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ AddSubGroupToGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.AddSubGroupToGroup	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ AddSubGroupToGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ AddSubGroupToGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.AddSubGroupToGroupWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		ResourceId	resourceId = `default(ResourceId)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ AddSubGroupToGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ BuildTransactionsForPortfolioGroup()

VersionedResourceListOfOutputTransaction Lusid.Sdk.Api.PortfolioGroupsApi.BuildTransactionsForPortfolioGroup	(	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)`
	)

inline

[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)

Returns: VersionedResourceListOfOutputTransaction

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ BuildTransactionsForPortfolioGroupAsync()

async System.Threading.Tasks.Task<VersionedResourceListOfOutputTransaction> Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ BuildTransactionsForPortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<VersionedResourceListOfOutputTransaction> Lusid.Sdk.Api.PortfolioGroupsApi.BuildTransactionsForPortfolioGroupWithHttpInfo	(	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)`
	)

inline

[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)

Returns: ApiResponse of VersionedResourceListOfOutputTransaction

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ BuildTransactionsForPortfolioGroupWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<VersionedResourceListOfOutputTransaction> > Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ CreatePortfolioGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.CreatePortfolioGroup	(	string	scope,
		CreatePortfolioGroupRequest	createPortfolioGroupRequest = `default(CreatePortfolioGroupRequest)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ CreatePortfolioGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ CreatePortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.CreatePortfolioGroupWithHttpInfo	(	string	scope,
		CreatePortfolioGroupRequest	createPortfolioGroupRequest = `default(CreatePortfolioGroupRequest)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ CreatePortfolioGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeleteGroupProperties()

DeletedEntityResponse Lusid.Sdk.Api.PortfolioGroupsApi.DeleteGroupProperties	(	string	scope,
		string	code,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

inline

[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)

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeleteGroupPropertiesAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeleteGroupPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfolioGroupsApi.DeleteGroupPropertiesWithHttpInfo	(	string	scope,
		string	code,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

inline

[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)

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeleteGroupPropertiesWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeletePortfolioFromGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.DeletePortfolioFromGroup	(	string	scope,
		string	code,
		string	portfolioScope,
		string	portfolioCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeletePortfolioFromGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeletePortfolioFromGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.DeletePortfolioFromGroupWithHttpInfo	(	string	scope,
		string	code,
		string	portfolioScope,
		string	portfolioCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeletePortfolioFromGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeletePortfolioGroup()

DeletedEntityResponse Lusid.Sdk.Api.PortfolioGroupsApi.DeletePortfolioGroup	(	string	scope,
		string	code
	)

inline

[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.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeletePortfolioGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeletePortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfolioGroupsApi.DeletePortfolioGroupWithHttpInfo	(	string	scope,
		string	code
	)

inline

[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.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeletePortfolioGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeleteSubGroupFromGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.DeleteSubGroupFromGroup	(	string	scope,
		string	code,
		string	subgroupScope,
		string	subgroupCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeleteSubGroupFromGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ DeleteSubGroupFromGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.DeleteSubGroupFromGroupWithHttpInfo	(	string	scope,
		string	code,
		string	subgroupScope,
		string	subgroupCode,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ DeleteSubGroupFromGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetBasePath()

String Lusid.Sdk.Api.PortfolioGroupsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetGroupProperties()

PortfolioGroupProperties Lusid.Sdk.Api.PortfolioGroupsApi.GetGroupProperties	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: PortfolioGroupProperties

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetGroupPropertiesAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetGroupPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroupProperties> Lusid.Sdk.Api.PortfolioGroupsApi.GetGroupPropertiesWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroupProperties

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetGroupPropertiesWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetHoldingsForPortfolioGroup()

VersionedResourceListOfPortfolioHolding Lusid.Sdk.Api.PortfolioGroupsApi.GetHoldingsForPortfolioGroup	(	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?)`
	)

inline

[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)

Returns: VersionedResourceListOfPortfolioHolding

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetHoldingsForPortfolioGroupAsync()

async System.Threading.Tasks.Task<VersionedResourceListOfPortfolioHolding> Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetHoldingsForPortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<VersionedResourceListOfPortfolioHolding> Lusid.Sdk.Api.PortfolioGroupsApi.GetHoldingsForPortfolioGroupWithHttpInfo	(	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?)`
	)

inline

[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)

Returns: ApiResponse of VersionedResourceListOfPortfolioHolding

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetHoldingsForPortfolioGroupWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<VersionedResourceListOfPortfolioHolding> > Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetPortfolioGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.GetPortfolioGroup	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetPortfolioGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetPortfolioGroupCommands()

ResourceListOfProcessedCommand Lusid.Sdk.Api.PortfolioGroupsApi.GetPortfolioGroupCommands	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`
	)

inline

[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)

Returns: ResourceListOfProcessedCommand

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetPortfolioGroupCommandsAsync()

async System.Threading.Tasks.Task<ResourceListOfProcessedCommand> Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetPortfolioGroupCommandsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfProcessedCommand> Lusid.Sdk.Api.PortfolioGroupsApi.GetPortfolioGroupCommandsWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`
	)

inline

[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)

Returns: ApiResponse of ResourceListOfProcessedCommand

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetPortfolioGroupCommandsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfProcessedCommand> > Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetPortfolioGroupExpansion()

ExpandedGroup Lusid.Sdk.Api.PortfolioGroupsApi.GetPortfolioGroupExpansion	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyFilter = `default(List<string>)`
	)

inline

[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)

Returns: ExpandedGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetPortfolioGroupExpansionAsync()

async System.Threading.Tasks.Task<ExpandedGroup> Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetPortfolioGroupExpansionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ExpandedGroup> Lusid.Sdk.Api.PortfolioGroupsApi.GetPortfolioGroupExpansionWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyFilter = `default(List<string>)`
	)

inline

[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)

Returns: ApiResponse of ExpandedGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetPortfolioGroupExpansionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ExpandedGroup> > Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetPortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.GetPortfolioGroupWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetPortfolioGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetTransactionsForPortfolioGroup()

VersionedResourceListOfTransaction Lusid.Sdk.Api.PortfolioGroupsApi.GetTransactionsForPortfolioGroup	(	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)`
	)

inline

[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)

Returns: VersionedResourceListOfTransaction

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetTransactionsForPortfolioGroupAsync()

async System.Threading.Tasks.Task<VersionedResourceListOfTransaction> Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ GetTransactionsForPortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<VersionedResourceListOfTransaction> Lusid.Sdk.Api.PortfolioGroupsApi.GetTransactionsForPortfolioGroupWithHttpInfo	(	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)`
	)

inline

[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)

Returns: ApiResponse of VersionedResourceListOfTransaction

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ GetTransactionsForPortfolioGroupWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<VersionedResourceListOfTransaction> > Lusid.Sdk.Api.PortfolioGroupsApi.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)`
	)

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ ListPortfolioGroups()

ResourceListOfPortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.ListPortfolioGroups	(	string	scope,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`
	)

inline

[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)

Returns: ResourceListOfPortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ ListPortfolioGroupsAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ ListPortfolioGroupsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.ListPortfolioGroupsWithHttpInfo	(	string	scope,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`
	)

inline

[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)

Returns: ApiResponse of ResourceListOfPortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ ListPortfolioGroupsWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ UpdatePortfolioGroup()

PortfolioGroup Lusid.Sdk.Api.PortfolioGroupsApi.UpdatePortfolioGroup	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		UpdatePortfolioGroupRequest	updatePortfolioGroupRequest = `default(UpdatePortfolioGroupRequest)`
	)

inline

[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)

Returns: PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ UpdatePortfolioGroupAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ UpdatePortfolioGroupWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroup> Lusid.Sdk.Api.PortfolioGroupsApi.UpdatePortfolioGroupWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	effectiveAt = `default(DateTimeOffset?)`,
		UpdatePortfolioGroupRequest	updatePortfolioGroupRequest = `default(UpdatePortfolioGroupRequest)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroup

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ UpdatePortfolioGroupWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ UpsertGroupProperties()

PortfolioGroupProperties Lusid.Sdk.Api.PortfolioGroupsApi.UpsertGroupProperties	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody = `default(Dictionary<string, Property>)`
	)

inline

[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)

Returns: PortfolioGroupProperties

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ UpsertGroupPropertiesAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

◆ UpsertGroupPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioGroupProperties> Lusid.Sdk.Api.PortfolioGroupsApi.UpsertGroupPropertiesWithHttpInfo	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody = `default(Dictionary<string, Property>)`
	)

inline

[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)

Returns: ApiResponse of PortfolioGroupProperties

Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.

◆ UpsertGroupPropertiesWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.PortfolioGroupsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.PortfolioGroupsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.PortfolioGroupsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.PortfolioGroupsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PortfolioGroupsApi() [1/4]

◆ PortfolioGroupsApi() [2/4]

◆ PortfolioGroupsApi() [3/4]

◆ PortfolioGroupsApi() [4/4]

Member Function Documentation

◆ AddPortfolioToGroup()

◆ AddPortfolioToGroupAsync()

◆ AddPortfolioToGroupWithHttpInfo()

◆ AddPortfolioToGroupWithHttpInfoAsync()

◆ AddSubGroupToGroup()

◆ AddSubGroupToGroupAsync()

◆ AddSubGroupToGroupWithHttpInfo()

◆ AddSubGroupToGroupWithHttpInfoAsync()

◆ BuildTransactionsForPortfolioGroup()

◆ BuildTransactionsForPortfolioGroupAsync()

◆ BuildTransactionsForPortfolioGroupWithHttpInfo()

◆ BuildTransactionsForPortfolioGroupWithHttpInfoAsync()

◆ CreatePortfolioGroup()

◆ CreatePortfolioGroupAsync()

◆ CreatePortfolioGroupWithHttpInfo()

◆ CreatePortfolioGroupWithHttpInfoAsync()

◆ DeleteGroupProperties()

◆ DeleteGroupPropertiesAsync()

◆ DeleteGroupPropertiesWithHttpInfo()

◆ DeleteGroupPropertiesWithHttpInfoAsync()

◆ DeletePortfolioFromGroup()

◆ DeletePortfolioFromGroupAsync()

◆ DeletePortfolioFromGroupWithHttpInfo()

◆ DeletePortfolioFromGroupWithHttpInfoAsync()

◆ DeletePortfolioGroup()

◆ DeletePortfolioGroupAsync()

◆ DeletePortfolioGroupWithHttpInfo()

◆ DeletePortfolioGroupWithHttpInfoAsync()

◆ DeleteSubGroupFromGroup()

◆ DeleteSubGroupFromGroupAsync()

◆ DeleteSubGroupFromGroupWithHttpInfo()

◆ DeleteSubGroupFromGroupWithHttpInfoAsync()

◆ GetBasePath()

◆ GetGroupProperties()

◆ GetGroupPropertiesAsync()

◆ GetGroupPropertiesWithHttpInfo()

◆ GetGroupPropertiesWithHttpInfoAsync()

◆ GetHoldingsForPortfolioGroup()

◆ GetHoldingsForPortfolioGroupAsync()

◆ GetHoldingsForPortfolioGroupWithHttpInfo()

◆ GetHoldingsForPortfolioGroupWithHttpInfoAsync()

◆ GetPortfolioGroup()

◆ GetPortfolioGroupAsync()

◆ GetPortfolioGroupCommands()

◆ GetPortfolioGroupCommandsAsync()

◆ GetPortfolioGroupCommandsWithHttpInfo()

◆ GetPortfolioGroupCommandsWithHttpInfoAsync()

◆ GetPortfolioGroupExpansion()

◆ GetPortfolioGroupExpansionAsync()

◆ GetPortfolioGroupExpansionWithHttpInfo()

◆ GetPortfolioGroupExpansionWithHttpInfoAsync()

◆ GetPortfolioGroupWithHttpInfo()

◆ GetPortfolioGroupWithHttpInfoAsync()

◆ GetTransactionsForPortfolioGroup()

◆ GetTransactionsForPortfolioGroupAsync()

◆ GetTransactionsForPortfolioGroupWithHttpInfo()

◆ GetTransactionsForPortfolioGroupWithHttpInfoAsync()

◆ ListPortfolioGroups()

◆ ListPortfolioGroupsAsync()

◆ ListPortfolioGroupsWithHttpInfo()

◆ ListPortfolioGroupsWithHttpInfoAsync()

◆ UpdatePortfolioGroup()

◆ UpdatePortfolioGroupAsync()

◆ UpdatePortfolioGroupWithHttpInfo()

◆ UpdatePortfolioGroupWithHttpInfoAsync()

◆ UpsertGroupProperties()

◆ UpsertGroupPropertiesAsync()

◆ UpsertGroupPropertiesWithHttpInfo()

◆ UpsertGroupPropertiesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient