sdk.lusid.api.tax_rule_sets_api.TaxRuleSetsApi
- class TaxRuleSetsApi(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
[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set.
[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set.
[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set.
[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set.
[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set.
[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set.
[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets.
[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets.
[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set.
[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set.
- create_tax_rule_set(create_tax_rule_set_request, effective_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. # noqa: E501
Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_tax_rule_set(create_tax_rule_set_request, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
create_tax_rule_set_request (CreateTaxRuleSetRequest) – The contents of the rule set. (required)
effective_at (str) – The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime 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:
- create_tax_rule_set_with_http_info(create_tax_rule_set_request, effective_at=None, **kwargs)[source]
[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. # noqa: E501
Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_tax_rule_set_with_http_info(create_tax_rule_set_request, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
create_tax_rule_set_request (CreateTaxRuleSetRequest) – The contents of the rule set. (required)
effective_at (str) – The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime 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(TaxRuleSet, status_code(int), headers(HTTPHeaderDict))
- delete_tax_rule_set(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. # noqa: E501
<br> Deletes the rule set for all effective time. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> 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_tax_rule_set(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set 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:
- delete_tax_rule_set_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. # noqa: E501
<br> Deletes the rule set for all effective time. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> 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_tax_rule_set_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set 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_tax_rule_set(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. # noqa: E501
Retrieves the tax rule set 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_tax_rule_set(scope, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set 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:
- get_tax_rule_set_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. # noqa: E501
Retrieves the tax rule set 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_tax_rule_set_with_http_info(scope, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set 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(TaxRuleSet, status_code(int), headers(HTTPHeaderDict))
- list_tax_rule_sets(effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. # noqa: E501
Retrieves all tax rule set definitions 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.list_tax_rule_sets(effective_at, as_at, 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.
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:
- list_tax_rule_sets_with_http_info(effective_at=None, as_at=None, **kwargs)[source]
[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. # noqa: E501
Retrieves all tax rule set definitions 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.list_tax_rule_sets_with_http_info(effective_at, as_at, 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.
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(ResourceListOfTaxRuleSet, status_code(int), headers(HTTPHeaderDict))
- update_tax_rule_set(scope, code, update_tax_rule_set_request, effective_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. # noqa: E501
Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. 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. The user must be entitled to read any properties specified in each rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_tax_rule_set(scope, code, update_tax_rule_set_request, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (required)
update_tax_rule_set_request (UpdateTaxRuleSetRequest) – The contents of the rule set. (required)
effective_at (str) – The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime 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:
- update_tax_rule_set_with_http_info(scope, code, update_tax_rule_set_request, effective_at=None, **kwargs)[source]
[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. # noqa: E501
Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. 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. The user must be entitled to read any properties specified in each rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_tax_rule_set_with_http_info(scope, code, update_tax_rule_set_request, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (required)
update_tax_rule_set_request (UpdateTaxRuleSetRequest) – The contents of the rule set. (required)
effective_at (str) – The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime 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(TaxRuleSet, status_code(int), headers(HTTPHeaderDict))