sdk.lusid.api.funds_api.FundsApi

class FundsApi(api_client=None)

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

Do not edit the class manually.

Methods

accept_estimate_valuation_point	[EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point.
accept_estimate_valuation_point_with_http_info	[EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point.
create_fee	[EXPERIMENTAL] CreateFee: Create a Fee.
create_fee_with_http_info	[EXPERIMENTAL] CreateFee: Create a Fee.
create_fund	[EXPERIMENTAL] CreateFund: Create a Fund.
create_fund_with_http_info	[EXPERIMENTAL] CreateFund: Create a Fund.
delete_fee	[EXPERIMENTAL] DeleteFee: Delete a Fee.
delete_fee_with_http_info	[EXPERIMENTAL] DeleteFee: Delete a Fee.
delete_fund	[EXPERIMENTAL] DeleteFund: Delete a Fund.
delete_fund_with_http_info	[EXPERIMENTAL] DeleteFund: Delete a Fund.
delete_valuation_point	[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.
delete_valuation_point_with_http_info	[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.
finalise_candidate_valuation_point	[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise Candidate.
finalise_candidate_valuation_point_with_http_info	[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise Candidate.
get_fee	[EXPERIMENTAL] GetFee: Get a Fee for a specified Fund.
get_fee_properties	[EXPERIMENTAL] GetFeeProperties: Get Fee properties # noqa: E501
get_fee_properties_with_http_info	[EXPERIMENTAL] GetFeeProperties: Get Fee properties # noqa: E501
get_fee_with_http_info	[EXPERIMENTAL] GetFee: Get a Fee for a specified Fund.
get_fund	[EXPERIMENTAL] GetFund: Get a Fund.
get_fund_properties	[EXPERIMENTAL] GetFundProperties: Get Fund properties # noqa: E501
get_fund_properties_with_http_info	[EXPERIMENTAL] GetFundProperties: Get Fund properties # noqa: E501
get_fund_with_http_info	[EXPERIMENTAL] GetFund: Get a Fund.
get_valuation_point_data	[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.
get_valuation_point_data_with_http_info	[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.
get_valuation_point_journal_entry_lines	[EXPERIMENTAL] GetValuationPointJournalEntryLines: Get the Journal Entry lines for the given Fund.
get_valuation_point_journal_entry_lines_with_http_info	[EXPERIMENTAL] GetValuationPointJournalEntryLines: Get the Journal Entry lines for the given Fund.
get_valuation_point_pnl_summary	[EXPERIMENTAL] GetValuationPointPnlSummary: Get a PnL summary for the given Valuation Point in the Fund.
get_valuation_point_pnl_summary_with_http_info	[EXPERIMENTAL] GetValuationPointPnlSummary: Get a PnL summary for the given Valuation Point in the Fund.
get_valuation_point_transactions	[EXPERIMENTAL] GetValuationPointTransactions: Get the Transactions for the given Fund.
get_valuation_point_transactions_with_http_info	[EXPERIMENTAL] GetValuationPointTransactions: Get the Transactions for the given Fund.
get_valuation_point_trial_balance	[EXPERIMENTAL] GetValuationPointTrialBalance: Get Trial Balance for the given Fund.
get_valuation_point_trial_balance_with_http_info	[EXPERIMENTAL] GetValuationPointTrialBalance: Get Trial Balance for the given Fund.
list_fees	[EXPERIMENTAL] ListFees: List Fees for a specified Fund.
list_fees_with_http_info	[EXPERIMENTAL] ListFees: List Fees for a specified Fund.
list_funds	[EXPERIMENTAL] ListFunds: List Funds.
list_funds_with_http_info	[EXPERIMENTAL] ListFunds: List Funds.
list_valuation_point_overview	[EXPERIMENTAL] ListValuationPointOverview: List Valuation Points Overview for a given Fund.
list_valuation_point_overview_with_http_info	[EXPERIMENTAL] ListValuationPointOverview: List Valuation Points Overview for a given Fund.
patch_fee	[EXPERIMENTAL] PatchFee: Patch Fee.
patch_fee_with_http_info	[EXPERIMENTAL] PatchFee: Patch Fee.
patch_fund	[EXPERIMENTAL] PatchFund: Patch a Fund.
patch_fund_with_http_info	[EXPERIMENTAL] PatchFund: Patch a Fund.
set_share_class_instruments	[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.
set_share_class_instruments_with_http_info	[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.
upsert_diary_entry_type_valuation_point	[EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point.
upsert_diary_entry_type_valuation_point_with_http_info	[EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point.
upsert_fee_properties	[EXPERIMENTAL] UpsertFeeProperties: Upsert Fee properties.
upsert_fee_properties_with_http_info	[EXPERIMENTAL] UpsertFeeProperties: Upsert Fee properties.
upsert_fund_properties	[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.
upsert_fund_properties_with_http_info	[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.

accept_estimate_valuation_point(scope, code, valuation_point_data_request, async_req=None, **kwargs)

[EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point. # noqa: E501

Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the Valuation Point was last run, both Valuation Points will be returned and status will be marked as ‘Candidate’, otherwise it will be marked as ‘Final’. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.accept_estimate_valuation_point(scope, code, valuation_point_data_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Candidate or Final state. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

AcceptEstimateValuationPointResponse

accept_estimate_valuation_point_with_http_info(scope, code, valuation_point_data_request, **kwargs)

[EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point. # noqa: E501

Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the Valuation Point was last run, both Valuation Points will be returned and status will be marked as ‘Candidate’, otherwise it will be marked as ‘Final’. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.accept_estimate_valuation_point_with_http_info(scope, code, valuation_point_data_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Candidate or Final state. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(AcceptEstimateValuationPointResponse, status_code(int), headers(HTTPHeaderDict))

create_fee(scope, code, fee_request, async_req=None, **kwargs)

[EXPERIMENTAL] CreateFee: Create a Fee. # noqa: E501

Create the given Fee. # 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_fee(scope, code, fee_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_request (FeeRequest) – The Fee to create. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fee

create_fee_with_http_info(scope, code, fee_request, **kwargs)

[EXPERIMENTAL] CreateFee: Create a Fee. # noqa: E501

Create the given Fee. # 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_fee_with_http_info(scope, code, fee_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_request (FeeRequest) – The Fee to create. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fee, status_code(int), headers(HTTPHeaderDict))

create_fund(scope, fund_request, async_req=None, **kwargs)

[EXPERIMENTAL] CreateFund: Create a Fund. # noqa: E501

Create the given Fund. # 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_fund(scope, fund_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• fund_request (FundRequest) – The definition of the Fund. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fund

create_fund_with_http_info(scope, fund_request, **kwargs)

[EXPERIMENTAL] CreateFund: Create a Fund. # noqa: E501

Create the given Fund. # 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_fund_with_http_info(scope, fund_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• fund_request (FundRequest) – The definition of the Fund. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fund, status_code(int), headers(HTTPHeaderDict))

delete_fee(scope, code, fee_code, async_req=None, **kwargs)

[EXPERIMENTAL] DeleteFee: Delete a Fee. # noqa: E501

Delete the given Fee. # 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_fee(scope, code, fee_code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee to be deleted. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

DeletedEntityResponse

delete_fee_with_http_info(scope, code, fee_code, **kwargs)

[EXPERIMENTAL] DeleteFee: Delete a Fee. # noqa: E501

Delete the given Fee. # 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_fee_with_http_info(scope, code, fee_code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee to be deleted. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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))

delete_fund(scope, code, async_req=None, **kwargs)

[EXPERIMENTAL] DeleteFund: Delete a Fund. # noqa: E501

Delete the given Fund. # 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_fund(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund to be deleted. (required)

• code (str) – The code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

DeletedEntityResponse

delete_fund_with_http_info(scope, code, **kwargs)

[EXPERIMENTAL] DeleteFund: Delete a Fund. # noqa: E501

Delete the given Fund. # 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_fund_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund to be deleted. (required)

• code (str) – The code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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))

delete_valuation_point(scope, code, diary_entry_code, async_req=None, **kwargs)

[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point. # noqa: E501

Deletes the given Valuation Point. # 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_valuation_point(scope, code, diary_entry_code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund for the valuation point to be deleted. (required)

• code (str) – The code of the Fund containing the Valuation Point to be deleted. Together with the scope this uniquely identifies the Fund. (required)

• diary_entry_code (str) – The diary entry code for the valuation Point to be deleted. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

DeletedEntityResponse

delete_valuation_point_with_http_info(scope, code, diary_entry_code, **kwargs)

[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point. # noqa: E501

Deletes the given Valuation Point. # 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_valuation_point_with_http_info(scope, code, diary_entry_code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund for the valuation point to be deleted. (required)

• code (str) – The code of the Fund containing the Valuation Point to be deleted. Together with the scope this uniquely identifies the Fund. (required)

• diary_entry_code (str) – The diary entry code for the valuation Point to be deleted. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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))

finalise_candidate_valuation_point(scope, code, valuation_point_data_request, async_req=None, **kwargs)

[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise Candidate. # noqa: E501

Moves a ‘Candidate’ status Valuation Point to status ‘Final’. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.finalise_candidate_valuation_point(scope, code, valuation_point_data_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the diary entry code to mark as final. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ValuationPointDataResponse

finalise_candidate_valuation_point_with_http_info(scope, code, valuation_point_data_request, **kwargs)

[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise Candidate. # noqa: E501

Moves a ‘Candidate’ status Valuation Point to status ‘Final’. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.finalise_candidate_valuation_point_with_http_info(scope, code, valuation_point_data_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the diary entry code to mark as final. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(ValuationPointDataResponse, status_code(int), headers(HTTPHeaderDict))

get_fee(scope, code, fee_code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetFee: Get a Fee for a specified Fund. # noqa: E501

Retrieve a fee for a specified Fund # 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_fee(scope, code, fee_code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the Fee properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the Fee. Defaults to returning the latest version of the Fee if not specified.

• property_keys (List[str]) – A list of property keys from the ‘Fee’ domain to decorate onto the Fee. These must take the format {domain}/{scope}/{code}, for example ‘Fee/Account/Id’. If no properties are specified, then no properties will be returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fee

get_fee_properties(scope, code, fee_code, effective_at=None, as_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetFeeProperties: Get Fee properties # noqa: E501

Get all the properties of a single fee. # 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_fee_properties(scope, code, fee_code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee to get the properties for. (required)

• effective_at (str) – The effective datetime or cut label at which to list the Fee’s properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Fee’s properties. Defaults to return the latest version of each property if not specified.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

FeeProperties

get_fee_properties_with_http_info(scope, code, fee_code, effective_at=None, as_at=None, **kwargs)

[EXPERIMENTAL] GetFeeProperties: Get Fee properties # noqa: E501

Get all the properties of a single fee. # 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_fee_properties_with_http_info(scope, code, fee_code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee to get the properties for. (required)

• effective_at (str) – The effective datetime or cut label at which to list the Fee’s properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Fee’s properties. Defaults to return the latest version of each property 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(FeeProperties, status_code(int), headers(HTTPHeaderDict))

get_fee_with_http_info(scope, code, fee_code, effective_at=None, as_at=None, property_keys=None, **kwargs)

[EXPERIMENTAL] GetFee: Get a Fee for a specified Fund. # noqa: E501

Retrieve a fee for a specified Fund # 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_fee_with_http_info(scope, code, fee_code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the Fee properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the Fee. Defaults to returning the latest version of the Fee if not specified.

• property_keys (List[str]) – A list of property keys from the ‘Fee’ domain to decorate onto the Fee. These must take the format {domain}/{scope}/{code}, for example ‘Fee/Account/Id’. If no properties are specified, then no properties will be returned.

• 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fee, status_code(int), headers(HTTPHeaderDict))

get_fund(scope, code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetFund: Get a Fund. # noqa: E501

Retrieve the definition of a particular Fund. # 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_fund(scope, code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified.

• property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’. If no properties are specified, then no properties will be returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fund

get_fund_properties(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetFundProperties: Get Fund properties # noqa: E501

Get all the properties of a single fund. # 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_fund_properties(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund to list the properties for. (required)

• code (str) – The code of the Fund to list the properties for. Together with the scope this uniquely identifies the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to list the Fund’s properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Fund’s properties. Defaults to return the latest version of each property if not specified.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

FundProperties

get_fund_properties_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)

[EXPERIMENTAL] GetFundProperties: Get Fund properties # noqa: E501

Get all the properties of a single fund. # 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_fund_properties_with_http_info(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund to list the properties for. (required)

• code (str) – The code of the Fund to list the properties for. Together with the scope this uniquely identifies the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to list the Fund’s properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Fund’s properties. Defaults to return the latest version of each property 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(FundProperties, status_code(int), headers(HTTPHeaderDict))

get_fund_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, **kwargs)

[EXPERIMENTAL] GetFund: Get a Fund. # noqa: E501

Retrieve the definition of a particular Fund. # 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_fund_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified.

• property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’. If no properties are specified, then no properties will be returned.

• 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fund, status_code(int), headers(HTTPHeaderDict))

get_valuation_point_data(scope, code, valuation_point_data_query_parameters, as_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund. # noqa: E501

Retrieves the Valuation Point data for a date or specified Diary Entry Id. The endpoint will internally extract all ‘Assets’ and ‘Liabilities’ from the related ABOR’s Trial balance to produce a GAV. Start date will be assumed from the last ‘official’ DiaryEntry and EndDate will be as provided. # 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_valuation_point_data(scope, code, valuation_point_data_query_parameters, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the Valuation Point data (required)

• as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ValuationPointDataResponse

get_valuation_point_data_with_http_info(scope, code, valuation_point_data_query_parameters, as_at=None, **kwargs)

[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund. # noqa: E501

Retrieves the Valuation Point data for a date or specified Diary Entry Id. The endpoint will internally extract all ‘Assets’ and ‘Liabilities’ from the related ABOR’s Trial balance to produce a GAV. Start date will be assumed from the last ‘official’ DiaryEntry and EndDate will be as provided. # 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_valuation_point_data_with_http_info(scope, code, valuation_point_data_query_parameters, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the Valuation Point data (required)

• as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(ValuationPointDataResponse, status_code(int), headers(HTTPHeaderDict))

get_valuation_point_journal_entry_lines(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code=None, as_at=None, filter=None, limit=None, page=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetValuationPointJournalEntryLines: Get the Journal Entry lines for the given Fund. # noqa: E501

Gets the Journal Entry lines for the given Valuation Point for a Fund The Journal Entry lines have been generated from transactions, translated via posting rules and used in the valuation point # 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_valuation_point_journal_entry_lines(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code, as_at, filter, limit, page, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope is creating the unique identifier for the given Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the Journal Entry lines. (required)

• general_ledger_profile_code (str) – The optional code of a general ledger profile used to decorate journal entry lines with levels.

• as_at (datetime) – The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified.

• filter (str) – Expression to filter the result set.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing Journal Entry lines from a previous call to GetValuationPointJournalEntryLines.

• property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, ‘Account’, ‘LegalEntity’ or ‘CustodianAccount’ domain to decorate onto the journal entry lines.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ValuationPointResourceListOfFundJournalEntryLine

get_valuation_point_journal_entry_lines_with_http_info(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code=None, as_at=None, filter=None, limit=None, page=None, property_keys=None, **kwargs)

[EXPERIMENTAL] GetValuationPointJournalEntryLines: Get the Journal Entry lines for the given Fund. # noqa: E501

Gets the Journal Entry lines for the given Valuation Point for a Fund The Journal Entry lines have been generated from transactions, translated via posting rules and used in the valuation point # 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_valuation_point_journal_entry_lines_with_http_info(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code, as_at, filter, limit, page, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope is creating the unique identifier for the given Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the Journal Entry lines. (required)

• general_ledger_profile_code (str) – The optional code of a general ledger profile used to decorate journal entry lines with levels.

• as_at (datetime) – The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified.

• filter (str) – Expression to filter the result set.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing Journal Entry lines from a previous call to GetValuationPointJournalEntryLines.

• property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, ‘Account’, ‘LegalEntity’ or ‘CustodianAccount’ domain to decorate onto the journal entry lines.

• 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(ValuationPointResourceListOfFundJournalEntryLine, status_code(int), headers(HTTPHeaderDict))

get_valuation_point_pnl_summary(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code=None, as_at=None, filter=None, limit=None, page=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetValuationPointPnlSummary: Get a PnL summary for the given Valuation Point in the Fund. # noqa: E501

Gets the PnL Summary lines from the journal entry lines produced when calculating the valuation point. # 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_valuation_point_pnl_summary(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope is the unique identifier for the given Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The query parameters used in running the generation of the PnL summary (required)

• general_ledger_profile_code (str) – The optional code of a general ledger profile used to decorate journal entry lines with levels.

• as_at (datetime) – The asAt datetime at which to retrieve PnL summary. Defaults to returning the latest version of each transaction if not specified.

• filter (str) – “Expression to filter the result set.”

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing Trial balance from a previous call to Trial balance.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ValuationPointResourceListOfPnlJournalEntryLine

get_valuation_point_pnl_summary_with_http_info(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code=None, as_at=None, filter=None, limit=None, page=None, **kwargs)

[EXPERIMENTAL] GetValuationPointPnlSummary: Get a PnL summary for the given Valuation Point in the Fund. # noqa: E501

Gets the PnL Summary lines from the journal entry lines produced when calculating the valuation point. # 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_valuation_point_pnl_summary_with_http_info(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope is the unique identifier for the given Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The query parameters used in running the generation of the PnL summary (required)

• general_ledger_profile_code (str) – The optional code of a general ledger profile used to decorate journal entry lines with levels.

• as_at (datetime) – The asAt datetime at which to retrieve PnL summary. Defaults to returning the latest version of each transaction if not specified.

• filter (str) – “Expression to filter the result set.”

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing Trial balance from a previous call to Trial balance.

• 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(ValuationPointResourceListOfPnlJournalEntryLine, status_code(int), headers(HTTPHeaderDict))

get_valuation_point_transactions(scope, code, valuation_point_data_query_parameters, as_at=None, filter=None, limit=None, page=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetValuationPointTransactions: Get the Transactions for the given Fund. # noqa: E501

Gets the Transactions for the given Valuation Point for a Fund # 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_valuation_point_transactions(scope, code, valuation_point_data_query_parameters, as_at, filter, limit, page, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope is creating the unique identifier for the given Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the transactions. (required)

• as_at (datetime) – The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.

• filter (str) – Expression to filter the result set.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing transactions from a previous call to GetValuationPointTransactions.

• property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, ‘Account’, ‘LegalEntity’ or ‘CustodianAccount’ domain to decorate onto the journal entry lines.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ValuationPointResourceListOfAccountedTransaction

get_valuation_point_transactions_with_http_info(scope, code, valuation_point_data_query_parameters, as_at=None, filter=None, limit=None, page=None, property_keys=None, **kwargs)

[EXPERIMENTAL] GetValuationPointTransactions: Get the Transactions for the given Fund. # noqa: E501

Gets the Transactions for the given Valuation Point for a Fund # 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_valuation_point_transactions_with_http_info(scope, code, valuation_point_data_query_parameters, as_at, filter, limit, page, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope is creating the unique identifier for the given Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the transactions. (required)

• as_at (datetime) – The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.

• filter (str) – Expression to filter the result set.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing transactions from a previous call to GetValuationPointTransactions.

• property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, ‘Account’, ‘LegalEntity’ or ‘CustodianAccount’ domain to decorate onto the journal entry lines.

• 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(ValuationPointResourceListOfAccountedTransaction, status_code(int), headers(HTTPHeaderDict))

get_valuation_point_trial_balance(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code=None, as_at=None, filter=None, limit=None, page=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetValuationPointTrialBalance: Get Trial Balance for the given Fund. # noqa: E501

Gets the Trial Balance for the given Valuation Point for a Fund. The Trial Balance has been generated from transactions, translated via Posting Rules and aggregated based on a General Ledger Profile (where specified). # 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_valuation_point_trial_balance(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code, as_at, filter, limit, page, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The query parameters used in running the generation of the Trial Balance. (required)

• general_ledger_profile_code (str) – The optional code of a general ledger profile used to decorate journal entry lines with levels.

• as_at (datetime) – The asAt datetime at which to retrieve the Trial Balance. Defaults to returning the latest version if not specified.

• filter (str) – Expression to filter the results by. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• limit (int) – When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing Trial Balances. This token 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.

• property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, ‘Account’, ‘LegalEntity’ or ‘CustodianAccount’ domain to decorate onto the journal entry lines.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ValuationPointResourceListOfTrialBalance

get_valuation_point_trial_balance_with_http_info(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code=None, as_at=None, filter=None, limit=None, page=None, property_keys=None, **kwargs)

[EXPERIMENTAL] GetValuationPointTrialBalance: Get Trial Balance for the given Fund. # noqa: E501

Gets the Trial Balance for the given Valuation Point for a Fund. The Trial Balance has been generated from transactions, translated via Posting Rules and aggregated based on a General Ledger Profile (where specified). # 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_valuation_point_trial_balance_with_http_info(scope, code, valuation_point_data_query_parameters, general_ledger_profile_code, as_at, filter, limit, page, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The query parameters used in running the generation of the Trial Balance. (required)

• general_ledger_profile_code (str) – The optional code of a general ledger profile used to decorate journal entry lines with levels.

• as_at (datetime) – The asAt datetime at which to retrieve the Trial Balance. Defaults to returning the latest version if not specified.

• filter (str) – Expression to filter the results by. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• limit (int) – When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing Trial Balances. This token 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.

• property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, ‘Account’, ‘LegalEntity’ or ‘CustodianAccount’ domain to decorate onto the journal entry lines.

• 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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(ValuationPointResourceListOfTrialBalance, status_code(int), headers(HTTPHeaderDict))

list_fees(scope, code, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] ListFees: List Fees for a specified Fund. # noqa: E501

List all the Fees matching a 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_fees(scope, code, effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Fees. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Fees. Defaults to returning the latest version of each Fee if not specified.

• page (str) – The pagination token to use to continue listing fees; 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 treatment, specify “treatment eq ‘Monthly’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”

• property_keys (List[str]) – A list of property keys from the ‘Fee’ domain to decorate onto each Fee. These must take the format {domain}/{scope}/{code}, for example ‘Fee/Account/Id’.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

PagedResourceListOfFee

list_fees_with_http_info(scope, code, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)

[EXPERIMENTAL] ListFees: List Fees for a specified Fund. # noqa: E501

List all the Fees matching a 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_fees_with_http_info(scope, code, effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Fees. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Fees. Defaults to returning the latest version of each Fee if not specified.

• page (str) – The pagination token to use to continue listing fees; 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 treatment, specify “treatment eq ‘Monthly’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”

• property_keys (List[str]) – A list of property keys from the ‘Fee’ domain to decorate onto each Fee. These must take the format {domain}/{scope}/{code}, for example ‘Fee/Account/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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(PagedResourceListOfFee, status_code(int), headers(HTTPHeaderDict))

list_funds(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] ListFunds: List Funds. # noqa: E501

List all the Funds 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_funds(effective_at, as_at, page, limit, filter, sort_by, 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 Funds. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified.

• page (str) – The pagination token to use to continue listing Funds; 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 Fund type, specify “id.Code eq ‘Fund1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”

• property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

PagedResourceListOfFund

list_funds_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)

[EXPERIMENTAL] ListFunds: List Funds. # noqa: E501

List all the Funds 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_funds_with_http_info(effective_at, as_at, page, limit, filter, sort_by, 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 Funds. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified.

• page (str) – The pagination token to use to continue listing Funds; 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 Fund type, specify “id.Code eq ‘Fund1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”

• property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(PagedResourceListOfFund, status_code(int), headers(HTTPHeaderDict))

list_valuation_point_overview(scope, code, effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, async_req=None, **kwargs)

[EXPERIMENTAL] ListValuationPointOverview: List Valuation Points Overview for a given Fund. # noqa: E501

List all the Valuation Points that match the given criteria for a given Fund. # 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_valuation_point_overview(scope, code, effective_at, as_at, page, limit, filter, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the ValuationPoints. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the ValuationPoints. Defaults to returning the latest version of each ValuationPoint if not specified.

• page (str) – The pagination token to use to continue listing ValuationPoints; 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 by. For example, to filter on the NAV, specify “NAV gt 300”. 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 ‘DiaryEntry’ domain to decorate onto each ValuationPoint. These must take the format {domain}/{scope}/{code}, for example ‘DiaryEntry/ValuationPoint/Id’.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

PagedResourceListOfValuationPointOverview

list_valuation_point_overview_with_http_info(scope, code, effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, **kwargs)

[EXPERIMENTAL] ListValuationPointOverview: List Valuation Points Overview for a given Fund. # noqa: E501

List all the Valuation Points that match the given criteria for a given Fund. # 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_valuation_point_overview_with_http_info(scope, code, effective_at, as_at, page, limit, filter, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. (required)

• effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the ValuationPoints. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the ValuationPoints. Defaults to returning the latest version of each ValuationPoint if not specified.

• page (str) – The pagination token to use to continue listing ValuationPoints; 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 by. For example, to filter on the NAV, specify “NAV gt 300”. 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 ‘DiaryEntry’ domain to decorate onto each ValuationPoint. These must take the format {domain}/{scope}/{code}, for example ‘DiaryEntry/ValuationPoint/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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(PagedResourceListOfValuationPointOverview, status_code(int), headers(HTTPHeaderDict))

patch_fee(scope, code, fee_code, operation, async_req=None, **kwargs)

[EXPERIMENTAL] PatchFee: Patch Fee. # noqa: E501

Create or update certain fields for a particular Fee. The behaviour is defined by the JSON Patch specification. Currently supported fields are: EndDate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_fee(scope, code, fee_code, operation, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee. (required)

• operation (List[Operation]) – The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fee

patch_fee_with_http_info(scope, code, fee_code, operation, **kwargs)

[EXPERIMENTAL] PatchFee: Patch Fee. # noqa: E501

Create or update certain fields for a particular Fee. The behaviour is defined by the JSON Patch specification. Currently supported fields are: EndDate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_fee_with_http_info(scope, code, fee_code, operation, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee. (required)

• operation (List[Operation]) – The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fee, status_code(int), headers(HTTPHeaderDict))

patch_fund(scope, code, operation, async_req=None, **kwargs)

[EXPERIMENTAL] PatchFund: Patch a Fund. # noqa: E501

Update fields on a Fund. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, FundConfigurationId, AborId, ShareClassInstrumentScopes, ShareClassInstruments, InceptionDate, DecimalPlaces, YearEndDate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_fund(scope, code, operation, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• operation (List[Operation]) – The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fund

patch_fund_with_http_info(scope, code, operation, **kwargs)

[EXPERIMENTAL] PatchFund: Patch a Fund. # noqa: E501

Update fields on a Fund. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, FundConfigurationId, AborId, ShareClassInstrumentScopes, ShareClassInstruments, InceptionDate, DecimalPlaces, YearEndDate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_fund_with_http_info(scope, code, operation, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• operation (List[Operation]) – The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fund, status_code(int), headers(HTTPHeaderDict))

set_share_class_instruments(scope, code, set_share_class_instruments_request, async_req=None, **kwargs)

[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund. # noqa: E501

Update the ShareClass Instruments on an existing fund with the set of instruments provided. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_share_class_instruments(scope, code, set_share_class_instruments_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. (required)

• set_share_class_instruments_request (SetShareClassInstrumentsRequest) – The scopes and instrument identifiers for the instruments to be set. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Fund

set_share_class_instruments_with_http_info(scope, code, set_share_class_instruments_request, **kwargs)

[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund. # noqa: E501

Update the ShareClass Instruments on an existing fund with the set of instruments provided. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_share_class_instruments_with_http_info(scope, code, set_share_class_instruments_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. (required)

• set_share_class_instruments_request (SetShareClassInstrumentsRequest) – The scopes and instrument identifiers for the instruments to be set. (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(Fund, status_code(int), headers(HTTPHeaderDict))

upsert_diary_entry_type_valuation_point(scope, code, upsert_valuation_point_request, async_req=None, **kwargs)

[EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point. # noqa: E501

Update or insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. If the Valuation Point already exists and is in estimate state, the Valuation Point will be updated with the newly specified information in this 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.upsert_diary_entry_type_valuation_point(scope, code, upsert_valuation_point_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• upsert_valuation_point_request (UpsertValuationPointRequest) – The Valuation Point Estimate definition to Upsert (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

DiaryEntry

upsert_diary_entry_type_valuation_point_with_http_info(scope, code, upsert_valuation_point_request, **kwargs)

[EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point. # noqa: E501

Update or insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. If the Valuation Point already exists and is in estimate state, the Valuation Point will be updated with the newly specified information in this 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.upsert_diary_entry_type_valuation_point_with_http_info(scope, code, upsert_valuation_point_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• upsert_valuation_point_request (UpsertValuationPointRequest) – The Valuation Point Estimate definition to Upsert (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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(DiaryEntry, status_code(int), headers(HTTPHeaderDict))

upsert_fee_properties(scope, code, fee_code, request_body=None, async_req=None, **kwargs)

[EXPERIMENTAL] UpsertFeeProperties: Upsert Fee properties. # noqa: E501

Update or insert one or more properties onto a single Fee. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Fee’. Upserting a property that exists for an Fee, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # 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_fee_properties(scope, code, fee_code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee to update or insert the properties onto. (required)

• request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Fee. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Fee/Manager/Id”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

FeeProperties

upsert_fee_properties_with_http_info(scope, code, fee_code, request_body=None, **kwargs)

[EXPERIMENTAL] UpsertFeeProperties: Upsert Fee properties. # noqa: E501

Update or insert one or more properties onto a single Fee. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Fee’. Upserting a property that exists for an Fee, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # 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_fee_properties_with_http_info(scope, code, fee_code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund. (required)

• code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)

• fee_code (str) – The code of the Fee to update or insert the properties onto. (required)

• request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Fee. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Fee/Manager/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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(FeeProperties, status_code(int), headers(HTTPHeaderDict))

upsert_fund_properties(scope, code, request_body=None, async_req=None, **kwargs)

[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties. # noqa: E501

Update or insert one or more properties onto a single Fund. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Fund’. Upserting a property that exists for an Fund, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # 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_fund_properties(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund to update or insert the properties onto. (required)

• code (str) – The code of the Fund to update or insert the properties onto. Together with the scope this uniquely identifies the Fund. (required)

• request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Fund/Manager/Id”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – Timeout setting. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

FundProperties

upsert_fund_properties_with_http_info(scope, code, request_body=None, **kwargs)

[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties. # noqa: E501

Update or insert one or more properties onto a single Fund. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Fund’. Upserting a property that exists for an Fund, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # 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_fund_properties_with_http_info(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Fund to update or insert the properties onto. (required)

• code (str) – The code of the Fund to update or insert the properties onto. Together with the scope this uniquely identifies the Fund. (required)

• request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Fund/Manager/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. Do not use - use the opts parameter instead

• opts (ConfigurationOptions, optional) – Configuration options for this request

• _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(FundProperties, status_code(int), headers(HTTPHeaderDict))