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

Inheritance diagram for Lusid.Sdk.Api.ITransactionFeesApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteTransactionFeeRule (string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule. More...

ApiResponse< DeletedEntityResponse >	DeleteTransactionFeeRuleWithHttpInfo (string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule. More...

ResourceListOfFeeRule	GetApplicableTransactionFees (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentIdentifierType=default(string?), string? instrumentIdentifier=default(string?), string? portfolioScope=default(string?), string? portfolioCode=default(string?), Dictionary< string, string >? requestBody=default(Dictionary< string, string >?), int operationIndex=0)
	[EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction. More...

ApiResponse< ResourceListOfFeeRule >	GetApplicableTransactionFeesWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentIdentifierType=default(string?), string? instrumentIdentifier=default(string?), string? portfolioScope=default(string?), string? portfolioCode=default(string?), Dictionary< string, string >? requestBody=default(Dictionary< string, string >?), int operationIndex=0)
	[EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction. More...

FeeRule	GetTransactionFeeRule (string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule. More...

ApiResponse< FeeRule >	GetTransactionFeeRuleWithHttpInfo (string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule. More...

ResourceListOfFeeRule	ListTransactionFeeRules (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0)
	[EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering. More...

ApiResponse< ResourceListOfFeeRule >	ListTransactionFeeRulesWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0)
	[EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering. More...

FeeRuleUpsertResponse	UpsertTransactionFeeRules (Dictionary< string, FeeRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
	[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules. More...

ApiResponse< FeeRuleUpsertResponse >	UpsertTransactionFeeRulesWithHttpInfo (Dictionary< string, FeeRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
	[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules. More...

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

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

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

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteTransactionFeeRule()

DeletedEntityResponse Lusid.Sdk.Api.ITransactionFeesApiSync.DeleteTransactionFeeRule	(	string	code,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule.

Deletes the rule for all effective time. The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. This cannot be undone.

Exceptions

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

Parameters

code	The fee rule code.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ DeleteTransactionFeeRuleWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionFeesApiSync.DeleteTransactionFeeRuleWithHttpInfo	(	string	code,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule.

Deletes the rule for all effective time. The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. This cannot be undone.

Exceptions

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

Parameters

code	The fee rule code.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ GetApplicableTransactionFees()

ResourceListOfFeeRule Lusid.Sdk.Api.ITransactionFeesApiSync.GetApplicableTransactionFees	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	instrumentIdentifierType = `default(string?)`,
		string?	instrumentIdentifier = `default(string?)`,
		string?	portfolioScope = `default(string?)`,
		string?	portfolioCode = `default(string?)`,
		Dictionary< string, string >?	requestBody = `default(Dictionary< string, string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction.

Additionally, matching can be based on the instrument's properties, its portfolio properties, and any additional property keys present in the data file.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified. (optional)
instrumentIdentifierType	Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'. (optional)
instrumentIdentifier	Optional. The Instrument Identifier to get properties for. (optional)
portfolioScope	Optional. The scope of the portfolio to fetch properties from. (optional)
portfolioCode	Optional. The code of the portfolio to fetch properties from. (optional)
requestBody	Any other property keys or fields, including the top-level fields of the fee rule (e.g. "ExecutionBroker" and "SettlementCurrency" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. "Instrument/default/Name=exampleValue" or "AdditionalKey2=Value2". (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfFeeRule

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ GetApplicableTransactionFeesWithHttpInfo()

ApiResponse<ResourceListOfFeeRule> Lusid.Sdk.Api.ITransactionFeesApiSync.GetApplicableTransactionFeesWithHttpInfo	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	instrumentIdentifierType = `default(string?)`,
		string?	instrumentIdentifier = `default(string?)`,
		string?	portfolioScope = `default(string?)`,
		string?	portfolioCode = `default(string?)`,
		Dictionary< string, string >?	requestBody = `default(Dictionary< string, string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction.

Additionally, matching can be based on the instrument's properties, its portfolio properties, and any additional property keys present in the data file.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified. (optional)
instrumentIdentifierType	Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'. (optional)
instrumentIdentifier	Optional. The Instrument Identifier to get properties for. (optional)
portfolioScope	Optional. The scope of the portfolio to fetch properties from. (optional)
portfolioCode	Optional. The code of the portfolio to fetch properties from. (optional)
requestBody	Any other property keys or fields, including the top-level fields of the fee rule (e.g. "ExecutionBroker" and "SettlementCurrency" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. "Instrument/default/Name=exampleValue" or "AdditionalKey2=Value2". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfFeeRule

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ GetTransactionFeeRule()

FeeRule Lusid.Sdk.Api.ITransactionFeesApiSync.GetTransactionFeeRule	(	string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule.

Retrieves the fee rule definition at the given effective and as at times.

Exceptions

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

Parameters

code	The fee rule code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: FeeRule

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ GetTransactionFeeRuleWithHttpInfo()

ApiResponse<FeeRule> Lusid.Sdk.Api.ITransactionFeesApiSync.GetTransactionFeeRuleWithHttpInfo	(	string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule.

Retrieves the fee rule definition at the given effective and as at times.

Exceptions

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

Parameters

code	The fee rule code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of FeeRule

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ ListTransactionFeeRules()

ResourceListOfFeeRule Lusid.Sdk.Api.ITransactionFeesApiSync.ListTransactionFeeRules	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering.

For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. (optional)
page	The pagination token to use to continue listing entities; 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)
operationIndex	Index associated with the operation.

Returns: ResourceListOfFeeRule

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ ListTransactionFeeRulesWithHttpInfo()

ApiResponse<ResourceListOfFeeRule> Lusid.Sdk.Api.ITransactionFeesApiSync.ListTransactionFeeRulesWithHttpInfo	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering.

For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. (optional)
page	The pagination token to use to continue listing entities; 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfFeeRule

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ UpsertTransactionFeeRules()

FeeRuleUpsertResponse Lusid.Sdk.Api.ITransactionFeesApiSync.UpsertTransactionFeeRules	(	Dictionary< string, FeeRuleUpsertRequest >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules.

To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions

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

Parameters

requestBody	A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.
effectiveAt	The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndex	Index associated with the operation.

Returns: FeeRuleUpsertResponse

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

◆ UpsertTransactionFeeRulesWithHttpInfo()

ApiResponse<FeeRuleUpsertResponse> Lusid.Sdk.Api.ITransactionFeesApiSync.UpsertTransactionFeeRulesWithHttpInfo	(	Dictionary< string, FeeRuleUpsertRequest >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules.

To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions

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

Parameters

requestBody	A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.
effectiveAt	The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of FeeRuleUpsertResponse

Implemented in Lusid.Sdk.Api.TransactionFeesApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteTransactionFeeRule()

◆ DeleteTransactionFeeRuleWithHttpInfo()

◆ GetApplicableTransactionFees()

◆ GetApplicableTransactionFeesWithHttpInfo()

◆ GetTransactionFeeRule()

◆ GetTransactionFeeRuleWithHttpInfo()

◆ ListTransactionFeeRules()

◆ ListTransactionFeeRulesWithHttpInfo()

◆ UpsertTransactionFeeRules()

◆ UpsertTransactionFeeRulesWithHttpInfo()