|
LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...

Public Member Functions | |
| AborConfiguration | CreateAborConfiguration (string scope, AborConfigurationRequest aborConfigurationRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. More... | |
| Lusid.Sdk.Client.ApiResponse< AborConfiguration > | CreateAborConfigurationWithHttpInfo (string scope, AborConfigurationRequest aborConfigurationRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. More... | |
| DeletedEntityResponse | DeleteAborConfiguration (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. More... | |
| Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteAborConfigurationWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. More... | |
| AborConfiguration | GetAborConfiguration (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. More... | |
| Lusid.Sdk.Client.ApiResponse< AborConfiguration > | GetAborConfigurationWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. More... | |
| AborConfigurationProperties | GetAborConfigurationProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] GetAborConfigurationProperties: Get Abor Configuration properties More... | |
| Lusid.Sdk.Client.ApiResponse< AborConfigurationProperties > | GetAborConfigurationPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] GetAborConfigurationProperties: Get Abor Configuration properties More... | |
| PagedResourceListOfAborConfiguration | ListAborConfigurations (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 >?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. More... | |
| Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAborConfiguration > | ListAborConfigurationsWithHttpInfo (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 >?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. More... | |
| AborConfiguration | PatchAborConfiguration (string scope, string code, List< Operation > operation, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] PatchAborConfiguration: Patch Abor Configuration. More... | |
| Lusid.Sdk.Client.ApiResponse< AborConfiguration > | PatchAborConfigurationWithHttpInfo (string scope, string code, List< Operation > operation, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] PatchAborConfiguration: Patch Abor Configuration. More... | |
| AborConfigurationProperties | UpsertAborConfigurationProperties (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties More... | |
| Lusid.Sdk.Client.ApiResponse< AborConfigurationProperties > | UpsertAborConfigurationPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties More... | |
Represents a collection of functions to interact with the API endpoints
| AborConfiguration Lusid.Sdk.Api.IAborConfigurationApiSync.CreateAborConfiguration | ( | string | scope, |
| AborConfigurationRequest | aborConfigurationRequest, | ||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration.
Create the given AborConfiguration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration. |
| aborConfigurationRequest | The definition of the AborConfiguration. |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<AborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiSync.CreateAborConfigurationWithHttpInfo | ( | string | scope, |
| AborConfigurationRequest | aborConfigurationRequest, | ||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration.
Create the given AborConfiguration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration. |
| aborConfigurationRequest | The definition of the AborConfiguration. |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| DeletedEntityResponse Lusid.Sdk.Api.IAborConfigurationApiSync.DeleteAborConfiguration | ( | string | scope, |
| string | code, | ||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.
Delete the given AborConfiguration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration to be deleted. |
| code | The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration. |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IAborConfigurationApiSync.DeleteAborConfigurationWithHttpInfo | ( | string | scope, |
| string | code, | ||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.
Delete the given AborConfiguration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration to be deleted. |
| code | The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration. |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| AborConfiguration Lusid.Sdk.Api.IAborConfigurationApiSync.GetAborConfiguration | ( | string | scope, |
| string | code, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| List< string >? | propertyKeys = default(List< string >?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.
Retrieve the definition of a particular AborConfiguration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration. |
| code | The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. |
| effectiveAt | The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified. (optional) |
| asAt | The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified. (optional) |
| propertyKeys | A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned. (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| AborConfigurationProperties Lusid.Sdk.Api.IAborConfigurationApiSync.GetAborConfigurationProperties | ( | string | scope, |
| string | code, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] GetAborConfigurationProperties: Get Abor Configuration properties
Get all the properties of a single abor Configuration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the Abor Configuration to list the properties for. |
| code | The code of the Abor Configuration to list the properties for. Together with the scope this uniquely identifies the Abor Configuration. |
| effectiveAt | The effective datetime or cut label at which to list the Abor Configuration's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
| asAt | The asAt datetime at which to list the Abor Configuration's properties. Defaults to return the latest version of each property if not specified. (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<AborConfigurationProperties> Lusid.Sdk.Api.IAborConfigurationApiSync.GetAborConfigurationPropertiesWithHttpInfo | ( | string | scope, |
| string | code, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] GetAborConfigurationProperties: Get Abor Configuration properties
Get all the properties of a single abor Configuration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the Abor Configuration to list the properties for. |
| code | The code of the Abor Configuration to list the properties for. Together with the scope this uniquely identifies the Abor Configuration. |
| effectiveAt | The effective datetime or cut label at which to list the Abor Configuration's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
| asAt | The asAt datetime at which to list the Abor Configuration's properties. Defaults to return the latest version of each property if not specified. (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<AborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiSync.GetAborConfigurationWithHttpInfo | ( | string | scope, |
| string | code, | ||
| DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?), |
||
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| List< string >? | propertyKeys = default(List< string >?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.
Retrieve the definition of a particular AborConfiguration.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration. |
| code | The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. |
| effectiveAt | The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified. (optional) |
| asAt | The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified. (optional) |
| propertyKeys | A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned. (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| PagedResourceListOfAborConfiguration Lusid.Sdk.Api.IAborConfigurationApiSync.ListAborConfigurations | ( | 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 >?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.
List all the AborConfiguration matching particular criteria.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| effectiveAt | The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified. (optional) |
| asAt | The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AborConfiguration if not specified. (optional) |
| page | The pagination token to use to continue listing AborConfiguration; 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. (optional) |
| limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
| filter | Expression to filter the results. For example, to filter on the AborConfiguration type, specify "id.Code eq 'AborConfiguration1'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
| sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
| propertyKeys | A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiSync.ListAborConfigurationsWithHttpInfo | ( | 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 >?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.
List all the AborConfiguration matching particular criteria.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| effectiveAt | The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified. (optional) |
| asAt | The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AborConfiguration if not specified. (optional) |
| page | The pagination token to use to continue listing AborConfiguration; 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. (optional) |
| limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
| filter | Expression to filter the results. For example, to filter on the AborConfiguration type, specify "id.Code eq 'AborConfiguration1'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
| sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
| propertyKeys | A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| AborConfiguration Lusid.Sdk.Api.IAborConfigurationApiSync.PatchAborConfiguration | ( | string | scope, |
| string | code, | ||
| List< Operation > | operation, | ||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] PatchAborConfiguration: Patch Abor Configuration.
Create or update certain fields for a particular AborConfiguration. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, PostingModuleCodes, CleardownModuleCodes.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration. |
| code | The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. |
| operation | The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<AborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiSync.PatchAborConfigurationWithHttpInfo | ( | string | scope, |
| string | code, | ||
| List< Operation > | operation, | ||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] PatchAborConfiguration: Patch Abor Configuration.
Create or update certain fields for a particular AborConfiguration. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, PostingModuleCodes, CleardownModuleCodes.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration. |
| code | The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. |
| operation | The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| AborConfigurationProperties Lusid.Sdk.Api.IAborConfigurationApiSync.UpsertAborConfigurationProperties | ( | string | scope, |
| string | code, | ||
| Dictionary< string, Property >? | requestBody = default(Dictionary< string, Property >?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'AborConfiguration'. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration to update or insert the properties onto. |
| code | The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. |
| requestBody | The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "AborConfiguration/Manager/Id". (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.
| Lusid.Sdk.Client.ApiResponse<AborConfigurationProperties> Lusid.Sdk.Api.IAborConfigurationApiSync.UpsertAborConfigurationPropertiesWithHttpInfo | ( | string | scope, |
| string | code, | ||
| Dictionary< string, Property >? | requestBody = default(Dictionary< string, Property >?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'AborConfiguration'. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.
| Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
| scope | The scope of the AborConfiguration to update or insert the properties onto. |
| code | The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. |
| requestBody | The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "AborConfiguration/Manager/Id". (optional) |
| operationIndex | Index associated with the operation. |
| opts | Options for this request. |
Implemented in Lusid.Sdk.Api.AborConfigurationApi.