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

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

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

Public Member Functions

DeletedEntityResponse DeleteInvestmentAccount (string identifierType, string identifierValue, string scope, string identifierScope, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteInvestmentAccount: Delete Investment Account More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteInvestmentAccountWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteInvestmentAccount: Delete Investment Account More...
 
DeletedEntityResponse DeleteInvestmentAccountAccessMetadata (string identifierType, string identifierValue, string metadataKey, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteInvestmentAccountAccessMetadata: Delete an Investment Account Access Metadata entry. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteInvestmentAccountAccessMetadataWithHttpInfo (string identifierType, string identifierValue, string metadataKey, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteInvestmentAccountAccessMetadata: Delete an Investment Account Access Metadata entry. More...
 
Dictionary< string, List< AccessMetadataValue > > GetAllInvestmentAccountAccessMetadata (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetAllInvestmentAccountAccessMetadata: Get Access Metadata rules for an Investment Account. More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > GetAllInvestmentAccountAccessMetadataWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetAllInvestmentAccountAccessMetadata: Get Access Metadata rules for an Investment Account. More...
 
InvestmentAccount GetInvestmentAccount (string identifierType, string identifierValue, string scope, string identifierScope, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetInvestmentAccount: Get Investment Account More...
 
Lusid.Sdk.Client.ApiResponse< InvestmentAccountGetInvestmentAccountWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetInvestmentAccount: Get Investment Account More...
 
ResourceListOfRelationship GetInvestmentAccountRelationships (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetInvestmentAccountRelationships: Get Investment Account relationships More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationshipGetInvestmentAccountRelationshipsWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetInvestmentAccountRelationships: Get Investment Account relationships More...
 
ResourceListOfInvestmentAccount ListAllInvestmentAccounts (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListAllInvestmentAccounts: List Investment Accounts More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfInvestmentAccountListAllInvestmentAccountsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListAllInvestmentAccounts: List Investment Accounts More...
 
Dictionary< string, List< AccessMetadataValue > > PatchInvestmentAccountAccessMetadata (string identifierType, string identifierValue, string scope, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] PatchInvestmentAccountAccessMetadata: Patch Access Metadata rules for an Investment Account. More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > PatchInvestmentAccountAccessMetadataWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] PatchInvestmentAccountAccessMetadata: Patch Access Metadata rules for an Investment Account. More...
 
UpsertInvestmentAccountsResponse UpsertInvestmentAccounts (string successMode, Dictionary< string, UpsertInvestmentAccountRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpsertInvestmentAccounts: Upsert Investment Accounts More...
 
Lusid.Sdk.Client.ApiResponse< UpsertInvestmentAccountsResponseUpsertInvestmentAccountsWithHttpInfo (string successMode, Dictionary< string, UpsertInvestmentAccountRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpsertInvestmentAccounts: Upsert Investment Accounts More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteInvestmentAccount()

DeletedEntityResponse Lusid.Sdk.Api.IInvestmentAccountsApiSync.DeleteInvestmentAccount ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteInvestmentAccount: Delete Investment Account

Delete an investment account. Deletion will be valid from the investment account&#39;s creation datetime. This means that the investment account will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ DeleteInvestmentAccountAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.IInvestmentAccountsApiSync.DeleteInvestmentAccountAccessMetadata ( string  identifierType,
string  identifierValue,
string  metadataKey,
string  scope,
string  identifierScope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteInvestmentAccountAccessMetadata: Delete an Investment Account Access Metadata entry.

Deletes the Investment Account Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to delete
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ DeleteInvestmentAccountAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IInvestmentAccountsApiSync.DeleteInvestmentAccountAccessMetadataWithHttpInfo ( string  identifierType,
string  identifierValue,
string  metadataKey,
string  scope,
string  identifierScope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteInvestmentAccountAccessMetadata: Delete an Investment Account Access Metadata entry.

Deletes the Investment Account Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to delete
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ DeleteInvestmentAccountWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IInvestmentAccountsApiSync.DeleteInvestmentAccountWithHttpInfo ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteInvestmentAccount: Delete Investment Account

Delete an investment account. Deletion will be valid from the investment account&#39;s creation datetime. This means that the investment account will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ GetAllInvestmentAccountAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IInvestmentAccountsApiSync.GetAllInvestmentAccountAccessMetadata ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetAllInvestmentAccountAccessMetadata: Get Access Metadata rules for an Investment Account.

Pass the Scope and Code of the Investment Account identifier along with the identifier value parameter to retrieve the associated Access Metadata.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ GetAllInvestmentAccountAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IInvestmentAccountsApiSync.GetAllInvestmentAccountAccessMetadataWithHttpInfo ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetAllInvestmentAccountAccessMetadata: Get Access Metadata rules for an Investment Account.

Pass the Scope and Code of the Investment Account identifier along with the identifier value parameter to retrieve the associated Access Metadata.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ GetInvestmentAccount()

InvestmentAccount Lusid.Sdk.Api.IInvestmentAccountsApiSync.GetInvestmentAccount ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
List< string >?  propertyKeys = default(List< string >?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetInvestmentAccount: Get Investment Account

Retrieve the definition of an investment account.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;InvestmentAccount&quot; domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;InvestmentAccount/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
InvestmentAccount

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ GetInvestmentAccountRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.IInvestmentAccountsApiSync.GetInvestmentAccountRelationships ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] GetInvestmentAccountRelationships: Get Investment Account relationships

Get relationships for a particular Investment Account.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ GetInvestmentAccountRelationshipsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.IInvestmentAccountsApiSync.GetInvestmentAccountRelationshipsWithHttpInfo ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EARLY ACCESS] GetInvestmentAccountRelationships: Get Investment Account relationships

Get relationships for a particular Investment Account.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ GetInvestmentAccountWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<InvestmentAccount> Lusid.Sdk.Api.IInvestmentAccountsApiSync.GetInvestmentAccountWithHttpInfo ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
List< string >?  propertyKeys = default(List< string >?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetInvestmentAccount: Get Investment Account

Retrieve the definition of an investment account.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;InvestmentAccount&quot; domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;InvestmentAccount/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of InvestmentAccount

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ ListAllInvestmentAccounts()

ResourceListOfInvestmentAccount Lusid.Sdk.Api.IInvestmentAccountsApiSync.ListAllInvestmentAccounts ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
List< string >?  relationshipDefinitionIds = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListAllInvestmentAccounts: List Investment Accounts

List all investment accounts which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the investment accounts. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the investment accounts. Defaults to return the latest version of each investment accounts if not specified. (optional)
pageThe pagination token to use to continue listing investment accounts from a previous call to list investment accounts. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;InvestmentAccount&quot; domain to include for each investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;InvestmentAccount/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfInvestmentAccount

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ ListAllInvestmentAccountsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfInvestmentAccount> Lusid.Sdk.Api.IInvestmentAccountsApiSync.ListAllInvestmentAccountsWithHttpInfo ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
List< string >?  relationshipDefinitionIds = default(List< string >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListAllInvestmentAccounts: List Investment Accounts

List all investment accounts which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the investment accounts. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the investment accounts. Defaults to return the latest version of each investment accounts if not specified. (optional)
pageThe pagination token to use to continue listing investment accounts from a previous call to list investment accounts. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;InvestmentAccount&quot; domain to include for each investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;InvestmentAccount/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfInvestmentAccount

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ PatchInvestmentAccountAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IInvestmentAccountsApiSync.PatchInvestmentAccountAccessMetadata ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] PatchInvestmentAccountAccessMetadata: Patch Access Metadata rules for an Investment Account.

Patch Investment Account Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Investment Account Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ PatchInvestmentAccountAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IInvestmentAccountsApiSync.PatchInvestmentAccountAccessMetadataWithHttpInfo ( string  identifierType,
string  identifierValue,
string  scope,
string  identifierScope,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] PatchInvestmentAccountAccessMetadata: Patch Access Metadata rules for an Investment Account.

Patch Investment Account Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Investment Account Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
identifierTypeCode of the investment account identifier type.
identifierValueCode of the investment account under specified identifier type&#39;s scope and code.
scopeThe scope of the investment account entity.
identifierScopeScope of the investment account identifier type.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ UpsertInvestmentAccounts()

UpsertInvestmentAccountsResponse Lusid.Sdk.Api.IInvestmentAccountsApiSync.UpsertInvestmentAccounts ( string  successMode,
Dictionary< string, UpsertInvestmentAccountRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpsertInvestmentAccounts: Upsert Investment Accounts

Creates or updates a collection of Investment Accounts

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Investment Accounts.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpsertInvestmentAccountsResponse

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.

◆ UpsertInvestmentAccountsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertInvestmentAccountsResponse> Lusid.Sdk.Api.IInvestmentAccountsApiSync.UpsertInvestmentAccountsWithHttpInfo ( string  successMode,
Dictionary< string, UpsertInvestmentAccountRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpsertInvestmentAccounts: Upsert Investment Accounts

Creates or updates a collection of Investment Accounts

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Investment Accounts.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpsertInvestmentAccountsResponse

Implemented in Lusid.Sdk.Api.InvestmentAccountsApi.


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