sdk.lusid.api.transaction_fees_api.TransactionFeesApi

class TransactionFeesApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

`delete_transaction_fee_rule`	[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule.
`delete_transaction_fee_rule_with_http_info`	[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule.
`get_applicable_transaction_fees`	[EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction.
`get_applicable_transaction_fees_with_http_info`	[EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction.
`get_transaction_fee_rule`	[EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule.
`get_transaction_fee_rule_with_http_info`	[EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule.
`list_transaction_fee_rules`	[EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering.
`list_transaction_fee_rules_with_http_info`	[EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering.
`upsert_transaction_fee_rules`	[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules.
`upsert_transaction_fee_rules_with_http_info`	[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules.

delete_transaction_fee_rule(code, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_transaction_fee_rule(code, async_req=True)
>>> result = thread.get()

Parameters:

code (str) – The fee rule code. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_transaction_fee_rule_with_http_info(code, **kwargs)[source]

[EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_transaction_fee_rule_with_http_info(code, async_req=True)
>>> result = thread.get()

Parameters:

code (str) – The fee rule code. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

get_applicable_transaction_fees(effective_at=None, as_at=None, instrument_identifier_type=None, instrument_identifier=None, portfolio_scope=None, portfolio_code=None, request_body=None, async_req=None, **kwargs)[source]

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

Additionally, matching can be based on the instrument’s properties, its portfolio properties, and any additional property keys present in the data file. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_applicable_transaction_fees(effective_at, as_at, instrument_identifier_type, instrument_identifier, portfolio_scope, portfolio_code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.
instrument_identifier_type (str) – Optional. The unique identifier type to use, eg ‘Figi’ or ‘LusidInstrumentId’.
instrument_identifier (str) – Optional. The Instrument Identifier to get properties for.
portfolio_scope (str) – Optional. The scope of the portfolio to fetch properties from.
portfolio_code (str) – Optional. The code of the portfolio to fetch properties from.
request_body (Dict[str, str]) – 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”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfFeeRule

get_applicable_transaction_fees_with_http_info(effective_at=None, as_at=None, instrument_identifier_type=None, instrument_identifier=None, portfolio_scope=None, portfolio_code=None, request_body=None, **kwargs)[source]

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

Additionally, matching can be based on the instrument’s properties, its portfolio properties, and any additional property keys present in the data file. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_applicable_transaction_fees_with_http_info(effective_at, as_at, instrument_identifier_type, instrument_identifier, portfolio_scope, portfolio_code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.
instrument_identifier_type (str) – Optional. The unique identifier type to use, eg ‘Figi’ or ‘LusidInstrumentId’.
instrument_identifier (str) – Optional. The Instrument Identifier to get properties for.
portfolio_scope (str) – Optional. The scope of the portfolio to fetch properties from.
portfolio_code (str) – Optional. The code of the portfolio to fetch properties from.
request_body (Dict[str, str]) – 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”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfFeeRule, status_code(int), headers(HTTPHeaderDict))

get_transaction_fee_rule(code, effective_at=None, as_at=None, async_req=None, **kwargs)[source]

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

Retrieves the fee rule definition at the given effective and as at times. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_transaction_fee_rule(code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

code (str) – The fee rule code. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

FeeRule

get_transaction_fee_rule_with_http_info(code, effective_at=None, as_at=None, **kwargs)[source]

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

Retrieves the fee rule definition at the given effective and as at times. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_transaction_fee_rule_with_http_info(code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

code (str) – The fee rule code. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(FeeRule, status_code(int), headers(HTTPHeaderDict))

list_transaction_fee_rules(effective_at=None, as_at=None, limit=None, filter=None, page=None, async_req=None, **kwargs)[source]

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

For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_transaction_fee_rules(effective_at, as_at, limit, filter, page, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results.
page (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfFeeRule

list_transaction_fee_rules_with_http_info(effective_at=None, as_at=None, limit=None, filter=None, page=None, **kwargs)[source]

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

For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_transaction_fee_rules_with_http_info(effective_at, as_at, limit, filter, page, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results.
page (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfFeeRule, status_code(int), headers(HTTPHeaderDict))

upsert_transaction_fee_rules(request_body, effective_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_transaction_fee_rules(request_body, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

request_body (Dict[str, FeeRuleUpsertRequest]) – 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. (required)
effective_at (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

FeeRuleUpsertResponse

upsert_transaction_fee_rules_with_http_info(request_body, effective_at=None, **kwargs)[source]

[EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_transaction_fee_rules_with_http_info(request_body, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

request_body (Dict[str, FeeRuleUpsertRequest]) – 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. (required)
effective_at (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(FeeRuleUpsertResponse, status_code(int), headers(HTTPHeaderDict))