sdk.lusid.api.funds_api.FundsApi

class FundsApi(api_client=None)[source]

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

Do not edit the class manually.

Methods

`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.
`add_allocation_groups`	[EXPERIMENTAL] AddAllocationGroups: Add Allocation Groups to a Fund.
`add_allocation_groups_with_http_info`	[EXPERIMENTAL] AddAllocationGroups: Add Allocation Groups to a Fund.
`add_series`	[EXPERIMENTAL] AddSeries: Add Series to a Fund.
`add_series_with_http_info`	[EXPERIMENTAL] AddSeries: Add Series to a Fund.
`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_v2`	[EXPERIMENTAL] CreateFundV2: Create a Fund V2 (Preview).
`create_fund_v2_with_http_info`	[EXPERIMENTAL] CreateFundV2: Create a Fund V2 (Preview).
`create_fund_with_http_info`	[EXPERIMENTAL] CreateFund: Create a Fund.
`create_valuation_point`	[EXPERIMENTAL] CreateValuationPoint: Create a Valuation Point.
`create_valuation_point_with_http_info`	[EXPERIMENTAL] CreateValuationPoint: Create a Valuation Point.
`deactivate_nav_types`	[EXPERIMENTAL] DeactivateNavTypes: Deactivate NAV types on a Fund.
`deactivate_nav_types_with_http_info`	[EXPERIMENTAL] DeactivateNavTypes: Deactivate NAV types on a Fund.
`delete_bookmark`	[EXPERIMENTAL] DeleteBookmark: Delete a Bookmark.
`delete_bookmark_with_http_info`	[EXPERIMENTAL] DeleteBookmark: Delete a Bookmark.
`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_nav_activity_adjustments`	[EXPERIMENTAL] DeleteNavActivityAdjustments: Delete Nav activity adjustments.
`delete_nav_activity_adjustments_with_http_info`	[EXPERIMENTAL] DeleteNavActivityAdjustments: Delete Nav activity adjustments.
`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 a Candidate Valuation Point.
`finalise_candidate_valuation_point_with_http_info`	[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise a Candidate Valuation Point.
`get_a2_b_data_for_fund`	[EXPERIMENTAL] GetA2BDataForFund: Get A2B data for a Fund.
`get_a2_b_data_for_fund_with_http_info`	[EXPERIMENTAL] GetA2BDataForFund: Get A2B data for a Fund.
`get_a2_b_movements_for_fund`	[EXPERIMENTAL] GetA2BMovementsForFund: Get A2B movements for transaction portfolios in a Fund.
`get_a2_b_movements_for_fund_with_http_info`	[EXPERIMENTAL] GetA2BMovementsForFund: Get A2B movements for transaction portfolios in a Fund.
`get_fee`	[EXPERIMENTAL] GetFee: Get a Fee for a specified Fund.
`get_fee_properties`	[EXPERIMENTAL] GetFeeProperties: Get Fee properties.
`get_fee_properties_with_http_info`	[EXPERIMENTAL] GetFeeProperties: Get Fee properties.
`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.
`get_fund_properties_with_http_info`	[EXPERIMENTAL] GetFundProperties: Get Fund properties.
`get_fund_with_http_info`	[EXPERIMENTAL] GetFund: Get a Fund.
`get_holding_contributors_for_fund`	[EXPERIMENTAL] GetHoldingContributorsForFund: Get holdings contributors for transaction portfolios in a Fund.
`get_holding_contributors_for_fund_with_http_info`	[EXPERIMENTAL] GetHoldingContributorsForFund: Get holdings contributors for transaction portfolios in a Fund.
`get_holdings_for_fund`	[EXPERIMENTAL] GetHoldingsForFund: Get holdings for transaction portfolios in a Fund.
`get_holdings_for_fund_with_http_info`	[EXPERIMENTAL] GetHoldingsForFund: Get holdings for transaction portfolios in a Fund.
`get_valuation_for_fund`	[EXPERIMENTAL] GetValuationForFund: Perform valuation for a Fund.
`get_valuation_for_fund_with_http_info`	[EXPERIMENTAL] GetValuationForFund: Perform valuation for 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.
`get_valuation_point_unsettled_transactions`	[EXPERIMENTAL] GetValuationPointUnsettledTransactions: Get Unsettled Transactions for the given Fund.
`get_valuation_point_unsettled_transactions_with_http_info`	[EXPERIMENTAL] GetValuationPointUnsettledTransactions: Get Unsettled Transactions 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_fund_calendar`	[EXPERIMENTAL] ListFundCalendar: List Fund Calendar.
`list_fund_calendar_entries`	[EXPERIMENTAL] ListFundCalendarEntries: List Fund Calendar Entries.
`list_fund_calendar_entries_with_http_info`	[EXPERIMENTAL] ListFundCalendarEntries: List Fund Calendar Entries.
`list_fund_calendar_with_http_info`	[EXPERIMENTAL] ListFundCalendar: List Fund Calendar.
`list_funds`	[EXPERIMENTAL] ListFunds: List Funds.
`list_funds_with_http_info`	[EXPERIMENTAL] ListFunds: List Funds.
`list_nav_activity_adjustments`	[EXPERIMENTAL] ListNavActivityAdjustments: List NAV adjustment activities applied to a valuation point # noqa: E501
`list_nav_activity_adjustments_with_http_info`	[EXPERIMENTAL] ListNavActivityAdjustments: List NAV adjustment activities applied to a valuation point # noqa: E501
`list_valuation_point_instruments`	[EXPERIMENTAL] ListValuationPointInstruments: List Instruments inside a valuation point # noqa: E501
`list_valuation_point_instruments_with_http_info`	[EXPERIMENTAL] ListValuationPointInstruments: List Instruments inside a valuation point # noqa: E501
`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.
`query_cash_statement`	[EXPERIMENTAL] QueryCashStatement: [EXPERIMENTAL] QueryCashStatement: Query cash statement for a Fund valuation point.
`query_cash_statement_with_http_info`	[EXPERIMENTAL] QueryCashStatement: [EXPERIMENTAL] QueryCashStatement: Query cash statement for a Fund valuation point.
`revert_valuation_point_to_estimate`	[EXPERIMENTAL] RevertValuationPointToEstimate: Reverts a Final Valuation Point to Estimate.
`revert_valuation_point_to_estimate_with_http_info`	[EXPERIMENTAL] RevertValuationPointToEstimate: Reverts a Final Valuation Point to Estimate.
`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.
`update_valuation_point`	[EXPERIMENTAL] UpdateValuationPoint: Update a Valuation Point.
`update_valuation_point_with_http_info`	[EXPERIMENTAL] UpdateValuationPoint: Update a Valuation Point.
`upsert_bookmark`	[EXPERIMENTAL] UpsertBookmark: Upsert a bookmark.
`upsert_bookmark_with_http_info`	[EXPERIMENTAL] UpsertBookmark: Upsert a bookmark.
`upsert_diary_entry_type_valuation_point`	[EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert a Valuation Point.
`upsert_diary_entry_type_valuation_point_with_http_info`	[EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert a 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.
`upsert_nav_activity_adjustments`	[EXPERIMENTAL] UpsertNavActivityAdjustments: Upsert NAV adjustment activities to a valuation point # noqa: E501
`upsert_nav_activity_adjustments_with_http_info`	[EXPERIMENTAL] UpsertNavActivityAdjustments: Upsert NAV adjustment activities to a valuation point # noqa: E501

accept_estimate_valuation_point(scope, code, valuation_point_data_request, nav_type_code=None, async_req=None, **kwargs)[source]

[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, nav_type_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)
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)
nav_type_code (str) – When provided, accepts the Valuation Point of the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

[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, nav_type_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)
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)
nav_type_code (str) – When provided, accepts the Valuation Point of the specified NAV Type, otherwise the Primary NAV Type will be used.
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))

add_allocation_groups(scope, code, allocation_group_definition, async_req=None, **kwargs)[source]

[EXPERIMENTAL] AddAllocationGroups: Add Allocation Groups to a Fund. # noqa: E501

Add the given Allocation Group definitions to the 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.add_allocation_groups(scope, code, allocation_group_definition, 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)
allocation_group_definition (List[AllocationGroupDefinition]) – The definitions of the Allocation Groups to add to 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

add_allocation_groups_with_http_info(scope, code, allocation_group_definition, **kwargs)[source]

[EXPERIMENTAL] AddAllocationGroups: Add Allocation Groups to a Fund. # noqa: E501

Add the given Allocation Group definitions to the 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.add_allocation_groups_with_http_info(scope, code, allocation_group_definition, 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)
allocation_group_definition (List[AllocationGroupDefinition]) – The definitions of the Allocation Groups to add to 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))

add_series(scope, code, series_definition_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] AddSeries: Add Series to a Fund. # noqa: E501

Add the given Series definitions to the specified Share Classes of the 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.add_series(scope, code, series_definition_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)
series_definition_request (List[SeriesDefinitionRequest]) – The definitions of the Series to add. (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

add_series_with_http_info(scope, code, series_definition_request, **kwargs)[source]

[EXPERIMENTAL] AddSeries: Add Series to a Fund. # noqa: E501

Add the given Series definitions to the specified Share Classes of the 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.add_series_with_http_info(scope, code, series_definition_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)
series_definition_request (List[SeriesDefinitionRequest]) – The definitions of the Series to add. (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))

create_fee(scope, code, fee_request, nav_type_code=None, async_req=None, **kwargs)[source]

[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, nav_type_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_request (FeeRequest) – The Fee to create. (required)
nav_type_code (str) – When provided, creates the Fee against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

[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, nav_type_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_request (FeeRequest) – The Fee to create. (required)
nav_type_code (str) – When provided, creates the Fee against the specified NAV Type, otherwise the Primary NAV Type will be used.
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)[source]

[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_v2(scope, fund_definition_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateFundV2: Create a Fund V2 (Preview). # noqa: E501

Create the given V2 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_v2(scope, fund_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
fund_definition_request (FundDefinitionRequest) – 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_v2_with_http_info(scope, fund_definition_request, **kwargs)[source]

[EXPERIMENTAL] CreateFundV2: Create a Fund V2 (Preview). # noqa: E501

Create the given V2 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_v2_with_http_info(scope, fund_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
fund_definition_request (FundDefinitionRequest) – 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))

create_fund_with_http_info(scope, fund_request, **kwargs)[source]

[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))

create_valuation_point(scope, code, create_valuation_point_request, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateValuationPoint: Create a Valuation Point. # noqa: E501

Insert the estimate 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.create_valuation_point(scope, code, create_valuation_point_request, nav_type_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)
create_valuation_point_request (CreateValuationPointRequest) – The Valuation Point Estimate definition to create. (required)
nav_type_code (str) – When provided, creates the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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:

ValuationPoint

create_valuation_point_with_http_info(scope, code, create_valuation_point_request, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] CreateValuationPoint: Create a Valuation Point. # noqa: E501

Insert the estimate 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.create_valuation_point_with_http_info(scope, code, create_valuation_point_request, nav_type_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)
create_valuation_point_request (CreateValuationPointRequest) – The Valuation Point Estimate definition to create. (required)
nav_type_code (str) – When provided, creates the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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(ValuationPoint, status_code(int), headers(HTTPHeaderDict))

deactivate_nav_types(scope, code, request_body, delete_mode=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeactivateNavTypes: Deactivate NAV types on a Fund. # noqa: E501

Deactivate the given NAV types on the 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.deactivate_nav_types(scope, code, request_body, delete_mode, 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)
request_body (List[str]) – The codes of the nav types to be deactivated. (required)
delete_mode (str) – The delete mode to use. Default value: Soft. Available values: Soft, Hard.
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

deactivate_nav_types_with_http_info(scope, code, request_body, delete_mode=None, **kwargs)[source]

[EXPERIMENTAL] DeactivateNavTypes: Deactivate NAV types on a Fund. # noqa: E501

Deactivate the given NAV types on the 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.deactivate_nav_types_with_http_info(scope, code, request_body, delete_mode, 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)
request_body (List[str]) – The codes of the nav types to be deactivated. (required)
delete_mode (str) – The delete mode to use. Default value: Soft. Available values: Soft, Hard.
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_bookmark(scope, code, bookmark_code, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteBookmark: Delete a Bookmark. # noqa: E501

Deletes the given Bookmark. # 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_bookmark(scope, code, bookmark_code, nav_type_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)
bookmark_code (str) – The bookmark code for the bookmark to be deleted. (required)
nav_type_code (str) – When provided, deletes the Bookmark against the specified NAV Type, otherwise the Primary NAV Type will be used.
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_bookmark_with_http_info(scope, code, bookmark_code, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] DeleteBookmark: Delete a Bookmark. # noqa: E501

Deletes the given Bookmark. # 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_bookmark_with_http_info(scope, code, bookmark_code, nav_type_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)
bookmark_code (str) – The bookmark code for the bookmark to be deleted. (required)
nav_type_code (str) – When provided, deletes the Bookmark against the specified NAV Type, otherwise the Primary NAV Type will be used.
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_fee(scope, code, fee_code, async_req=None, **kwargs)[source]

[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)[source]

[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)[source]

[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)[source]

[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_nav_activity_adjustments(scope, code, valuation_point_code, nav_activity_adjustment_response, nav_type_code=None, valuation_point_code_variant=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteNavActivityAdjustments: Delete Nav activity adjustments. # noqa: E501

Delete Nav activity adjustments on a 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_nav_activity_adjustments(scope, code, valuation_point_code, nav_activity_adjustment_response, nav_type_code, valuation_point_code_variant, 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_code (str) – The valuation point Code to delete the adjustment from (required)
nav_activity_adjustment_response (List[NavActivityAdjustmentResponse]) – The request describing the Nav activity adjustments to delete from a specific valuation point and nav type (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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_nav_activity_adjustments_with_http_info(scope, code, valuation_point_code, nav_activity_adjustment_response, nav_type_code=None, valuation_point_code_variant=None, **kwargs)[source]

[EXPERIMENTAL] DeleteNavActivityAdjustments: Delete Nav activity adjustments. # noqa: E501

Delete Nav activity adjustments on a 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_nav_activity_adjustments_with_http_info(scope, code, valuation_point_code, nav_activity_adjustment_response, nav_type_code, valuation_point_code_variant, 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_code (str) – The valuation point Code to delete the adjustment from (required)
nav_activity_adjustment_response (List[NavActivityAdjustmentResponse]) – The request describing the Nav activity adjustments to delete from a specific valuation point and nav type (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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, diary_entry_code_variant=None, nav_type_code=None, async_req=None, **kwargs)[source]

[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, diary_entry_code_variant, nav_type_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)
diary_entry_code (str) – The diary entry code for the valuation Point to be deleted. (required)
diary_entry_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. This is working only for the Estimates.
nav_type_code (str) – When provided, deletes the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, diary_entry_code_variant=None, nav_type_code=None, **kwargs)[source]

[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, diary_entry_code_variant, nav_type_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)
diary_entry_code (str) – The diary entry code for the valuation Point to be deleted. (required)
diary_entry_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. This is working only for the Estimates.
nav_type_code (str) – When provided, deletes the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise a Candidate Valuation Point. # 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, nav_type_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)
valuation_point_data_request (ValuationPointDataRequest) – The details of the Valuation Point to mark as final. (required)
nav_type_code (str) – When provided, finalises the Valuation Point of the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise a Candidate Valuation Point. # 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, nav_type_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)
valuation_point_data_request (ValuationPointDataRequest) – The details of the Valuation Point to mark as final. (required)
nav_type_code (str) – When provided, finalises the Valuation Point of the specified NAV Type, otherwise the Primary NAV Type will be used.
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_a2_b_data_for_fund(scope, code, valuation_point_data_query_parameters, nav_type_code=None, as_at=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetA2BDataForFund: Get A2B data for a Fund. # noqa: E501

Get the A2B data for transaction portfolios in 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_a2_b_data_for_fund(scope, code, valuation_point_data_query_parameters, nav_type_code, as_at, 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. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the A2B data. This includes start and end dates. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to resolve the fund and the timeline. Defaults to return the latest version if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Instrument” domain to decorate onto the A2B data. These take the format {domain}/{scope}/{code} e.g. “Instrument/system/Name”.
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:

VersionedResourceListOfFundA2BDataRecord

get_a2_b_data_for_fund_with_http_info(scope, code, valuation_point_data_query_parameters, nav_type_code=None, as_at=None, filter=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] GetA2BDataForFund: Get A2B data for a Fund. # noqa: E501

Get the A2B data for transaction portfolios in 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_a2_b_data_for_fund_with_http_info(scope, code, valuation_point_data_query_parameters, nav_type_code, as_at, 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. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the A2B data. This includes start and end dates. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to resolve the fund and the timeline. Defaults to return the latest version if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Instrument” domain to decorate onto the A2B data. These take the format {domain}/{scope}/{code} e.g. “Instrument/system/Name”.
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(VersionedResourceListOfFundA2BDataRecord, status_code(int), headers(HTTPHeaderDict))

get_a2_b_movements_for_fund(scope, code, valuation_point_data_query_parameters, nav_type_code=None, as_at=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetA2BMovementsForFund: Get A2B movements for transaction portfolios in a Fund. # noqa: E501

Get the A2B movement records of transaction portfolios in 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_a2_b_movements_for_fund(scope, code, valuation_point_data_query_parameters, nav_type_code, as_at, 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. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the A2B movements. This includes start and end dates. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to resolve the fund and the timeline. Defaults to return the latest version if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Instrument” domain to decorate onto the A2B movements. These take the format {domain}/{scope}/{code} e.g. “Instrument/system/Name”.
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:

VersionedResourceListOfFundA2BMovementRecord

get_a2_b_movements_for_fund_with_http_info(scope, code, valuation_point_data_query_parameters, nav_type_code=None, as_at=None, filter=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] GetA2BMovementsForFund: Get A2B movements for transaction portfolios in a Fund. # noqa: E501

Get the A2B movement records of transaction portfolios in 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_a2_b_movements_for_fund_with_http_info(scope, code, valuation_point_data_query_parameters, nav_type_code, as_at, 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. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the A2B movements. This includes start and end dates. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to resolve the fund and the timeline. Defaults to return the latest version if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Instrument” domain to decorate onto the A2B movements. These take the format {domain}/{scope}/{code} e.g. “Instrument/system/Name”.
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(VersionedResourceListOfFundA2BMovementRecord, status_code(int), headers(HTTPHeaderDict))

get_fee(scope, code, fee_code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]

[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)[source]

[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)[source]

[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)[source]

[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)[source]

[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)[source]

[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)[source]

[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)[source]

[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_holding_contributors_for_fund(scope, code, holding_id, valuation_point_data_query_parameters, nav_type_code=None, include_historic=None, tax_lot_id=None, include_unsettled_movements=None, limit=None, as_at=None, page=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetHoldingContributorsForFund: Get holdings contributors for transaction portfolios in a Fund. # noqa: E501

Get the holdings of transaction portfolios in 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_holding_contributors_for_fund(scope, code, holding_id, valuation_point_data_query_parameters, nav_type_code, include_historic, tax_lot_id, include_unsettled_movements, limit, as_at, 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 this uniquely identifies the Fund. (required)
holding_id (int) – The unique holding identifier (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the holdings.This can be a date, valuationPoint or a bookmark. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
include_historic (bool) – If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.
tax_lot_id (str) – Constrains the Holding Contributors to those which contributed to the specified tax lot.
include_unsettled_movements (bool) – If true, contributing transaction which have not settled yet will also be returned. False by default
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
as_at (datetime) – The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
page (str) – The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.
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:

VersionedResourceListOfHoldingContributor

get_holding_contributors_for_fund_with_http_info(scope, code, holding_id, valuation_point_data_query_parameters, nav_type_code=None, include_historic=None, tax_lot_id=None, include_unsettled_movements=None, limit=None, as_at=None, page=None, **kwargs)[source]

[EXPERIMENTAL] GetHoldingContributorsForFund: Get holdings contributors for transaction portfolios in a Fund. # noqa: E501

Get the holdings of transaction portfolios in 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_holding_contributors_for_fund_with_http_info(scope, code, holding_id, valuation_point_data_query_parameters, nav_type_code, include_historic, tax_lot_id, include_unsettled_movements, limit, as_at, 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 this uniquely identifies the Fund. (required)
holding_id (int) – The unique holding identifier (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the holdings.This can be a date, valuationPoint or a bookmark. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
include_historic (bool) – If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.
tax_lot_id (str) – Constrains the Holding Contributors to those which contributed to the specified tax lot.
include_unsettled_movements (bool) – If true, contributing transaction which have not settled yet will also be returned. False by default
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
as_at (datetime) – The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
page (str) – The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.
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(VersionedResourceListOfHoldingContributor, status_code(int), headers(HTTPHeaderDict))

get_holdings_for_fund(scope, code, single_valuation_point_query_parameters, nav_type_code=None, as_at=None, filter=None, property_keys=None, by_taxlots=None, include_settlement_events_after_days=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetHoldingsForFund: Get holdings for transaction portfolios in a Fund. # noqa: E501

Get the holdings of transaction portfolios in 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_holdings_for_fund(scope, code, single_valuation_point_query_parameters, nav_type_code, as_at, filter, property_keys, by_taxlots, include_settlement_events_after_days, 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)
single_valuation_point_query_parameters (SingleValuationPointQueryParameters) – The arguments to use for querying the holdings. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to retrieve the holdings of transaction portfolios in the Fund. Defaults to return the latest version of the holdings if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Instrument”, “Holding” or “Portfolio”,”CustodianAccount” or “LegalEntity” domain to decorate onto domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. “Instrument/system/Name” or “Holding/system/Cost”.
by_taxlots (bool) – Whether to expand the holdings to return the underlying tax-lots. Defaults to False.
include_settlement_events_after_days (int) – Number of days ahead to bring back settlements from, in relation to the specified effectiveAt.
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:

VersionedResourceListOfPortfolioHolding

get_holdings_for_fund_with_http_info(scope, code, single_valuation_point_query_parameters, nav_type_code=None, as_at=None, filter=None, property_keys=None, by_taxlots=None, include_settlement_events_after_days=None, **kwargs)[source]

[EXPERIMENTAL] GetHoldingsForFund: Get holdings for transaction portfolios in a Fund. # noqa: E501

Get the holdings of transaction portfolios in 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_holdings_for_fund_with_http_info(scope, code, single_valuation_point_query_parameters, nav_type_code, as_at, filter, property_keys, by_taxlots, include_settlement_events_after_days, 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)
single_valuation_point_query_parameters (SingleValuationPointQueryParameters) – The arguments to use for querying the holdings. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to retrieve the holdings of transaction portfolios in the Fund. Defaults to return the latest version of the holdings if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Instrument”, “Holding” or “Portfolio”,”CustodianAccount” or “LegalEntity” domain to decorate onto domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. “Instrument/system/Name” or “Holding/system/Cost”.
by_taxlots (bool) – Whether to expand the holdings to return the underlying tax-lots. Defaults to False.
include_settlement_events_after_days (int) – Number of days ahead to bring back settlements from, in relation to the specified effectiveAt.
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(VersionedResourceListOfPortfolioHolding, status_code(int), headers(HTTPHeaderDict))

get_valuation_for_fund(scope, code, nav_type_code=None, fund_valuation_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetValuationForFund: Perform valuation for a Fund. # noqa: E501

Perform valuation on 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_valuation_for_fund(scope, code, nav_type_code, fund_valuation_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)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
fund_valuation_request (FundValuationRequest) – The request specifying the dates (or DiaryEntry) on which to calculate a set of valuation metrics.
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:

ListAggregationResponse

get_valuation_for_fund_with_http_info(scope, code, nav_type_code=None, fund_valuation_request=None, **kwargs)[source]

[EXPERIMENTAL] GetValuationForFund: Perform valuation for a Fund. # noqa: E501

Perform valuation on 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_valuation_for_fund_with_http_info(scope, code, nav_type_code, fund_valuation_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)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
fund_valuation_request (FundValuationRequest) – The request specifying the dates (or DiaryEntry) on which to calculate a set of valuation metrics.
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(ListAggregationResponse, status_code(int), headers(HTTPHeaderDict))

get_valuation_point_data(scope, code, valuation_point_data_query_parameters, as_at=None, nav_type_code=None, async_req=None, **kwargs)[source]

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

Retrieves the Valuation Point data between given dates or Valuation Point codes. The endpoint will internally extract all ‘Assets’ and ‘Liabilities’ from the Fund’s Trial balance to produce a GAV. Start date will be assumed from the last ‘official’ ValuationPoint 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, nav_type_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)
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.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

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

Retrieves the Valuation Point data between given dates or Valuation Point codes. The endpoint will internally extract all ‘Assets’ and ‘Liabilities’ from the Fund’s Trial balance to produce a GAV. Start date will be assumed from the last ‘official’ ValuationPoint 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, nav_type_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)
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.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, async_req=None, **kwargs)[source]

[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, nav_type_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)
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 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.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

[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, nav_type_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)
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 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.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, async_req=None, **kwargs)[source]

[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, nav_type_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)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for generating 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 results from a previous call to GetValuationPointPnlSummary.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

[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, nav_type_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)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for generating 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 results from a previous call to GetValuationPointPnlSummary.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, data_model_scope=None, data_model_code=None, show_cancelled_transactions=None, membership_type=None, async_req=None, **kwargs)[source]

[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, nav_type_code, data_model_scope, data_model_code, show_cancelled_transactions, membership_type, 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 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 transactions.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
data_model_scope (str) – The optional scope of a Custom Data Model to use
data_model_code (str) – The optional code of a Custom Data Model to use
show_cancelled_transactions (bool) – Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.
membership_type (str) – The membership types of the specified Custom Data Model to return. Default value: Member. Available values: All, Member, Candidate.
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, nav_type_code=None, data_model_scope=None, data_model_code=None, show_cancelled_transactions=None, membership_type=None, **kwargs)[source]

[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, nav_type_code, data_model_scope, data_model_code, show_cancelled_transactions, membership_type, 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 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 transactions.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
data_model_scope (str) – The optional scope of a Custom Data Model to use
data_model_code (str) – The optional code of a Custom Data Model to use
show_cancelled_transactions (bool) – Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.
membership_type (str) – The membership types of the specified Custom Data Model to return. Default value: Member. Available values: All, Member, Candidate.
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, nav_type_code=None, exclude_cleardown_module=None, async_req=None, **kwargs)[source]

[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, nav_type_code, exclude_cleardown_module, 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 generating 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 TrialBalance.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
exclude_cleardown_module (bool) – If this is set to true, no Cleardown Module will be applied to the Trial Balance. Defaults to false.
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, nav_type_code=None, exclude_cleardown_module=None, **kwargs)[source]

[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, nav_type_code, exclude_cleardown_module, 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 generating 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 TrialBalance.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
exclude_cleardown_module (bool) – If this is set to true, no Cleardown Module will be applied to the Trial Balance. Defaults to false.
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))

get_valuation_point_unsettled_transactions(scope, code, valuation_point_data_query_parameters, as_at=None, limit=None, page=None, property_keys=None, nav_type_code=None, async_req=None, **kwargs)[source]

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

Gets all transactions that remain unsettled as at the specified Valuation Point for a Fund, looking back from inception. Settlement status is point-in-time: post-cutoff settlement activity does not alter the result. # 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_unsettled_transactions(scope, code, valuation_point_data_query_parameters, as_at, limit, page, property_keys, nav_type_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)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the unsettled transactions. (required)
as_at (datetime) – The asAt datetime at which to retrieve the report. Defaults to latest.
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 from a previous call.
property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, or ‘Account’ domain to decorate onto the transactions.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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:

ValuationPointResourceListOfUnsettledTransaction

get_valuation_point_unsettled_transactions_with_http_info(scope, code, valuation_point_data_query_parameters, as_at=None, limit=None, page=None, property_keys=None, nav_type_code=None, **kwargs)[source]

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

Gets all transactions that remain unsettled as at the specified Valuation Point for a Fund, looking back from inception. Settlement status is point-in-time: post-cutoff settlement activity does not alter the result. # 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_unsettled_transactions_with_http_info(scope, code, valuation_point_data_query_parameters, as_at, limit, page, property_keys, nav_type_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)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the unsettled transactions. (required)
as_at (datetime) – The asAt datetime at which to retrieve the report. Defaults to latest.
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 from a previous call.
property_keys (List[str]) – A list of property keys from the ‘Instrument’, ‘Transaction’, ‘Portfolio’, or ‘Account’ domain to decorate onto the transactions.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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(ValuationPointResourceListOfUnsettledTransaction, 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)[source]

[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. Together with the scope this uniquely identifies 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)[source]

[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. Together with the scope this uniquely identifies 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_fund_calendar(scope, code, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListFundCalendar: List Fund Calendar. # noqa: E501

List all the Calendar Entries associated with the 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_fund_calendar(scope, code, 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. Together with the scope this uniquely identifies the Fund. (required)
as_at (datetime) – The asAt datetime at which to list the Calendar. Defaults to returning the latest version of each Calendar Entry if not specified.
page (str) – The pagination token to use to continue listing Calendar Entries; 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 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 ‘ClosedPeriod’ domain to decorate onto each item.
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:

PagedResourceListOfFundCalendarEntry

list_fund_calendar_entries(scope, code, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListFundCalendarEntries: List Fund Calendar Entries. # noqa: E501

List all the Calendar Entries associated with the 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_fund_calendar_entries(scope, code, 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. Together with the scope this uniquely identifies the Fund. (required)
as_at (datetime) – The asAt datetime at which to list the Calendar. Defaults to returning the latest version of each Calendar Entry if not specified.
page (str) – The pagination token to use to continue listing Calendar Entries; 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 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 ‘DiaryEntry’ domain to decorate onto each item.
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:

PagedResourceListOfFundCalendarEntries

list_fund_calendar_entries_with_http_info(scope, code, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] ListFundCalendarEntries: List Fund Calendar Entries. # noqa: E501

List all the Calendar Entries associated with the 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_fund_calendar_entries_with_http_info(scope, code, 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. Together with the scope this uniquely identifies the Fund. (required)
as_at (datetime) – The asAt datetime at which to list the Calendar. Defaults to returning the latest version of each Calendar Entry if not specified.
page (str) – The pagination token to use to continue listing Calendar Entries; 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 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 ‘DiaryEntry’ domain to decorate onto each item.
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(PagedResourceListOfFundCalendarEntries, status_code(int), headers(HTTPHeaderDict))

list_fund_calendar_with_http_info(scope, code, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] ListFundCalendar: List Fund Calendar. # noqa: E501

List all the Calendar Entries associated with the 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_fund_calendar_with_http_info(scope, code, 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. Together with the scope this uniquely identifies the Fund. (required)
as_at (datetime) – The asAt datetime at which to list the Calendar. Defaults to returning the latest version of each Calendar Entry if not specified.
page (str) – The pagination token to use to continue listing Calendar Entries; 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 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 ‘ClosedPeriod’ domain to decorate onto each item.
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(PagedResourceListOfFundCalendarEntry, 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)[source]

[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 code, 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)[source]

[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 code, 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_nav_activity_adjustments(scope, code, valuation_point_code, nav_type_code=None, as_at=None, page=None, limit=None, filter=None, valuation_point_code_variant=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListNavActivityAdjustments: List NAV adjustment activities applied to a valuation point # noqa: E501

Lists the NAV adjustment activities applied to the specified 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.list_nav_activity_adjustments(scope, code, valuation_point_code, nav_type_code, as_at, page, limit, filter, valuation_point_code_variant, 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_code (str) – Fetch all NAV adjustment activities for this valuation point. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to list the Nav activity adjustments. Defaults to returning the latest version of each adjustment if not specified.
page (str) – The pagination token to use to continue listing Nav activity adjustments; this value is returned from the previous call. If a pagination token is provided, the filter, 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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:

ResourceListOfNavActivityAdjustmentResponse

list_nav_activity_adjustments_with_http_info(scope, code, valuation_point_code, nav_type_code=None, as_at=None, page=None, limit=None, filter=None, valuation_point_code_variant=None, **kwargs)[source]

[EXPERIMENTAL] ListNavActivityAdjustments: List NAV adjustment activities applied to a valuation point # noqa: E501

Lists the NAV adjustment activities applied to the specified 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.list_nav_activity_adjustments_with_http_info(scope, code, valuation_point_code, nav_type_code, as_at, page, limit, filter, valuation_point_code_variant, 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_code (str) – Fetch all NAV adjustment activities for this valuation point. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to list the Nav activity adjustments. Defaults to returning the latest version of each adjustment if not specified.
page (str) – The pagination token to use to continue listing Nav activity adjustments; this value is returned from the previous call. If a pagination token is provided, the filter, 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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(ResourceListOfNavActivityAdjustmentResponse, status_code(int), headers(HTTPHeaderDict))

list_valuation_point_instruments(scope, code, valuation_point_code, nav_type_code=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, instrument_property_keys=None, valuation_point_code_variant=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListValuationPointInstruments: List Instruments inside a valuation point # noqa: E501

Lists the Instruments linked to Transactions within a 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.list_valuation_point_instruments(scope, code, valuation_point_code, nav_type_code, as_at, page, limit, filter, sort_by, instrument_property_keys, valuation_point_code_variant, 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_code (str) – Fetch all instruments for this valuation point. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to list the instruments. Defaults to returning the latest version of each instrument if not specified.
page (str) – The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the filter, 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
instrument_property_keys (List[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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:

PagedResourceListOfValuationPointInstrument

list_valuation_point_instruments_with_http_info(scope, code, valuation_point_code, nav_type_code=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, instrument_property_keys=None, valuation_point_code_variant=None, **kwargs)[source]

[EXPERIMENTAL] ListValuationPointInstruments: List Instruments inside a valuation point # noqa: E501

Lists the Instruments linked to Transactions within a 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.list_valuation_point_instruments_with_http_info(scope, code, valuation_point_code, nav_type_code, as_at, page, limit, filter, sort_by, instrument_property_keys, valuation_point_code_variant, 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_code (str) – Fetch all instruments for this valuation point. (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
as_at (datetime) – The asAt datetime at which to list the instruments. Defaults to returning the latest version of each instrument if not specified.
page (str) – The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the filter, 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
instrument_property_keys (List[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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(PagedResourceListOfValuationPointInstrument, 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, nav_type_code=None, async_req=None, **kwargs)[source]

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

List the overview of 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, nav_type_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)
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Valuation Points. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the Valuation Points. Defaults to returning the latest version of each Valuation Point if not specified.
page (str) – The pagination token to use to continue listing Valuation Points; 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’.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

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

List the overview of 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, nav_type_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)
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Valuation Points. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the Valuation Points. Defaults to returning the latest version of each Valuation Point if not specified.
page (str) – The pagination token to use to continue listing Valuation Points; 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’.
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
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)[source]

[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, ShareClasses. # 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)[source]

[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, ShareClasses. # 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)[source]

[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, PortfolioIds, FundConfigurationId, ShareClassInstruments, Type, InceptionDate, DecimalPlaces, PrimaryNavType, AdditionalNavTypes, AborId, 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)[source]

[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, PortfolioIds, FundConfigurationId, ShareClassInstruments, Type, InceptionDate, DecimalPlaces, PrimaryNavType, AdditionalNavTypes, AborId, 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))

query_cash_statement(scope, code, query_fund_cash_statement_parameters, as_at=None, filter=None, limit=None, page=None, property_keys=None, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] QueryCashStatement: [EXPERIMENTAL] QueryCashStatement: Query cash statement for a Fund valuation point. # noqa: E501

Returns settled cash movements with running balance, cost basis, average FX rate, and realised FX PnL for the specified Fund valuation point period. The cash statement is derived from Journal Entry Lines filtered to settled cash (HoldType=’B’, SourceType=LusidTransaction). Use the DisplayMode parameter on the request body to choose between ShowReversal (full reversal/TrueUp detail) and Consolidated (collapses reversals into AvgRateCorrection rows). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_cash_statement(scope, code, query_fund_cash_statement_parameters, as_at, filter, limit, page, property_keys, nav_type_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)
query_fund_cash_statement_parameters (QueryFundCashStatementParameters) – The query parameters specifying the diary entry period and display mode. (required)
as_at (datetime) – The asAt datetime at which to retrieve the cash statement. Defaults to the latest version 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 get the next page of results.
property_keys (List[str]) – A list of property keys to decorate onto the cash statement rows.
nav_type_code (str) – The code of the NAV type to use. Defaults to the primary NAV type 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:

ValuationPointResourceListOfFundCashStatementRow

query_cash_statement_with_http_info(scope, code, query_fund_cash_statement_parameters, as_at=None, filter=None, limit=None, page=None, property_keys=None, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] QueryCashStatement: [EXPERIMENTAL] QueryCashStatement: Query cash statement for a Fund valuation point. # noqa: E501

Returns settled cash movements with running balance, cost basis, average FX rate, and realised FX PnL for the specified Fund valuation point period. The cash statement is derived from Journal Entry Lines filtered to settled cash (HoldType=’B’, SourceType=LusidTransaction). Use the DisplayMode parameter on the request body to choose between ShowReversal (full reversal/TrueUp detail) and Consolidated (collapses reversals into AvgRateCorrection rows). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_cash_statement_with_http_info(scope, code, query_fund_cash_statement_parameters, as_at, filter, limit, page, property_keys, nav_type_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)
query_fund_cash_statement_parameters (QueryFundCashStatementParameters) – The query parameters specifying the diary entry period and display mode. (required)
as_at (datetime) – The asAt datetime at which to retrieve the cash statement. Defaults to the latest version 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 get the next page of results.
property_keys (List[str]) – A list of property keys to decorate onto the cash statement rows.
nav_type_code (str) – The code of the NAV type to use. Defaults to the primary NAV type 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(ValuationPointResourceListOfFundCashStatementRow, status_code(int), headers(HTTPHeaderDict))

revert_valuation_point_to_estimate(scope, code, revert_valuation_point_data_request, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] RevertValuationPointToEstimate: Reverts a Final Valuation Point to Estimate. # noqa: E501

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

>>> thread = api.revert_valuation_point_to_estimate(scope, code, revert_valuation_point_data_request, nav_type_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)
revert_valuation_point_data_request (RevertValuationPointDataRequest) – The revertValuationPointRequest which contains the Diary Entry code for the Final Valuation Point to move to Estimate status. (required)
nav_type_code (str) – When provided, sets the status of the Valuation Point of the specified NAV Type to be Estimate. Otherwise, the Primary NAV Type will be used.
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

revert_valuation_point_to_estimate_with_http_info(scope, code, revert_valuation_point_data_request, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] RevertValuationPointToEstimate: Reverts a Final Valuation Point to Estimate. # noqa: E501

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

>>> thread = api.revert_valuation_point_to_estimate_with_http_info(scope, code, revert_valuation_point_data_request, nav_type_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)
revert_valuation_point_data_request (RevertValuationPointDataRequest) – The revertValuationPointRequest which contains the Diary Entry code for the Final Valuation Point to move to Estimate status. (required)
nav_type_code (str) – When provided, sets the status of the Valuation Point of the specified NAV Type to be Estimate. Otherwise, the Primary NAV Type will be used.
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))

set_share_class_instruments(scope, code, set_share_class_instruments_request, async_req=None, **kwargs)[source]

[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. Together with the scope this uniquely identifies 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)[source]

[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. Together with the scope this uniquely identifies 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))

update_valuation_point(scope, code, update_valuation_point_request, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpdateValuationPoint: Update a Valuation Point. # noqa: E501

Updates an existing 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.update_valuation_point(scope, code, update_valuation_point_request, nav_type_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)
update_valuation_point_request (UpdateValuationPointRequest) – The Valuation Point Estimate definition to upsert. (required)
nav_type_code (str) – When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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:

ValuationPoint

update_valuation_point_with_http_info(scope, code, update_valuation_point_request, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] UpdateValuationPoint: Update a Valuation Point. # noqa: E501

Updates an existing 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.update_valuation_point_with_http_info(scope, code, update_valuation_point_request, nav_type_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)
update_valuation_point_request (UpdateValuationPointRequest) – The Valuation Point Estimate definition to upsert. (required)
nav_type_code (str) – When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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(ValuationPoint, status_code(int), headers(HTTPHeaderDict))

upsert_bookmark(scope, code, upsert_fund_bookmark_request, nav_type_code=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpsertBookmark: Upsert a bookmark. # noqa: E501

This method will update or upsert a Bookmark for the 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.upsert_bookmark(scope, code, upsert_fund_bookmark_request, nav_type_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)
upsert_fund_bookmark_request (UpsertFundBookmarkRequest) – The bookmark definition to upsert. (required)
nav_type_code (str) – When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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:

FundCalendarEntry

upsert_bookmark_with_http_info(scope, code, upsert_fund_bookmark_request, nav_type_code=None, **kwargs)[source]

[EXPERIMENTAL] UpsertBookmark: Upsert a bookmark. # noqa: E501

This method will update or upsert a Bookmark for the 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.upsert_bookmark_with_http_info(scope, code, upsert_fund_bookmark_request, nav_type_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)
upsert_fund_bookmark_request (UpsertFundBookmarkRequest) – The bookmark definition to upsert. (required)
nav_type_code (str) – When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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(FundCalendarEntry, status_code(int), headers(HTTPHeaderDict))

upsert_diary_entry_type_valuation_point(scope, code, upsert_valuation_point_request, nav_type_code=None, async_req=None, **kwargs)[source]

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

Insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. # 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, nav_type_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)
upsert_valuation_point_request (UpsertValuationPointRequest) – The Valuation Point Estimate definition to upsert. (required)
nav_type_code (str) – When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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, nav_type_code=None, **kwargs)[source]

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

Insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. # 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, nav_type_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)
upsert_valuation_point_request (UpsertValuationPointRequest) – The Valuation Point Estimate definition to upsert. (required)
nav_type_code (str) – When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used.
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)[source]

[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 effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom 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)[source]

[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 effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom 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)[source]

[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 effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom 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. (required)
code (str) – The code of the Fund. 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)[source]

[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 effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom 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. (required)
code (str) – The code of the Fund. 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))

upsert_nav_activity_adjustments(scope, code, valuation_point_code, nav_activity_adjustment, nav_type_code=None, valuation_point_code_variant=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpsertNavActivityAdjustments: Upsert NAV adjustment activities to a valuation point # noqa: E501

Upserts the NAV adjustment activities to the specified 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.upsert_nav_activity_adjustments(scope, code, valuation_point_code, nav_activity_adjustment, nav_type_code, valuation_point_code_variant, 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_code (str) – The valuation point Code to apply the adjustment to (required)
nav_activity_adjustment (List[NavActivityAdjustment]) – The request describing the Nav activity adjustments to apply to a specific valuation point and nav type (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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:

datetime

upsert_nav_activity_adjustments_with_http_info(scope, code, valuation_point_code, nav_activity_adjustment, nav_type_code=None, valuation_point_code_variant=None, **kwargs)[source]

[EXPERIMENTAL] UpsertNavActivityAdjustments: Upsert NAV adjustment activities to a valuation point # noqa: E501

Upserts the NAV adjustment activities to the specified 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.upsert_nav_activity_adjustments_with_http_info(scope, code, valuation_point_code, nav_activity_adjustment, nav_type_code, valuation_point_code_variant, 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_code (str) – The valuation point Code to apply the adjustment to (required)
nav_activity_adjustment (List[NavActivityAdjustment]) – The request describing the Nav activity adjustments to apply to a specific valuation point and nav type (required)
nav_type_code (str) – When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
valuation_point_code_variant (str) – The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType.
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(datetime, status_code(int), headers(HTTPHeaderDict))