sdk.lusid.api.chart_of_accounts_api.ChartOfAccountsApi

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

`create_chart_of_accounts`	[EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts # noqa: E501
`create_chart_of_accounts_with_http_info`	[EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts # noqa: E501
`create_cleardown_module`	[EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module # noqa: E501
`create_cleardown_module_with_http_info`	[EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module # noqa: E501
`create_general_ledger_profile`	[EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile.
`create_general_ledger_profile_with_http_info`	[EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile.
`create_posting_module`	[EXPERIMENTAL] CreatePostingModule: Create a Posting Module # noqa: E501
`create_posting_module_with_http_info`	[EXPERIMENTAL] CreatePostingModule: Create a Posting Module # noqa: E501
`delete_accounts`	[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts # noqa: E501
`delete_accounts_with_http_info`	[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts # noqa: E501
`delete_chart_of_accounts`	[EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts # noqa: E501
`delete_chart_of_accounts_with_http_info`	[EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts # noqa: E501
`delete_cleardown_module`	[EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module.
`delete_cleardown_module_with_http_info`	[EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module.
`delete_general_ledger_profile`	[EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile.
`delete_general_ledger_profile_with_http_info`	[EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile.
`delete_posting_module`	[EXPERIMENTAL] DeletePostingModule: Delete a Posting Module.
`delete_posting_module_with_http_info`	[EXPERIMENTAL] DeletePostingModule: Delete a Posting Module.
`get_account`	[EXPERIMENTAL] GetAccount: Get Account # noqa: E501
`get_account_with_http_info`	[EXPERIMENTAL] GetAccount: Get Account # noqa: E501
`get_chart_of_accounts`	[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts # noqa: E501
`get_chart_of_accounts_with_http_info`	[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts # noqa: E501
`get_cleardown_module`	[EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module # noqa: E501
`get_cleardown_module_with_http_info`	[EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module # noqa: E501
`get_general_ledger_profile`	[EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile.
`get_general_ledger_profile_with_http_info`	[EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile.
`get_posting_module`	[EXPERIMENTAL] GetPostingModule: Get a Posting Module # noqa: E501
`get_posting_module_with_http_info`	[EXPERIMENTAL] GetPostingModule: Get a Posting Module # noqa: E501
`list_accounts`	[EXPERIMENTAL] ListAccounts: List Accounts # noqa: E501
`list_accounts_with_http_info`	[EXPERIMENTAL] ListAccounts: List Accounts # noqa: E501
`list_charts_of_accounts`	[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts # noqa: E501
`list_charts_of_accounts_with_http_info`	[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts # noqa: E501
`list_cleardown_module_rules`	[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules # noqa: E501
`list_cleardown_module_rules_with_http_info`	[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules # noqa: E501
`list_cleardown_modules`	[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules # noqa: E501
`list_cleardown_modules_with_http_info`	[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules # noqa: E501
`list_general_ledger_profiles`	[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles.
`list_general_ledger_profiles_with_http_info`	[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles.
`list_posting_module_rules`	[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules # noqa: E501
`list_posting_module_rules_with_http_info`	[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules # noqa: E501
`list_posting_modules`	[EXPERIMENTAL] ListPostingModules: List Posting Modules # noqa: E501
`list_posting_modules_with_http_info`	[EXPERIMENTAL] ListPostingModules: List Posting Modules # noqa: E501
`set_cleardown_module_details`	[EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module # noqa: E501
`set_cleardown_module_details_with_http_info`	[EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module # noqa: E501
`set_cleardown_module_rules`	[EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module # noqa: E501
`set_cleardown_module_rules_with_http_info`	[EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module # noqa: E501
`set_general_ledger_profile_mappings`	[EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings.
`set_general_ledger_profile_mappings_with_http_info`	[EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings.
`set_posting_module_details`	[EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module # noqa: E501
`set_posting_module_details_with_http_info`	[EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module # noqa: E501
`set_posting_module_rules`	[EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module # noqa: E501
`set_posting_module_rules_with_http_info`	[EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module # noqa: E501
`upsert_account_properties`	[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties # noqa: E501
`upsert_account_properties_with_http_info`	[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties # noqa: E501
`upsert_accounts`	[EXPERIMENTAL] UpsertAccounts: Upsert Accounts # noqa: E501
`upsert_accounts_with_http_info`	[EXPERIMENTAL] UpsertAccounts: Upsert Accounts # noqa: E501
`upsert_chart_of_accounts_properties`	[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties # noqa: E501
`upsert_chart_of_accounts_properties_with_http_info`	[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties # noqa: E501

create_chart_of_accounts(scope, chart_of_accounts_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts # noqa: E501

Create the given Chart of Accounts. # 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_chart_of_accounts(scope, chart_of_accounts_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
chart_of_accounts_request (ChartOfAccountsRequest) – The definition of the Chart of Accounts. (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:

ChartOfAccounts

create_chart_of_accounts_with_http_info(scope, chart_of_accounts_request, **kwargs)[source]

[EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts # noqa: E501

Create the given Chart of Accounts. # 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_chart_of_accounts_with_http_info(scope, chart_of_accounts_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
chart_of_accounts_request (ChartOfAccountsRequest) – The definition of the Chart of Accounts. (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(ChartOfAccounts, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module # noqa: E501

Create the given Cleardown Module. # 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_cleardown_module(scope, code, cleardown_module_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_request (CleardownModuleRequest) – The definition of the Cleardown Module. (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:

CleardownModuleResponse

create_cleardown_module_with_http_info(scope, code, cleardown_module_request, **kwargs)[source]

[EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module # noqa: E501

Create the given Cleardown Module. # 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_cleardown_module_with_http_info(scope, code, cleardown_module_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_request (CleardownModuleRequest) – The definition of the Cleardown Module. (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(CleardownModuleResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile. # noqa: E501

Create the given General Ledger profile. # 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_general_ledger_profile(scope, code, general_ledger_profile_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. (required)
general_ledger_profile_request (GeneralLedgerProfileRequest) – The definition of the General Ledger Profile. (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:

GeneralLedgerProfileResponse

create_general_ledger_profile_with_http_info(scope, code, general_ledger_profile_request, **kwargs)[source]

[EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile. # noqa: E501

Create the given General Ledger profile. # 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_general_ledger_profile_with_http_info(scope, code, general_ledger_profile_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. (required)
general_ledger_profile_request (GeneralLedgerProfileRequest) – The definition of the General Ledger Profile. (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(GeneralLedgerProfileResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] CreatePostingModule: Create a Posting Module # noqa: E501

Create the given Posting Module. # 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_posting_module(scope, code, posting_module_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_request (PostingModuleRequest) – The definition of the Posting Module. (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:

PostingModuleResponse

create_posting_module_with_http_info(scope, code, posting_module_request, **kwargs)[source]

[EXPERIMENTAL] CreatePostingModule: Create a Posting Module # noqa: E501

Create the given Posting Module. # 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_posting_module_with_http_info(scope, code, posting_module_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_request (PostingModuleRequest) – The definition of the Posting Module. (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(PostingModuleResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts # noqa: E501

Delete one or more account from the Chart of Accounts. Soft deletion marks the account as inactive While the Hard deletion is deleting the account. The maximum number of accounts that this method can delete per request is 2,000. # 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_accounts(scope, code, request_body, delete_mode, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
request_body (List[str]) – The codes of the accounts to delete. (required)
delete_mode (str) – The delete mode to use (defaults to ‘Soft’).
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:

DeleteAccountsResponse

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

[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts # noqa: E501

Delete one or more account from the Chart of Accounts. Soft deletion marks the account as inactive While the Hard deletion is deleting the account. The maximum number of accounts that this method can delete per request is 2,000. # 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_accounts_with_http_info(scope, code, request_body, delete_mode, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
request_body (List[str]) – The codes of the accounts to delete. (required)
delete_mode (str) – The delete mode to use (defaults to ‘Soft’).
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(DeleteAccountsResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts to be deleted. (required)
code (str) – The code of the Chart of Accounts to be deleted. Together with the scope this uniquely identifies the Chart of Accounts. (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_chart_of_accounts_with_http_info(scope, code, **kwargs)[source]

[EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts to be deleted. (required)
code (str) – The code of the Chart of Accounts to be deleted. Together with the scope this uniquely identifies the Chart of Accounts. (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))

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

[EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module. # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module to be deleted. (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_cleardown_module_with_http_info(scope, code, cleardown_module_code, **kwargs)[source]

[EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module. # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module 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 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))

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

[EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile. # noqa: E501

Delete the given General Ledger Profile. # 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_general_ledger_profile(scope, code, general_ledger_profile_code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts for the General Ledger Profile. (required)
code (str) – The code of the Chart of Accounts for the General Ledger Profile. (required)
general_ledger_profile_code (str) – The Code of the General Ledger Profile. (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_general_ledger_profile_with_http_info(scope, code, general_ledger_profile_code, **kwargs)[source]

[EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile. # noqa: E501

Delete the given General Ledger Profile. # 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_general_ledger_profile_with_http_info(scope, code, general_ledger_profile_code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts for the General Ledger Profile. (required)
code (str) – The code of the Chart of Accounts for the General Ledger Profile. (required)
general_ledger_profile_code (str) – The Code of the General Ledger Profile. (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))

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

[EXPERIMENTAL] DeletePostingModule: Delete a Posting Module. # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module to be deleted. (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_posting_module_with_http_info(scope, code, posting_module_code, **kwargs)[source]

[EXPERIMENTAL] DeletePostingModule: Delete a Posting Module. # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module 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 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_account(scope, code, account_code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetAccount: Get Account # noqa: E501

Retrieve the definition of a particular Account which is part of a Chart of Accounts. # 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_account(scope, code, account_code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
account_code (str) – The code of the Account. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Account’ domain to decorate onto the Account. These must take the format {domain}/{scope}/{code}, for example ‘Account/Manager/Id’. If not provided will return all the entitled properties for that Account.
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:

Account

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

[EXPERIMENTAL] GetAccount: Get Account # noqa: E501

Retrieve the definition of a particular Account which is part of a Chart of Accounts. # 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_account_with_http_info(scope, code, account_code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
account_code (str) – The code of the Account. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Account’ domain to decorate onto the Account. These must take the format {domain}/{scope}/{code}, for example ‘Account/Manager/Id’. If not provided will return all the entitled properties for that Account.
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(Account, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Chart of Accounts properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Chart of Accounts definition. Defaults to returning the latest version of the Chart of Accounts definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘ChartOfAccounts’ domain to decorate onto the Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example ‘ChartOfAccounts/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:

ChartOfAccounts

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

[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Chart of Accounts properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Chart of Accounts definition. Defaults to returning the latest version of the Chart of Accounts definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘ChartOfAccounts’ domain to decorate onto the Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example ‘ChartOfAccounts/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(ChartOfAccounts, status_code(int), headers(HTTPHeaderDict))

get_cleardown_module(scope, code, cleardown_module_code, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module # noqa: E501

Retrieve the definition of a Cleardown Module complete with its 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_cleardown_module(scope, code, cleardown_module_code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Cleardown Module. Defaults to return the latest version of the Cleardown Module if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

CleardownModuleResponse

get_cleardown_module_with_http_info(scope, code, cleardown_module_code, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module # noqa: E501

Retrieve the definition of a Cleardown Module complete with its 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_cleardown_module_with_http_info(scope, code, cleardown_module_code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

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

get_general_ledger_profile(scope, code, general_ledger_profile_code, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile. # noqa: E501

Get the given General Ledger Profile. # 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_general_ledger_profile(scope, code, general_ledger_profile_code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts for the General Ledger Profile. (required)
code (str) – The code of the Chart of Accounts for the General Ledger Profile. (required)
general_ledger_profile_code (str) – The General Ledger Profile Code of the General Ledger Profile. (required)
as_at (datetime) – The asAt datetime at which to retrieve the General Ledger Profile. Defaults to return the latest version of the General Ledger Profile if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

GeneralLedgerProfileResponse

get_general_ledger_profile_with_http_info(scope, code, general_ledger_profile_code, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile. # noqa: E501

Get the given General Ledger Profile. # 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_general_ledger_profile_with_http_info(scope, code, general_ledger_profile_code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts for the General Ledger Profile. (required)
code (str) – The code of the Chart of Accounts for the General Ledger Profile. (required)
general_ledger_profile_code (str) – The General Ledger Profile Code of the General Ledger Profile. (required)
as_at (datetime) – The asAt datetime at which to retrieve the General Ledger Profile. Defaults to return the latest version of the General Ledger Profile if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

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

Return type:

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

get_posting_module(scope, code, posting_module_code, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetPostingModule: Get a Posting Module # noqa: E501

Retrieve the definition of a Posting Module complete with its 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_posting_module(scope, code, posting_module_code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Posting Module. Defaults to return the latest version of the Posting Module if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

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

Return type:

PostingModuleResponse

get_posting_module_with_http_info(scope, code, posting_module_code, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetPostingModule: Get a Posting Module # noqa: E501

Retrieve the definition of a Posting Module complete with its 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_posting_module_with_http_info(scope, code, posting_module_code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

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

Returns:

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

Return type:

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

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

[EXPERIMENTAL] ListAccounts: List Accounts # noqa: E501

List the accounts in a Chart of Accounts # 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_accounts(scope, code, effective_at, as_at, page, limit, filter, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties decorated on Accounts. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing charts of accounts; 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 Account type, specify “code eq ‘001’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
property_keys (List[str]) – A list of property keys from the ‘Account’ domain to decorate onto the Account. These must have the format {domain}/{scope}/{code}, for example ‘Account/system/Name’.
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:

PagedResourceListOfAccount

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

[EXPERIMENTAL] ListAccounts: List Accounts # noqa: E501

List the accounts in a Chart of Accounts # 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_accounts_with_http_info(scope, code, effective_at, as_at, page, limit, filter, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties decorated on Accounts. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing charts of accounts; 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 Account type, specify “code eq ‘001’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
property_keys (List[str]) – A list of property keys from the ‘Account’ domain to decorate onto the Account. These must have the format {domain}/{scope}/{code}, for example ‘Account/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 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(PagedResourceListOfAccount, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts # noqa: E501

List all the Charts of Accounts 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_charts_of_accounts(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 Chart Of Accounts. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the charts of accounts. Defaults to returning the latest version of each Chart of Accounts if not specified.
page (str) – The pagination token to use to continue listing charts of accounts; 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 Chart of Accounts type, specify “id.Code eq ‘001’”. 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 ‘ChartOfAccounts’ domain to decorate onto each Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example ‘ChartOfAccounts/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:

PagedResourceListOfChartOfAccounts

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

[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts # noqa: E501

List all the Charts of Accounts 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_charts_of_accounts_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 Chart Of Accounts. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the charts of accounts. Defaults to returning the latest version of each Chart of Accounts if not specified.
page (str) – The pagination token to use to continue listing charts of accounts; 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 Chart of Accounts type, specify “id.Code eq ‘001’”. 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 ‘ChartOfAccounts’ domain to decorate onto each Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example ‘ChartOfAccounts/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(PagedResourceListOfChartOfAccounts, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules # noqa: E501

List the Rules in a Cleardown Module # 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_cleardown_module_rules(scope, code, cleardown_module_code, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the cleardown module. (required)
as_at (datetime) – The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing cleardown module rules; 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 results. For example, to filter on the rule id, specify “ruleId eq ‘rule 1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
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:

PagedResourceListOfCleardownModuleRule

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

[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules # noqa: E501

List the Rules in a Cleardown Module # 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_cleardown_module_rules_with_http_info(scope, code, cleardown_module_code, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the cleardown module. (required)
as_at (datetime) – The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing cleardown module rules; 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 results. For example, to filter on the rule id, specify “ruleId eq ‘rule 1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
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(PagedResourceListOfCleardownModuleRule, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules # noqa: E501

List all the Cleardown Modules 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_cleardown_modules(scope, code, as_at, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
as_at (datetime) – The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.
page (str) – The pagination token to use to continue listing Cleardown Modules; 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 Cleardown Module status, specify “status eq ‘Active’”. 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”.
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:

PagedResourceListOfCleardownModuleResponse

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

[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules # noqa: E501

List all the Cleardown Modules 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_cleardown_modules_with_http_info(scope, code, as_at, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
as_at (datetime) – The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.
page (str) – The pagination token to use to continue listing Cleardown Modules; 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 Cleardown Module status, specify “status eq ‘Active’”. 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”.
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(PagedResourceListOfCleardownModuleResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles. # noqa: E501

List all the General Ledger profiles 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_general_ledger_profiles(scope, code, as_at, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts (required)
code (str) – The code of the Chart of Accounts (required)
as_at (datetime) – The asAt datetime at which to list the General Ledger Profiles. Defaults to returning the latest version of each General Ledger Profile if not specified.
page (str) – The pagination token to use to continue listing General Ledger Profiles; 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 General Ledger profiles 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”.
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:

PagedResourceListOfGeneralLedgerProfileResponse

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

[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles. # noqa: E501

List all the General Ledger profiles 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_general_ledger_profiles_with_http_info(scope, code, as_at, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts (required)
code (str) – The code of the Chart of Accounts (required)
as_at (datetime) – The asAt datetime at which to list the General Ledger Profiles. Defaults to returning the latest version of each General Ledger Profile if not specified.
page (str) – The pagination token to use to continue listing General Ledger Profiles; 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 General Ledger profiles 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”.
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(PagedResourceListOfGeneralLedgerProfileResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules # noqa: E501

List the Rules in a Posting Module # 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_posting_module_rules(scope, code, posting_module_code, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the posting module. (required)
as_at (datetime) – The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing posting module rules; 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 results. For example, to filter on the rule id, specify “ruleId eq ‘rule 1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
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:

PagedResourceListOfPostingModuleRule

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

[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules # noqa: E501

List the Rules in a Posting Module # 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_posting_module_rules_with_http_info(scope, code, posting_module_code, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the posting module. (required)
as_at (datetime) – The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing posting module rules; 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 results. For example, to filter on the rule id, specify “ruleId eq ‘rule 1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
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(PagedResourceListOfPostingModuleRule, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListPostingModules: List Posting Modules # noqa: E501

List all the Posting Modules 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_posting_modules(scope, code, as_at, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
as_at (datetime) – The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.
page (str) – The pagination token to use to continue listing Posting Modules; 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 Posting Module status, specify “status eq ‘Active’”. 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”.
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:

PagedResourceListOfPostingModuleResponse

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

[EXPERIMENTAL] ListPostingModules: List Posting Modules # noqa: E501

List all the Posting Modules 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_posting_modules_with_http_info(scope, code, as_at, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
as_at (datetime) – The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.
page (str) – The pagination token to use to continue listing Posting Modules; 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 Posting Module status, specify “status eq ‘Active’”. 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”.
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(PagedResourceListOfPostingModuleResponse, status_code(int), headers(HTTPHeaderDict))

set_cleardown_module_details(scope, code, cleardown_module_code, cleardown_module_details, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module # noqa: E501

Update the given Cleardown Module details. # 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_cleardown_module_details(scope, code, cleardown_module_code, cleardown_module_details, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module to be updated. (required)
cleardown_module_details (CleardownModuleDetails) – The new details for the Cleardown Module. (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:

CleardownModuleResponse

set_cleardown_module_details_with_http_info(scope, code, cleardown_module_code, cleardown_module_details, **kwargs)[source]

[EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module # noqa: E501

Update the given Cleardown Module details. # 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_cleardown_module_details_with_http_info(scope, code, cleardown_module_code, cleardown_module_details, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module to be updated. (required)
cleardown_module_details (CleardownModuleDetails) – The new details for the Cleardown Module. (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(CleardownModuleResponse, status_code(int), headers(HTTPHeaderDict))

set_cleardown_module_rules(scope, code, cleardown_module_code, cleardown_module_rule, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module # noqa: E501

Set the given Cleardown Modules rules, this will replace the existing set of rules for the cleardown module. # 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_cleardown_module_rules(scope, code, cleardown_module_code, cleardown_module_rule, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module to be updated. (required)
cleardown_module_rule (List[CleardownModuleRule]) – The new rule set for the Cleardown Module. (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:

CleardownModuleRulesUpdatedResponse

set_cleardown_module_rules_with_http_info(scope, code, cleardown_module_code, cleardown_module_rule, **kwargs)[source]

[EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module # noqa: E501

Set the given Cleardown Modules rules, this will replace the existing set of rules for the cleardown module. # 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_cleardown_module_rules_with_http_info(scope, code, cleardown_module_code, cleardown_module_rule, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
cleardown_module_code (str) – The code of the Cleardown Module to be updated. (required)
cleardown_module_rule (List[CleardownModuleRule]) – The new rule set for the Cleardown Module. (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(CleardownModuleRulesUpdatedResponse, status_code(int), headers(HTTPHeaderDict))

set_general_ledger_profile_mappings(scope, code, general_ledger_profile_code, general_ledger_profile_mapping, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings. # noqa: E501

Update the given General Ledger profile Mappings. # 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_general_ledger_profile_mappings(scope, code, general_ledger_profile_code, general_ledger_profile_mapping, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. (required)
general_ledger_profile_code (str) – The code of the General Ledger Profile (required)
general_ledger_profile_mapping (List[GeneralLedgerProfileMapping]) – The updated General Ledger Profile Mappings, the previous mappings will be wholly replaced with this data. Mappings will be evaluated in the order they are provided. (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:

GeneralLedgerProfileResponse

set_general_ledger_profile_mappings_with_http_info(scope, code, general_ledger_profile_code, general_ledger_profile_mapping, **kwargs)[source]

[EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings. # noqa: E501

Update the given General Ledger profile Mappings. # 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_general_ledger_profile_mappings_with_http_info(scope, code, general_ledger_profile_code, general_ledger_profile_mapping, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. (required)
general_ledger_profile_code (str) – The code of the General Ledger Profile (required)
general_ledger_profile_mapping (List[GeneralLedgerProfileMapping]) – The updated General Ledger Profile Mappings, the previous mappings will be wholly replaced with this data. Mappings will be evaluated in the order they are provided. (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(GeneralLedgerProfileResponse, status_code(int), headers(HTTPHeaderDict))

set_posting_module_details(scope, code, posting_module_code, posting_module_details, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module # noqa: E501

Update the given Posting Module details. # 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_posting_module_details(scope, code, posting_module_code, posting_module_details, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module to be updated. (required)
posting_module_details (PostingModuleDetails) – The new details for the Posting Module. (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:

PostingModuleResponse

set_posting_module_details_with_http_info(scope, code, posting_module_code, posting_module_details, **kwargs)[source]

[EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module # noqa: E501

Update the given Posting Module details. # 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_posting_module_details_with_http_info(scope, code, posting_module_code, posting_module_details, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module to be updated. (required)
posting_module_details (PostingModuleDetails) – The new details for the Posting Module. (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(PostingModuleResponse, status_code(int), headers(HTTPHeaderDict))

set_posting_module_rules(scope, code, posting_module_code, posting_module_rule, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module # noqa: E501

Set the given Posting Modules rules, this will replace the existing set of rules for the posting module. # 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_posting_module_rules(scope, code, posting_module_code, posting_module_rule, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module to be updated. (required)
posting_module_rule (List[PostingModuleRule]) – The new rule set for the Posting Module. (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:

PostingModuleRulesUpdatedResponse

set_posting_module_rules_with_http_info(scope, code, posting_module_code, posting_module_rule, **kwargs)[source]

[EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module # noqa: E501

Set the given Posting Modules rules, this will replace the existing set of rules for the posting module. # 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_posting_module_rules_with_http_info(scope, code, posting_module_code, posting_module_rule, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
posting_module_code (str) – The code of the Posting Module to be updated. (required)
posting_module_rule (List[PostingModuleRule]) – The new rule set for the Posting Module. (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(PostingModuleRulesUpdatedResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts to update or insert the properties onto. (required)
code (str) – The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. (required)
account_code (str) – The unique ID of the account to create or update properties for. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Account/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:

AccountProperties

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

[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts to update or insert the properties onto. (required)
code (str) – The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. (required)
account_code (str) – The unique ID of the account to create or update properties for. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Account/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(AccountProperties, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] UpsertAccounts: Upsert Accounts # noqa: E501

Create or update accounts in the Chart of Accounts. An account will be updated if it already exists and created if it does not. The maximum number of accounts that this method can upsert per request is 2,000. # 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_accounts(scope, code, account, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
account (List[Account]) – A list of accounts to be created or updated. (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:

AccountsUpsertResponse

upsert_accounts_with_http_info(scope, code, account, **kwargs)[source]

[EXPERIMENTAL] UpsertAccounts: Upsert Accounts # noqa: E501

Create or update accounts in the Chart of Accounts. An account will be updated if it already exists and created if it does not. The maximum number of accounts that this method can upsert per request is 2,000. # 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_accounts_with_http_info(scope, code, account, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Chart of Accounts. (required)
code (str) – The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
account (List[Account]) – A list of accounts to be created or updated. (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(AccountsUpsertResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts to update or insert the properties onto. (required)
code (str) – The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “ChartOfAccounts/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:

ChartOfAccountsProperties

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

[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties # noqa: E501

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

Parameters:

scope (str) – The scope of the Chart of Accounts to update or insert the properties onto. (required)
code (str) – The code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “ChartOfAccounts/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(ChartOfAccountsProperties, status_code(int), headers(HTTPHeaderDict))