sdk.lusid.api.reconciliations_api.ReconciliationsApi
- class ReconciliationsApi(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] CreateScheduledReconciliation: Create a scheduled reconciliation # noqa: E501
[EXPERIMENTAL] CreateScheduledReconciliation: Create a scheduled reconciliation # noqa: E501
[EXPERIMENTAL] DeleteReconciliation: Delete scheduled reconciliation # noqa: E501
[EARLY ACCESS] DeleteReconciliationMapping: Delete a mapping # noqa: E501
[EARLY ACCESS] DeleteReconciliationMapping: Delete a mapping # noqa: E501
[EXPERIMENTAL] DeleteReconciliation: Delete scheduled reconciliation # noqa: E501
[EXPERIMENTAL] GetReconciliation: Get scheduled reconciliation # noqa: E501
[EARLY ACCESS] GetReconciliationMapping: Get a mapping # noqa: E501
[EARLY ACCESS] GetReconciliationMapping: Get a mapping # noqa: E501
[EXPERIMENTAL] GetReconciliation: Get scheduled reconciliation # noqa: E501
[EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings # noqa: E501
[EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings # noqa: E501
[EXPERIMENTAL] ListReconciliations: List scheduled reconciliations # noqa: E501
[EXPERIMENTAL] ListReconciliations: List scheduled reconciliations # noqa: E501
ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.
ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.
[EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings # noqa: E501
[EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings # noqa: E501
ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes.
ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes.
[EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation.
[EXPERIMENTAL] ReconcileTransactionsV2: Perform a Transactions Reconciliation.
[EXPERIMENTAL] ReconcileTransactionsV2: Perform a Transactions Reconciliation.
[EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation.
ReconcileValuation: Reconcile valuations performed on one or two sets of holdings using one or two configuration recipes.
ReconcileValuation: Reconcile valuations performed on one or two sets of holdings using one or two configuration recipes.
[EXPERIMENTAL] UpdateReconciliation: Update scheduled reconciliation # noqa: E501
[EXPERIMENTAL] UpdateReconciliation: Update scheduled reconciliation # noqa: E501
[EARLY ACCESS] UpsertReconciliationMapping: Create or update a mapping # noqa: E501
[EARLY ACCESS] UpsertReconciliationMapping: Create or update a mapping # noqa: E501
- create_scheduled_reconciliation(scope, create_reconciliation_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateScheduledReconciliation: Create a scheduled reconciliation # noqa: E501
Create a scheduled reconciliation for the given request # 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_scheduled_reconciliation(scope, create_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the reconciliation (required)
create_reconciliation_request (CreateReconciliationRequest) – The definition of the reconciliation
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_scheduled_reconciliation_with_http_info(scope, create_reconciliation_request=None, **kwargs)[source]
[EXPERIMENTAL] CreateScheduledReconciliation: Create a scheduled reconciliation # noqa: E501
Create a scheduled reconciliation for the given request # 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_scheduled_reconciliation_with_http_info(scope, create_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the reconciliation (required)
create_reconciliation_request (CreateReconciliationRequest) – The definition of the reconciliation
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(Reconciliation, status_code(int), headers(HTTPHeaderDict))
- delete_reconciliation(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteReconciliation: Delete scheduled reconciliation # noqa: E501
Delete the given scheduled reconciliation # 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_reconciliation(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the scheduled reconciliation (required)
code (str) – The code of the scheduled reconciliation (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_reconciliation_mapping(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteReconciliationMapping: Delete a mapping # noqa: E501
Deletes the mapping identified by the scope and code # 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_reconciliation_mapping(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the mapping. (required)
code (str) – The code fof the mapping. (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_reconciliation_mapping_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteReconciliationMapping: Delete a mapping # noqa: E501
Deletes the mapping identified by the scope and code # 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_reconciliation_mapping_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the mapping. (required)
code (str) – The code fof the mapping. (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:
- delete_reconciliation_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteReconciliation: Delete scheduled reconciliation # noqa: E501
Delete the given scheduled reconciliation # 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_reconciliation_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the scheduled reconciliation (required)
code (str) – The code of the scheduled reconciliation (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_reconciliation(scope, code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetReconciliation: Get scheduled reconciliation # noqa: E501
Get the requested scheduled reconciliation # 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_reconciliation(scope, code, effective_at, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the scheduled reconciliation (required)
code (str) – The code of the scheduled reconciliation (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the scheduled reconciliation. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the scheduled reconciliation. Defaults to returning the latest version of the reconciliation if not specified.
property_keys (List[str]) – A list of property keys from the ‘Reconciliation’ property domain to decorate onto the reconciliation. These must take the form {domain}/{scope}/{code}, for example ‘Reconciliation/Broker/Id’.
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_reconciliation_mapping(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetReconciliationMapping: Get a mapping # noqa: E501
Gets a mapping identified by the given scope and code # 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_reconciliation_mapping(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the mapping. (required)
code (str) – The code of the mapping. (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:
- get_reconciliation_mapping_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] GetReconciliationMapping: Get a mapping # noqa: E501
Gets a mapping identified by the given scope and code # 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_reconciliation_mapping_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the mapping. (required)
code (str) – The code of the mapping. (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:
- get_reconciliation_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] GetReconciliation: Get scheduled reconciliation # noqa: E501
Get the requested scheduled reconciliation # 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_reconciliation_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the scheduled reconciliation (required)
code (str) – The code of the scheduled reconciliation (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the scheduled reconciliation. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the scheduled reconciliation. Defaults to returning the latest version of the reconciliation if not specified.
property_keys (List[str]) – A list of property keys from the ‘Reconciliation’ property domain to decorate onto the reconciliation. These must take the form {domain}/{scope}/{code}, for example ‘Reconciliation/Broker/Id’.
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(Reconciliation, status_code(int), headers(HTTPHeaderDict))
- list_reconciliation_mappings(reconciliation_type=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings # noqa: E501
Lists all mappings this user is entitled to see # 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_reconciliation_mappings(reconciliation_type, async_req=True) >>> result = thread.get()
- Parameters:
reconciliation_type (str) – Optional parameter to specify which type of mappings should be returned. Defaults to Transaction if not provided.
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_reconciliation_mappings_with_http_info(reconciliation_type=None, **kwargs)[source]
[EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings # noqa: E501
Lists all mappings this user is entitled to see # 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_reconciliation_mappings_with_http_info(reconciliation_type, async_req=True) >>> result = thread.get()
- Parameters:
reconciliation_type (str) – Optional parameter to specify which type of mappings should be returned. Defaults to Transaction if not provided.
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(ResourceListOfMapping, status_code(int), headers(HTTPHeaderDict))
- list_reconciliations(effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListReconciliations: List scheduled reconciliations # noqa: E501
List all the scheduled reconciliations matching particular criteria # 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_reconciliations(effective_at, as_at, page, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the reconciliation. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the reconciliation. Defaults to returning the latest version of each reconciliation if not specified.
page (str) – The pagination token to use to continue listing reconciliations; 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.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the reconciliation type, specify “id.Code eq ‘001’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
property_keys (List[str]) – A list of property keys from the ‘Reconciliation’ domain to decorate onto each reconciliation. These must take the format {domain}/{scope}/{code}, for example ‘Reconciliation/Broker/Id’.
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_reconciliations_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] ListReconciliations: List scheduled reconciliations # noqa: E501
List all the scheduled reconciliations matching particular criteria # 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_reconciliations_with_http_info(effective_at, as_at, page, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the reconciliation. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the reconciliation. Defaults to returning the latest version of each reconciliation if not specified.
page (str) – The pagination token to use to continue listing reconciliations; 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.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the reconciliation type, specify “id.Code eq ‘001’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
property_keys (List[str]) – A list of property keys from the ‘Reconciliation’ domain to decorate onto each reconciliation. These must take the format {domain}/{scope}/{code}, for example ‘Reconciliation/Broker/Id’.
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(PagedResourceListOfReconciliation, status_code(int), headers(HTTPHeaderDict))
- reconcile_generic(reconciliation_request=None, async_req=None, **kwargs)[source]
ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes. The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings, and elision of resulting differences where they are ‘empty’ or null or zero. # noqa: E501
Perform evaluation of one or two set of holdings (a portfolio of instruments) using one or two (potentially different) configuration recipes. Produce a breakdown of the resulting differences in evaluation that can be iterated through. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_generic(reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
reconciliation_request (ReconciliationRequest) – The specifications of the inputs to the reconciliation
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:
- reconcile_generic_with_http_info(reconciliation_request=None, **kwargs)[source]
ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes. The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings, and elision of resulting differences where they are ‘empty’ or null or zero. # noqa: E501
Perform evaluation of one or two set of holdings (a portfolio of instruments) using one or two (potentially different) configuration recipes. Produce a breakdown of the resulting differences in evaluation that can be iterated through. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_generic_with_http_info(reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
reconciliation_request (ReconciliationRequest) – The specifications of the inputs to the reconciliation
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(ReconciliationResponse, status_code(int), headers(HTTPHeaderDict))
- reconcile_holdings(sort_by=None, limit=None, filter=None, portfolios_reconciliation_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings # noqa: E501
Reconcile the holdings of two portfolios. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_holdings(sort_by, limit, filter, portfolios_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the left portfolio Code, use “left.portfolioId.code eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
portfolios_reconciliation_request (PortfoliosReconciliationRequest) – The specifications of the inputs to the reconciliation
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:
- reconcile_holdings_with_http_info(sort_by=None, limit=None, filter=None, portfolios_reconciliation_request=None, **kwargs)[source]
[EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings # noqa: E501
Reconcile the holdings of two portfolios. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_holdings_with_http_info(sort_by, limit, filter, portfolios_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the left portfolio Code, use “left.portfolioId.code eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
portfolios_reconciliation_request (PortfoliosReconciliationRequest) – The specifications of the inputs to the reconciliation
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(ResourceListOfReconciliationBreak, status_code(int), headers(HTTPHeaderDict))
- reconcile_inline(inline_valuations_reconciliation_request=None, async_req=None, **kwargs)[source]
ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes. # noqa: E501
Perform valuation of one or two set of inline instruments using different one or two configuration recipes. Produce a breakdown of the resulting differences in valuation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_inline(inline_valuations_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
inline_valuations_reconciliation_request (InlineValuationsReconciliationRequest) – The specifications of the inputs to the reconciliation
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:
- reconcile_inline_with_http_info(inline_valuations_reconciliation_request=None, **kwargs)[source]
ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes. # noqa: E501
Perform valuation of one or two set of inline instruments using different one or two configuration recipes. Produce a breakdown of the resulting differences in valuation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_inline_with_http_info(inline_valuations_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
inline_valuations_reconciliation_request (InlineValuationsReconciliationRequest) – The specifications of the inputs to the reconciliation
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(ListAggregationReconciliation, status_code(int), headers(HTTPHeaderDict))
- reconcile_transactions(transaction_reconciliation_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation. # noqa: E501
Evaluates two sets of transactions to determine which transactions from each set likely match using the rules of a specified mapping. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_transactions(transaction_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
transaction_reconciliation_request (TransactionReconciliationRequest)
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:
- reconcile_transactions_v2(transaction_reconciliation_request_v2=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ReconcileTransactionsV2: Perform a Transactions Reconciliation. # noqa: E501
Evaluates two sets of transactions to determine which transactions from each set likely match using the rules of a specified mapping. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_transactions_v2(transaction_reconciliation_request_v2, async_req=True) >>> result = thread.get()
- Parameters:
transaction_reconciliation_request_v2 (TransactionReconciliationRequestV2)
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:
- reconcile_transactions_v2_with_http_info(transaction_reconciliation_request_v2=None, **kwargs)[source]
[EXPERIMENTAL] ReconcileTransactionsV2: Perform a Transactions Reconciliation. # noqa: E501
Evaluates two sets of transactions to determine which transactions from each set likely match using the rules of a specified mapping. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_transactions_v2_with_http_info(transaction_reconciliation_request_v2, async_req=True) >>> result = thread.get()
- Parameters:
transaction_reconciliation_request_v2 (TransactionReconciliationRequestV2)
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(ReconciliationResponse, status_code(int), headers(HTTPHeaderDict))
- reconcile_transactions_with_http_info(transaction_reconciliation_request=None, **kwargs)[source]
[EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation. # noqa: E501
Evaluates two sets of transactions to determine which transactions from each set likely match using the rules of a specified mapping. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_transactions_with_http_info(transaction_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
transaction_reconciliation_request (TransactionReconciliationRequest)
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(TransactionsReconciliationsResponse, status_code(int), headers(HTTPHeaderDict))
- reconcile_valuation(valuations_reconciliation_request=None, async_req=None, **kwargs)[source]
ReconcileValuation: Reconcile valuations performed on one or two sets of holdings using one or two configuration recipes. # noqa: E501
Perform valuation of one or two set of holdings using different one or two configuration recipes. Produce a breakdown of the resulting differences in valuation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_valuation(valuations_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
valuations_reconciliation_request (ValuationsReconciliationRequest) – The specifications of the inputs to the reconciliation
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:
- reconcile_valuation_with_http_info(valuations_reconciliation_request=None, **kwargs)[source]
ReconcileValuation: Reconcile valuations performed on one or two sets of holdings using one or two configuration recipes. # noqa: E501
Perform valuation of one or two set of holdings using different one or two configuration recipes. Produce a breakdown of the resulting differences in valuation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.reconcile_valuation_with_http_info(valuations_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
valuations_reconciliation_request (ValuationsReconciliationRequest) – The specifications of the inputs to the reconciliation
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(ListAggregationReconciliation, status_code(int), headers(HTTPHeaderDict))
- update_reconciliation(scope, code, update_reconciliation_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateReconciliation: Update scheduled reconciliation # noqa: E501
Update a given scheduled reconciliation # 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_reconciliation(scope, code, update_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the reconciliation to be updated (required)
code (str) – The code of the reconciliation to be updated (required)
update_reconciliation_request (UpdateReconciliationRequest) – The updated definition of the reconciliation
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_reconciliation_with_http_info(scope, code, update_reconciliation_request=None, **kwargs)[source]
[EXPERIMENTAL] UpdateReconciliation: Update scheduled reconciliation # noqa: E501
Update a given scheduled reconciliation # 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_reconciliation_with_http_info(scope, code, update_reconciliation_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the reconciliation to be updated (required)
code (str) – The code of the reconciliation to be updated (required)
update_reconciliation_request (UpdateReconciliationRequest) – The updated definition of the reconciliation
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(Reconciliation, status_code(int), headers(HTTPHeaderDict))
- upsert_reconciliation_mapping(mapping=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertReconciliationMapping: Create or update a mapping # noqa: E501
If no mapping exists with the specified scope and code will create a new one. Else will update the existing mapping # 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_reconciliation_mapping(mapping, async_req=True) >>> result = thread.get()
- Parameters:
mapping (Mapping) – The mapping to be created / updated.
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:
- upsert_reconciliation_mapping_with_http_info(mapping=None, **kwargs)[source]
[EARLY ACCESS] UpsertReconciliationMapping: Create or update a mapping # noqa: E501
If no mapping exists with the specified scope and code will create a new one. Else will update the existing mapping # 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_reconciliation_mapping_with_http_info(mapping, async_req=True) >>> result = thread.get()
- Parameters:
mapping (Mapping) – The mapping to be created / updated.
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: