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

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

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

Public Member Functions

BatchUpdateUserReviewForComparisonResultResponse BatchUpdateComparisonResults (string scope, string code, List< BatchUpdateUserReviewForComparisonResultRequest > batchUpdateUserReviewForComparisonResultRequest, string? successMode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. More...
 
Lusid.Sdk.Client.ApiResponse< BatchUpdateUserReviewForComparisonResultResponseBatchUpdateComparisonResultsWithHttpInfo (string scope, string code, List< BatchUpdateUserReviewForComparisonResultRequest > batchUpdateUserReviewForComparisonResultRequest, string? successMode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. More...
 
GroupReconciliationComparisonRuleset CreateComparisonRuleset (CreateGroupReconciliationComparisonRulesetRequest? createGroupReconciliationComparisonRulesetRequest=default(CreateGroupReconciliationComparisonRulesetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationComparisonRulesetCreateComparisonRulesetWithHttpInfo (CreateGroupReconciliationComparisonRulesetRequest? createGroupReconciliationComparisonRulesetRequest=default(CreateGroupReconciliationComparisonRulesetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset More...
 
GroupReconciliationDefinition CreateGroupReconciliationDefinition (CreateGroupReconciliationDefinitionRequest? createGroupReconciliationDefinitionRequest=default(CreateGroupReconciliationDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationDefinitionCreateGroupReconciliationDefinitionWithHttpInfo (CreateGroupReconciliationDefinitionRequest? createGroupReconciliationDefinitionRequest=default(CreateGroupReconciliationDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition More...
 
DeletedEntityResponse DeleteComparisonRuleset (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteComparisonRulesetWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset More...
 
DeletedEntityResponse DeleteGroupReconciliationDefinition (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteGroupReconciliationDefinitionWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition More...
 
GroupReconciliationComparisonResult GetComparisonResult (string scope, string code, string resultId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationComparisonResultGetComparisonResultWithHttpInfo (string scope, string code, string resultId, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. More...
 
GroupReconciliationComparisonRuleset GetComparisonRuleset (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationComparisonRulesetGetComparisonRulesetWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. More...
 
GroupReconciliationDefinition GetGroupReconciliationDefinition (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationDefinitionGetGroupReconciliationDefinitionWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition More...
 
PagedResourceListOfGroupReconciliationComparisonResult ListComparisonResults (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfGroupReconciliationComparisonResultListComparisonResultsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. More...
 
PagedResourceListOfGroupReconciliationComparisonRuleset ListComparisonRulesets (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfGroupReconciliationComparisonRulesetListComparisonRulesetsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets More...
 
PagedResourceListOfGroupReconciliationDefinition ListGroupReconciliationDefinitions (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 >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfGroupReconciliationDefinitionListGroupReconciliationDefinitionsWithHttpInfo (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 >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions More...
 
GroupReconciliationRunResponse RunReconciliation (string scope, string code, GroupReconciliationRunRequest groupReconciliationRunRequest, string? instanceRunType=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationRunResponseRunReconciliationWithHttpInfo (string scope, string code, GroupReconciliationRunRequest groupReconciliationRunRequest, string? instanceRunType=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation More...
 
GroupReconciliationComparisonRuleset UpdateComparisonRuleset (string scope, string code, UpdateGroupReconciliationComparisonRulesetRequest? updateGroupReconciliationComparisonRulesetRequest=default(UpdateGroupReconciliationComparisonRulesetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationComparisonRulesetUpdateComparisonRulesetWithHttpInfo (string scope, string code, UpdateGroupReconciliationComparisonRulesetRequest? updateGroupReconciliationComparisonRulesetRequest=default(UpdateGroupReconciliationComparisonRulesetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code More...
 
GroupReconciliationDefinition UpdateGroupReconciliationDefinition (string scope, string code, UpdateGroupReconciliationDefinitionRequest? updateGroupReconciliationDefinitionRequest=default(UpdateGroupReconciliationDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition More...
 
Lusid.Sdk.Client.ApiResponse< GroupReconciliationDefinitionUpdateGroupReconciliationDefinitionWithHttpInfo (string scope, string code, UpdateGroupReconciliationDefinitionRequest? updateGroupReconciliationDefinitionRequest=default(UpdateGroupReconciliationDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ BatchUpdateComparisonResults()

BatchUpdateUserReviewForComparisonResultResponse Lusid.Sdk.Api.IGroupReconciliationsApiSync.BatchUpdateComparisonResults ( string  scope,
string  code,
List< BatchUpdateUserReviewForComparisonResultRequest batchUpdateUserReviewForComparisonResultRequest,
string?  successMode = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition.

Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Scope and Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven&#39;t passed validation or are not related to the definition will be returned with respectful error details.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeShared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.
codeGroupReconciliationDefinitionId code.
batchUpdateUserReviewForComparisonResultRequestA collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.
successModeDefines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. &quot;Partial&quot; (default) | &quot;Atomic&quot;. (optional, default to "Partial")
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
BatchUpdateUserReviewForComparisonResultResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ BatchUpdateComparisonResultsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BatchUpdateUserReviewForComparisonResultResponse> Lusid.Sdk.Api.IGroupReconciliationsApiSync.BatchUpdateComparisonResultsWithHttpInfo ( string  scope,
string  code,
List< BatchUpdateUserReviewForComparisonResultRequest batchUpdateUserReviewForComparisonResultRequest,
string?  successMode = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition.

Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Scope and Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven&#39;t passed validation or are not related to the definition will be returned with respectful error details.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeShared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.
codeGroupReconciliationDefinitionId code.
batchUpdateUserReviewForComparisonResultRequestA collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.
successModeDefines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. &quot;Partial&quot; (default) | &quot;Atomic&quot;. (optional, default to "Partial")
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of BatchUpdateUserReviewForComparisonResultResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ CreateComparisonRuleset()

GroupReconciliationComparisonRuleset Lusid.Sdk.Api.IGroupReconciliationsApiSync.CreateComparisonRuleset ( CreateGroupReconciliationComparisonRulesetRequest createGroupReconciliationComparisonRulesetRequest = default(CreateGroupReconciliationComparisonRulesetRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset

Creates a set of core and aggregate rules to be run for a group reconciliation

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createGroupReconciliationComparisonRulesetRequestThe request containing the details of the ruleset (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ CreateComparisonRulesetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationComparisonRuleset> Lusid.Sdk.Api.IGroupReconciliationsApiSync.CreateComparisonRulesetWithHttpInfo ( CreateGroupReconciliationComparisonRulesetRequest createGroupReconciliationComparisonRulesetRequest = default(CreateGroupReconciliationComparisonRulesetRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset

Creates a set of core and aggregate rules to be run for a group reconciliation

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createGroupReconciliationComparisonRulesetRequestThe request containing the details of the ruleset (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ CreateGroupReconciliationDefinition()

GroupReconciliationDefinition Lusid.Sdk.Api.IGroupReconciliationsApiSync.CreateGroupReconciliationDefinition ( CreateGroupReconciliationDefinitionRequest createGroupReconciliationDefinitionRequest = default(CreateGroupReconciliationDefinitionRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition

Creates a Group Reconciliation Definition

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createGroupReconciliationDefinitionRequestThe definition Group Reconciliation Definition details (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ CreateGroupReconciliationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationDefinition> Lusid.Sdk.Api.IGroupReconciliationsApiSync.CreateGroupReconciliationDefinitionWithHttpInfo ( CreateGroupReconciliationDefinitionRequest createGroupReconciliationDefinitionRequest = default(CreateGroupReconciliationDefinitionRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition

Creates a Group Reconciliation Definition

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createGroupReconciliationDefinitionRequestThe definition Group Reconciliation Definition details (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ DeleteComparisonRuleset()

DeletedEntityResponse Lusid.Sdk.Api.IGroupReconciliationsApiSync.DeleteComparisonRuleset ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset

The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison ruleset.
codeThe code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ DeleteComparisonRulesetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IGroupReconciliationsApiSync.DeleteComparisonRulesetWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset

The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison ruleset.
codeThe code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ DeleteGroupReconciliationDefinition()

DeletedEntityResponse Lusid.Sdk.Api.IGroupReconciliationsApiSync.DeleteGroupReconciliationDefinition ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition

Delete the group reconciliation definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to delete.
codeThe code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ DeleteGroupReconciliationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IGroupReconciliationsApiSync.DeleteGroupReconciliationDefinitionWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition

Delete the group reconciliation definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to delete.
codeThe code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ GetComparisonResult()

GroupReconciliationComparisonResult Lusid.Sdk.Api.IGroupReconciliationsApiSync.GetComparisonResult ( string  scope,
string  code,
string  resultId,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code.

Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison result and its related reconciliation definition.
codeThe code of the reconciliation definition that was used to produce the reconciliation result.
resultIdThe code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.
asAtThe asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationComparisonResult

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ GetComparisonResultWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationComparisonResult> Lusid.Sdk.Api.IGroupReconciliationsApiSync.GetComparisonResultWithHttpInfo ( string  scope,
string  code,
string  resultId,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code.

Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison result and its related reconciliation definition.
codeThe code of the reconciliation definition that was used to produce the reconciliation result.
resultIdThe code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.
asAtThe asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationComparisonResult

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ GetComparisonRuleset()

GroupReconciliationComparisonRuleset Lusid.Sdk.Api.IGroupReconciliationsApiSync.GetComparisonRuleset ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code.

Retrieves one Group Reconciliation Comparison Ruleset by scope and code.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison ruleset.
codeThe code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.
asAtThe asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ GetComparisonRulesetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationComparisonRuleset> Lusid.Sdk.Api.IGroupReconciliationsApiSync.GetComparisonRulesetWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code.

Retrieves one Group Reconciliation Comparison Ruleset by scope and code.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison ruleset.
codeThe code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.
asAtThe asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ GetGroupReconciliationDefinition()

GroupReconciliationDefinition Lusid.Sdk.Api.IGroupReconciliationsApiSync.GetGroupReconciliationDefinition ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition

Retrieves a Group Reconciliation Definition by scope and code

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to retrieve.
codeThe code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.
effectiveAtThe effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ GetGroupReconciliationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationDefinition> Lusid.Sdk.Api.IGroupReconciliationsApiSync.GetGroupReconciliationDefinitionWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition

Retrieves a Group Reconciliation Definition by scope and code

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to retrieve.
codeThe code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.
effectiveAtThe effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ ListComparisonResults()

PagedResourceListOfGroupReconciliationComparisonResult Lusid.Sdk.Api.IGroupReconciliationsApiSync.ListComparisonResults ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
List< string >?  sortBy = default(List< string >?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results.

Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified. (optional)
pageThe pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many per page. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfGroupReconciliationComparisonResult

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ ListComparisonResultsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfGroupReconciliationComparisonResult> Lusid.Sdk.Api.IGroupReconciliationsApiSync.ListComparisonResultsWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
List< string >?  sortBy = default(List< string >?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results.

Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified. (optional)
pageThe pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many per page. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfGroupReconciliationComparisonResult

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ ListComparisonRulesets()

PagedResourceListOfGroupReconciliationComparisonRuleset Lusid.Sdk.Api.IGroupReconciliationsApiSync.ListComparisonRulesets ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
List< string >?  sortBy = default(List< string >?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets

Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified. (optional)
pageThe pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
limitWhen paginating, limit the number of returned results to this many per page. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfGroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ ListComparisonRulesetsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfGroupReconciliationComparisonRuleset> Lusid.Sdk.Api.IGroupReconciliationsApiSync.ListComparisonRulesetsWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
List< string >?  sortBy = default(List< string >?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets

Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified. (optional)
pageThe pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
limitWhen paginating, limit the number of returned results to this many per page. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfGroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ ListGroupReconciliationDefinitions()

PagedResourceListOfGroupReconciliationDefinition Lusid.Sdk.Api.IGroupReconciliationsApiSync.ListGroupReconciliationDefinitions ( 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 >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions

Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified. (optional)
pageThe pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. 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 no limit if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfGroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ ListGroupReconciliationDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfGroupReconciliationDefinition> Lusid.Sdk.Api.IGroupReconciliationsApiSync.ListGroupReconciliationDefinitionsWithHttpInfo ( 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 >?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions

Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified. (optional)
pageThe pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. 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 no limit if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfGroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ RunReconciliation()

GroupReconciliationRunResponse Lusid.Sdk.Api.IGroupReconciliationsApiSync.RunReconciliation ( string  scope,
string  code,
GroupReconciliationRunRequest  groupReconciliationRunRequest,
string?  instanceRunType = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation

Runs a Group Reconciliation using the definition specified by the Scope and Code Supports pagination.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to use for the reconciliation.
codeThe code of the group reconciliation definition to use for the reconciliation.
groupReconciliationRunRequest
instanceRunTypeThe run type of the group reconciliation run instance. Default value: Manual. Available values: Manual, WorkflowServiceTaskId. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationRunResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ RunReconciliationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationRunResponse> Lusid.Sdk.Api.IGroupReconciliationsApiSync.RunReconciliationWithHttpInfo ( string  scope,
string  code,
GroupReconciliationRunRequest  groupReconciliationRunRequest,
string?  instanceRunType = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation

Runs a Group Reconciliation using the definition specified by the Scope and Code Supports pagination.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to use for the reconciliation.
codeThe code of the group reconciliation definition to use for the reconciliation.
groupReconciliationRunRequest
instanceRunTypeThe run type of the group reconciliation run instance. Default value: Manual. Available values: Manual, WorkflowServiceTaskId. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationRunResponse

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ UpdateComparisonRuleset()

GroupReconciliationComparisonRuleset Lusid.Sdk.Api.IGroupReconciliationsApiSync.UpdateComparisonRuleset ( string  scope,
string  code,
UpdateGroupReconciliationComparisonRulesetRequest updateGroupReconciliationComparisonRulesetRequest = default(UpdateGroupReconciliationComparisonRulesetRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code

Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison ruleset.
codeThe code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.
updateGroupReconciliationComparisonRulesetRequestThe request containing the updated details of the ruleset (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ UpdateComparisonRulesetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationComparisonRuleset> Lusid.Sdk.Api.IGroupReconciliationsApiSync.UpdateComparisonRulesetWithHttpInfo ( string  scope,
string  code,
UpdateGroupReconciliationComparisonRulesetRequest updateGroupReconciliationComparisonRulesetRequest = default(UpdateGroupReconciliationComparisonRulesetRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code

Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified comparison ruleset.
codeThe code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.
updateGroupReconciliationComparisonRulesetRequestThe request containing the updated details of the ruleset (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationComparisonRuleset

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ UpdateGroupReconciliationDefinition()

GroupReconciliationDefinition Lusid.Sdk.Api.IGroupReconciliationsApiSync.UpdateGroupReconciliationDefinition ( string  scope,
string  code,
UpdateGroupReconciliationDefinitionRequest updateGroupReconciliationDefinitionRequest = default(UpdateGroupReconciliationDefinitionRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition

Update the group reconciliation definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to update the details for.
codeThe code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition.
updateGroupReconciliationDefinitionRequestThe updated group reconciliation definition. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.

◆ UpdateGroupReconciliationDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GroupReconciliationDefinition> Lusid.Sdk.Api.IGroupReconciliationsApiSync.UpdateGroupReconciliationDefinitionWithHttpInfo ( string  scope,
string  code,
UpdateGroupReconciliationDefinitionRequest updateGroupReconciliationDefinitionRequest = default(UpdateGroupReconciliationDefinitionRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition

Update the group reconciliation definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group reconciliation definition to update the details for.
codeThe code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition.
updateGroupReconciliationDefinitionRequestThe updated group reconciliation definition. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GroupReconciliationDefinition

Implemented in Lusid.Sdk.Api.GroupReconciliationsApi.


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