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

Inheritance diagram for Lusid.Sdk.Api.IPortfoliosApiSync:

Public Member Functions
DeletedEntityResponse	DeletePortfolio (string scope, string code)
	Delete portfolio More...

ApiResponse< DeletedEntityResponse >	DeletePortfolioWithHttpInfo (string scope, string code)
	Delete portfolio More...

DeletedEntityResponse	DeletePortfolioProperties (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	Delete portfolio properties More...

ApiResponse< DeletedEntityResponse >	DeletePortfolioPropertiesWithHttpInfo (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	Delete portfolio properties More...

Portfolio	GetPortfolio (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >))
	Get portfolio More...

ApiResponse< Portfolio >	GetPortfolioWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >))
	Get portfolio More...

ResourceListOfProcessedCommand	GetPortfolioCommands (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string filter=default(string), string page=default(string), int? limit=default(int?))
	[EARLY ACCESS] Get portfolio commands More...

ApiResponse< ResourceListOfProcessedCommand >	GetPortfolioCommandsWithHttpInfo (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string filter=default(string), string page=default(string), int? limit=default(int?))
	[EARLY ACCESS] Get portfolio commands More...

PortfolioProperties	GetPortfolioProperties (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
	Get portfolio properties More...

ApiResponse< PortfolioProperties >	GetPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
	Get portfolio properties More...

ResourceListOfPerformanceReturn	GetPortfolioReturns (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), DateTimeOrCutLabel toEffectiveAt=default(DateTimeOrCutLabel), string period=default(string), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get Returns More...

ApiResponse< ResourceListOfPerformanceReturn >	GetPortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), DateTimeOrCutLabel toEffectiveAt=default(DateTimeOrCutLabel), string period=default(string), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get Returns More...

ResourceListOfPortfolio	ListPortfolios (DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), string query=default(string), List< string > propertyKeys=default(List< string >))
	List portfolios More...

ApiResponse< ResourceListOfPortfolio >	ListPortfoliosWithHttpInfo (DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), string query=default(string), List< string > propertyKeys=default(List< string >))
	List portfolios More...

ResourceListOfPortfolio	ListPortfoliosForScope (string scope, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >))
	List portfolios for scope More...

ApiResponse< ResourceListOfPortfolio >	ListPortfoliosForScopeWithHttpInfo (string scope, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >))
	List portfolios for scope More...

Portfolio	UpdatePortfolio (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	Update portfolio More...

ApiResponse< Portfolio >	UpdatePortfolioWithHttpInfo (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	Update portfolio More...

PortfolioProperties	UpsertPortfolioProperties (string scope, string code, Dictionary< string, Property > requestBody)
	Upsert portfolio properties More...

ApiResponse< PortfolioProperties >	UpsertPortfolioPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property > requestBody)
	Upsert portfolio properties More...

UpsertReturnsResponse	UpsertPortfolioReturns (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn)
	[EARLY ACCESS] Upsert Returns More...

ApiResponse< UpsertReturnsResponse >	UpsertPortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn)
	[EARLY ACCESS] Upsert Returns More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeletePortfolio()

DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolio	(	string	scope,
		string	code
	)

Delete portfolio

Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioProperties()

DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioProperties	(	string	scope,
		string	code,
		List< string >	propertyKeys,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

Delete portfolio properties

Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeys	The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties. (optional)

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioPropertiesWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioPropertiesWithHttpInfo	(	string	scope,
		string	code,
		List< string >	propertyKeys,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

Delete portfolio properties

Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeys	The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties. (optional)

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioWithHttpInfo	(	string	scope,
		string	code
	)

Delete portfolio

Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolio()

Portfolio Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolio	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`
	)

Get portfolio

Retrieve the definition of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto the portfolio. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)

Returns: Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioCommands()

ResourceListOfProcessedCommand Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioCommands	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`
	)

[EARLY ACCESS] Get portfolio commands

Get all the commands that modified a particular portfolio, including any input transactions.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
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 results. For example, to filter on the User ID, specify "userId.id eq 'string'". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results to this number. Defaults to 500 if not specified. (optional)

Returns: ResourceListOfProcessedCommand

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioCommandsWithHttpInfo()

ApiResponse<ResourceListOfProcessedCommand> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioCommandsWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`
	)

[EARLY ACCESS] Get portfolio commands

Get all the commands that modified a particular portfolio, including any input transactions.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
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 results. For example, to filter on the User ID, specify "userId.id eq 'string'". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results to this number. Defaults to 500 if not specified. (optional)

Returns: ApiResponse of ResourceListOfProcessedCommand

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioProperties()

PortfolioProperties Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioProperties	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

Get portfolio properties

List all the properties of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional)

Returns: PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertiesWithHttpInfo()

ApiResponse<PortfolioProperties> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioPropertiesWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

Get portfolio properties

List all the properties of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional)

Returns: ApiResponse of PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioReturns()

ResourceListOfPerformanceReturn Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioReturns	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		DateTimeOrCutLabel	fromEffectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOrCutLabel	toEffectiveAt = `default(DateTimeOrCutLabel)`,
		string	period = `default(string)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

[EARLY ACCESS] Get Returns

Get Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
fromEffectiveAt	The start date from which to get the Returns. (optional)
toEffectiveAt	The end date from which to get the Returns. (optional)
period	Show the Returns on a Daily or Monthly period. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)

Returns: ResourceListOfPerformanceReturn

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioReturnsWithHttpInfo()

ApiResponse<ResourceListOfPerformanceReturn> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioReturnsWithHttpInfo	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		DateTimeOrCutLabel	fromEffectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOrCutLabel	toEffectiveAt = `default(DateTimeOrCutLabel)`,
		string	period = `default(string)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

[EARLY ACCESS] Get Returns

Get Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
fromEffectiveAt	The start date from which to get the Returns. (optional)
toEffectiveAt	The end date from which to get the Returns. (optional)
period	Show the Returns on a Daily or Monthly period. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)

Returns: ApiResponse of ResourceListOfPerformanceReturn

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioWithHttpInfo()

ApiResponse<Portfolio> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`
	)

Get portfolio

Retrieve the definition of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto the portfolio. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)

Returns: ApiResponse of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfolios()

ResourceListOfPortfolio Lusid.Sdk.Api.IPortfoliosApiSync.ListPortfolios	(	DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		string	query = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`
	)

List portfolios

List all the portfolios matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
start	When paginating, skip this number of results. (optional)
limit	When paginating, limit the results to this number. Defaults to 65,535 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the transaction type, specify "type eq 'Transaction'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
query	Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify "instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))". (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)

Returns: ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosForScope()

ResourceListOfPortfolio Lusid.Sdk.Api.IPortfoliosApiSync.ListPortfoliosForScope	(	string	scope,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`
	)

List portfolios for scope

List all the portfolios in a particular scope.

Exceptions

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

Parameters

scope	The scope whose portfolios to list.
effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
start	When paginating, skip this number of results. (optional)
limit	When paginating, limit the results to this number. Defaults to 65,535 if not specified. (optional)
filter	Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)

Returns: ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosForScopeWithHttpInfo()

ApiResponse<ResourceListOfPortfolio> Lusid.Sdk.Api.IPortfoliosApiSync.ListPortfoliosForScopeWithHttpInfo	(	string	scope,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`
	)

List portfolios for scope

List all the portfolios in a particular scope.

Exceptions

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

Parameters

scope	The scope whose portfolios to list.
effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
start	When paginating, skip this number of results. (optional)
limit	When paginating, limit the results to this number. Defaults to 65,535 if not specified. (optional)
filter	Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)

Returns: ApiResponse of ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosWithHttpInfo()

ApiResponse<ResourceListOfPortfolio> Lusid.Sdk.Api.IPortfoliosApiSync.ListPortfoliosWithHttpInfo	(	DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		string	query = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`
	)

List portfolios

List all the portfolios matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
start	When paginating, skip this number of results. (optional)
limit	When paginating, limit the results to this number. Defaults to 65,535 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the transaction type, specify "type eq 'Transaction'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
query	Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify "instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))". (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)

Returns: ApiResponse of ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpdatePortfolio()

Portfolio Lusid.Sdk.Api.IPortfoliosApiSync.UpdatePortfolio	(	string	scope,
		string	code,
		UpdatePortfolioRequest	updatePortfolioRequest,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

Update portfolio

Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequest	The updated portfolio definition.
effectiveAt	The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)

Returns: Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpdatePortfolioWithHttpInfo()

ApiResponse<Portfolio> Lusid.Sdk.Api.IPortfoliosApiSync.UpdatePortfolioWithHttpInfo	(	string	scope,
		string	code,
		UpdatePortfolioRequest	updatePortfolioRequest,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

Update portfolio

Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequest	The updated portfolio definition.
effectiveAt	The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)

Returns: ApiResponse of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioProperties()

PortfolioProperties Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioProperties	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody
	)

Upsert portfolio properties

Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which it 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 portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBody	The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.

Returns: PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioPropertiesWithHttpInfo()

ApiResponse<PortfolioProperties> Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioPropertiesWithHttpInfo	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody
	)

Upsert portfolio properties

Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which it 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 portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBody	The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.

Returns: ApiResponse of PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioReturns()

UpsertReturnsResponse Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioReturns	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		List< PerformanceReturn >	performanceReturn
	)

[EARLY ACCESS] Upsert Returns

Update or insert returns into the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
performanceReturn	This contains the Returns which need to be upsert.

Returns: UpsertReturnsResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioReturnsWithHttpInfo()

ApiResponse<UpsertReturnsResponse> Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioReturnsWithHttpInfo	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		List< PerformanceReturn >	performanceReturn
	)

[EARLY ACCESS] Upsert Returns

Update or insert returns into the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
performanceReturn	This contains the Returns which need to be upsert.

Returns: ApiResponse of UpsertReturnsResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeletePortfolio()

◆ DeletePortfolioProperties()

◆ DeletePortfolioPropertiesWithHttpInfo()

◆ DeletePortfolioWithHttpInfo()

◆ GetPortfolio()

◆ GetPortfolioCommands()

◆ GetPortfolioCommandsWithHttpInfo()

◆ GetPortfolioProperties()

◆ GetPortfolioPropertiesWithHttpInfo()

◆ GetPortfolioReturns()

◆ GetPortfolioReturnsWithHttpInfo()

◆ GetPortfolioWithHttpInfo()

◆ ListPortfolios()

◆ ListPortfoliosForScope()

◆ ListPortfoliosForScopeWithHttpInfo()

◆ ListPortfoliosWithHttpInfo()

◆ UpdatePortfolio()

◆ UpdatePortfolioWithHttpInfo()

◆ UpsertPortfolioProperties()

◆ UpsertPortfolioPropertiesWithHttpInfo()

◆ UpsertPortfolioReturns()

◆ UpsertPortfolioReturnsWithHttpInfo()