sdk.lusid.api.abor_api.AborApi

class AborApi(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

`add_diary_entry`	[EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor.
`add_diary_entry_with_http_info`	[EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor.
`close_period`	[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor.
`close_period_with_http_info`	[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor.
`create_abor`	[EXPERIMENTAL] CreateAbor: Create an Abor.
`create_abor_with_http_info`	[EXPERIMENTAL] CreateAbor: Create an Abor.
`delete_abor`	[EXPERIMENTAL] DeleteAbor: Delete an Abor.
`delete_abor_with_http_info`	[EXPERIMENTAL] DeleteAbor: Delete an Abor.
`get_abor`	[EXPERIMENTAL] GetAbor: Get Abor.
`get_abor_with_http_info`	[EXPERIMENTAL] GetAbor: Get Abor.
`get_journal_entry_lines`	[EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor.
`get_journal_entry_lines_with_http_info`	[EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor.
`get_trial_balance`	[EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor.
`get_trial_balance_with_http_info`	[EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor.
`list_abors`	[EXPERIMENTAL] ListAbors: List Abors.
`list_abors_with_http_info`	[EXPERIMENTAL] ListAbors: List Abors.
`list_diary_entries`	[EXPERIMENTAL] ListDiaryEntries: List diary entries.
`list_diary_entries_with_http_info`	[EXPERIMENTAL] ListDiaryEntries: List diary entries.
`lock_period`	[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period.
`lock_period_with_http_info`	[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period.
`patch_abor`	[EXPERIMENTAL] PatchAbor: Patch Abor.
`patch_abor_with_http_info`	[EXPERIMENTAL] PatchAbor: Patch Abor.
`re_open_periods`	[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor.
`re_open_periods_with_http_info`	[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor.
`upsert_abor_properties`	[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties # noqa: E501
`upsert_abor_properties_with_http_info`	[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties # noqa: E501

add_diary_entry(scope, code, diary_entry_code, diary_entry_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. # noqa: E501

Adds a new diary entry to the specified Abor # 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_diary_entry(scope, code, diary_entry_code, diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. (required)
diary_entry_code (str) – Diary entry code (required)
diary_entry_request (DiaryEntryRequest) – The diary entry to add. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

DiaryEntry

add_diary_entry_with_http_info(scope, code, diary_entry_code, diary_entry_request, **kwargs)[source]

[EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. # noqa: E501

Adds a new diary entry to the specified Abor # 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_diary_entry_with_http_info(scope, code, diary_entry_code, diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. (required)
diary_entry_code (str) – Diary entry code (required)
diary_entry_request (DiaryEntryRequest) – The diary entry 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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

close_period(scope, code, close_period_diary_entry_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. # noqa: E501

Closes or Locks the current open period for the given Abor. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.close_period(scope, code, close_period_diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. (required)
close_period_diary_entry_request (ClosePeriodDiaryEntryRequest) – The request body, containing details to apply to the closing/locking period. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

DiaryEntry

close_period_with_http_info(scope, code, close_period_diary_entry_request, **kwargs)[source]

[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. # noqa: E501

Closes or Locks the current open period for the given Abor. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.close_period_with_http_info(scope, code, close_period_diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

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

create_abor(scope, abor_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateAbor: Create an Abor. # noqa: E501

Create the given Abor. # 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_abor(scope, abor_request, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

Abor

create_abor_with_http_info(scope, abor_request, **kwargs)[source]

[EXPERIMENTAL] CreateAbor: Create an Abor. # noqa: E501

Create the given Abor. # 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_abor_with_http_info(scope, abor_request, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

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

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

[EXPERIMENTAL] DeleteAbor: Delete an Abor. # noqa: E501

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

Parameters:

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

Returns:

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

Return type:

DeletedEntityResponse

delete_abor_with_http_info(scope, code, **kwargs)[source]

[EXPERIMENTAL] DeleteAbor: Delete an Abor. # noqa: E501

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

Parameters:

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

Returns:

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

Return type:

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

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

[EXPERIMENTAL] GetAbor: Get Abor. # noqa: E501

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

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope this uniquely identifies the Abor. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Abor’ domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example ‘Abor/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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

Abor

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

[EXPERIMENTAL] GetAbor: Get Abor. # noqa: E501

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

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope this uniquely identifies the Abor. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Abor’ domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example ‘Abor/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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

get_journal_entry_lines(scope, code, journal_entry_lines_query_parameters, as_at=None, filter=None, limit=None, page=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. # noqa: E501

Gets the Journal Entry lines for the given Abor The Journal Entry lines have been generated from transactions and translated via posting rules # 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_journal_entry_lines(scope, code, journal_entry_lines_query_parameters, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope is creating the unique identifier for the given Abor. (required)
journal_entry_lines_query_parameters (JournalEntryLinesQueryParameters) – The query parameters used in running the generation of the Journal Entry lines. (required)
as_at (datetime) – The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified.
filter (str) – “Expression to filter the result set.”
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
page (str) – The pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

VersionedResourceListOfJournalEntryLine

get_journal_entry_lines_with_http_info(scope, code, journal_entry_lines_query_parameters, as_at=None, filter=None, limit=None, page=None, **kwargs)[source]

[EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. # noqa: E501

Gets the Journal Entry lines for the given Abor The Journal Entry lines have been generated from transactions and translated via posting rules # 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_journal_entry_lines_with_http_info(scope, code, journal_entry_lines_query_parameters, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope is creating the unique identifier for the given Abor. (required)
journal_entry_lines_query_parameters (JournalEntryLinesQueryParameters) – The query parameters used in running the generation of the Journal Entry lines. (required)
as_at (datetime) – The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified.
filter (str) – “Expression to filter the result set.”
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
page (str) – The pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

get_trial_balance(scope, code, trial_balance_query_parameters, as_at=None, filter=None, limit=None, page=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. # noqa: E501

Gets the Trial balance for the given Abor 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_trial_balance(scope, code, trial_balance_query_parameters, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope is the unique identifier for the given Abor. (required)
trial_balance_query_parameters (TrialBalanceQueryParameters) – The query parameters used in running the generation of the Trial Balance. (required)
as_at (datetime) – The asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified.
filter (str) – “Expression to filter the result set.”
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
page (str) – The pagination token to use to continue listing Trial balance from a previous call to Trial balance.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

VersionedResourceListOfTrialBalance

get_trial_balance_with_http_info(scope, code, trial_balance_query_parameters, as_at=None, filter=None, limit=None, page=None, **kwargs)[source]

[EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. # noqa: E501

Gets the Trial balance for the given Abor 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_trial_balance_with_http_info(scope, code, trial_balance_query_parameters, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope is the unique identifier for the given Abor. (required)
trial_balance_query_parameters (TrialBalanceQueryParameters) – The query parameters used in running the generation of the Trial Balance. (required)
as_at (datetime) – The asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified.
filter (str) – “Expression to filter the result set.”
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
page (str) – The pagination token to use to continue listing Trial balance from a previous call to Trial balance.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

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

[EXPERIMENTAL] ListAbors: List Abors. # noqa: E501

List all the Abors 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_abors(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 Abor. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified.
page (str) – The pagination token to use to continue listing Abor; 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 Abor type, specify “id.Code eq ‘Abor1’”. 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 ‘Abor’ domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example ‘Abor/Manager/Id’.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

PagedResourceListOfAbor

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

[EXPERIMENTAL] ListAbors: List Abors. # noqa: E501

List all the Abors 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_abors_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 Abor. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified.
page (str) – The pagination token to use to continue listing Abor; 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 Abor type, specify “id.Code eq ‘Abor1’”. 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 ‘Abor’ domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example ‘Abor/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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

list_diary_entries(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] ListDiaryEntries: List diary entries. # noqa: E501

List all the diary entries 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_diary_entries(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 Abor. (required)
code (str) – The code of the Abor. (required)
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified.
page (str) – The pagination token to use to continue listing diary 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 example, to filter on the DiaryEntry type, specify “type eq ‘PeriodBoundary’”. 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 DiaryEntry. These must take the format {domain}/{scope}/{code}, for example ‘DiaryEntry/Report/Id’.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

PagedResourceListOfDiaryEntry

list_diary_entries_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] ListDiaryEntries: List diary entries. # noqa: E501

List all the diary entries 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_diary_entries_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 Abor. (required)
code (str) – The code of the Abor. (required)
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified.
page (str) – The pagination token to use to continue listing diary 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 example, to filter on the DiaryEntry type, specify “type eq ‘PeriodBoundary’”. 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 DiaryEntry. These must take the format {domain}/{scope}/{code}, for example ‘DiaryEntry/Report/Id’.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

lock_period(scope, code, lock_period_diary_entry_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. # noqa: E501

Locks the specified or last locked period for the given Abor. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.lock_period(scope, code, lock_period_diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

DiaryEntry

lock_period_with_http_info(scope, code, lock_period_diary_entry_request=None, **kwargs)[source]

[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. # noqa: E501

Locks the specified or last locked period for the given Abor. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.lock_period_with_http_info(scope, code, lock_period_diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

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

patch_abor(scope, code, operation, async_req=None, **kwargs)[source]

[EXPERIMENTAL] PatchAbor: Patch Abor. # noqa: E501

Create or update certain fields for a particular Abor. The behaviour is defined by the JSON Patch specification. Currently supported fields are: PortfolioIds. # 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_abor(scope, code, operation, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope this uniquely identifies the Abor. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

Abor

patch_abor_with_http_info(scope, code, operation, **kwargs)[source]

[EXPERIMENTAL] PatchAbor: Patch Abor. # noqa: E501

Create or update certain fields for a particular Abor. The behaviour is defined by the JSON Patch specification. Currently supported fields are: PortfolioIds. # 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_abor_with_http_info(scope, code, operation, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor. (required)
code (str) – The code of the Abor. Together with the scope this uniquely identifies the Abor. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

re_open_periods(scope, code, re_open_period_diary_entry_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. # noqa: E501

Reopens one or more periods. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.re_open_periods(scope, code, re_open_period_diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor to be deleted. (required)
code (str) – The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
re_open_period_diary_entry_request (ReOpenPeriodDiaryEntryRequest) – The request body, detailing re open details
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

PeriodDiaryEntriesReopenedResponse

re_open_periods_with_http_info(scope, code, re_open_period_diary_entry_request=None, **kwargs)[source]

[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. # noqa: E501

Reopens one or more periods. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.re_open_periods_with_http_info(scope, code, re_open_period_diary_entry_request, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

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

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

[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties # noqa: E501

Update or insert one or more properties onto a single Abor. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Abor’. Upserting a property that exists for an Abor, 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_abor_properties(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor to update or insert the properties onto. (required)
code (str) – The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Abor/Manager/Id”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

AborProperties

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

[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties # noqa: E501

Update or insert one or more properties onto a single Abor. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Abor’. Upserting a property that exists for an Abor, 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_abor_properties_with_http_info(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Abor to update or insert the properties onto. (required)
code (str) – The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Abor/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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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