lusid-sdk 2.1.912__py3-none-any.whl → 2.1.914__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +139 -130
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_calendar_entry.py +21 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +1 -1
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/transaction_settlement_instruction.py +5 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_fund_bookmark_request.py +3 -3
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/RECORD +333 -333
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/WHEEL +0 -0
@@ -776,18 +776,18 @@ class ChartOfAccountsApi:
|
|
776
776
|
|
777
777
|
|
778
778
|
@overload
|
779
|
-
async def delete_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
779
|
+
async def delete_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The codes of the accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, **kwargs) -> DeleteAccountsResponse: # noqa: E501
|
780
780
|
...
|
781
781
|
|
782
782
|
@overload
|
783
|
-
def delete_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
783
|
+
def delete_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The codes of the accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteAccountsResponse: # noqa: E501
|
784
784
|
...
|
785
785
|
|
786
786
|
@validate_arguments
|
787
|
-
def delete_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
787
|
+
def delete_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The codes of the accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteAccountsResponse, Awaitable[DeleteAccountsResponse]]: # noqa: E501
|
788
788
|
"""[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts # noqa: E501
|
789
789
|
|
790
|
-
Delete one or more account from the Chart of Accounts. Soft deletion marks the account as inactive
|
790
|
+
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
|
791
791
|
This method makes a synchronous HTTP request by default. To make an
|
792
792
|
asynchronous HTTP request, please pass async_req=True
|
793
793
|
|
@@ -796,7 +796,7 @@ class ChartOfAccountsApi:
|
|
796
796
|
|
797
797
|
:param scope: The scope of the Chart of Accounts. (required)
|
798
798
|
:type scope: str
|
799
|
-
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
799
|
+
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
800
800
|
:type code: str
|
801
801
|
:param request_body: The codes of the accounts to delete. (required)
|
802
802
|
:type request_body: List[str]
|
@@ -821,10 +821,10 @@ class ChartOfAccountsApi:
|
|
821
821
|
return self.delete_accounts_with_http_info(scope, code, request_body, delete_mode, **kwargs) # noqa: E501
|
822
822
|
|
823
823
|
@validate_arguments
|
824
|
-
def delete_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
824
|
+
def delete_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The codes of the accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
825
825
|
"""[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts # noqa: E501
|
826
826
|
|
827
|
-
Delete one or more account from the Chart of Accounts. Soft deletion marks the account as inactive
|
827
|
+
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
|
828
828
|
This method makes a synchronous HTTP request by default. To make an
|
829
829
|
asynchronous HTTP request, please pass async_req=True
|
830
830
|
|
@@ -833,7 +833,7 @@ class ChartOfAccountsApi:
|
|
833
833
|
|
834
834
|
:param scope: The scope of the Chart of Accounts. (required)
|
835
835
|
:type scope: str
|
836
|
-
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
836
|
+
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
837
837
|
:type code: str
|
838
838
|
:param request_body: The codes of the accounts to delete. (required)
|
839
839
|
:type request_body: List[str]
|
@@ -1623,15 +1623,15 @@ class ChartOfAccountsApi:
|
|
1623
1623
|
|
1624
1624
|
|
1625
1625
|
@overload
|
1626
|
-
async def get_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Account' domain to decorate onto the Account.
|
1626
|
+
async def get_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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 no properties are specified, then no properties will be returned.")] = None, **kwargs) -> Account: # noqa: E501
|
1627
1627
|
...
|
1628
1628
|
|
1629
1629
|
@overload
|
1630
|
-
def get_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Account' domain to decorate onto the Account.
|
1630
|
+
def get_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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 no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=True, **kwargs) -> Account: # noqa: E501
|
1631
1631
|
...
|
1632
1632
|
|
1633
1633
|
@validate_arguments
|
1634
|
-
def get_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Account' domain to decorate onto the Account.
|
1634
|
+
def get_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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 no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Account, Awaitable[Account]]: # noqa: E501
|
1635
1635
|
"""[EXPERIMENTAL] GetAccount: Get Account # noqa: E501
|
1636
1636
|
|
1637
1637
|
Retrieve the definition of a particular Account which is part of a Chart of Accounts. # noqa: E501
|
@@ -1651,7 +1651,7 @@ class ChartOfAccountsApi:
|
|
1651
1651
|
:type effective_at: str
|
1652
1652
|
:param as_at: The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.
|
1653
1653
|
:type as_at: datetime
|
1654
|
-
:param property_keys: A list of property keys from the 'Account' domain to decorate onto the Account.
|
1654
|
+
:param property_keys: 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 no properties are specified, then no properties will be returned.
|
1655
1655
|
:type property_keys: List[str]
|
1656
1656
|
:param async_req: Whether to execute the request asynchronously.
|
1657
1657
|
:type async_req: bool, optional
|
@@ -1672,7 +1672,7 @@ class ChartOfAccountsApi:
|
|
1672
1672
|
return self.get_account_with_http_info(scope, code, account_code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
|
1673
1673
|
|
1674
1674
|
@validate_arguments
|
1675
|
-
def get_account_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Account' domain to decorate onto the Account.
|
1675
|
+
def get_account_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account_code : Annotated[StrictStr, Field(..., description="The code of the Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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 no properties are specified, then no properties will be returned.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1676
1676
|
"""[EXPERIMENTAL] GetAccount: Get Account # noqa: E501
|
1677
1677
|
|
1678
1678
|
Retrieve the definition of a particular Account which is part of a Chart of Accounts. # noqa: E501
|
@@ -1692,7 +1692,7 @@ class ChartOfAccountsApi:
|
|
1692
1692
|
:type effective_at: str
|
1693
1693
|
:param as_at: The asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified.
|
1694
1694
|
:type as_at: datetime
|
1695
|
-
:param property_keys: A list of property keys from the 'Account' domain to decorate onto the Account.
|
1695
|
+
:param property_keys: 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 no properties are specified, then no properties will be returned.
|
1696
1696
|
:type property_keys: List[str]
|
1697
1697
|
:param async_req: Whether to execute the request asynchronously.
|
1698
1698
|
:type async_req: bool, optional
|
@@ -2006,15 +2006,15 @@ class ChartOfAccountsApi:
|
|
2006
2006
|
|
2007
2007
|
|
2008
2008
|
@overload
|
2009
|
-
async def get_chart_of_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ChartOfAccounts' domain to decorate onto the Chart of Accounts.
|
2009
|
+
async def get_chart_of_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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.")] = None, **kwargs) -> ChartOfAccounts: # noqa: E501
|
2010
2010
|
...
|
2011
2011
|
|
2012
2012
|
@overload
|
2013
|
-
def get_chart_of_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ChartOfAccounts' domain to decorate onto the Chart of Accounts.
|
2013
|
+
def get_chart_of_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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.")] = None, async_req: Optional[bool]=True, **kwargs) -> ChartOfAccounts: # noqa: E501
|
2014
2014
|
...
|
2015
2015
|
|
2016
2016
|
@validate_arguments
|
2017
|
-
def get_chart_of_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ChartOfAccounts' domain to decorate onto the Chart of Accounts.
|
2017
|
+
def get_chart_of_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ChartOfAccounts, Awaitable[ChartOfAccounts]]: # noqa: E501
|
2018
2018
|
"""[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts # noqa: E501
|
2019
2019
|
|
2020
2020
|
Retrieve the definition of a particular Chart of Accounts. # noqa: E501
|
@@ -2032,7 +2032,7 @@ class ChartOfAccountsApi:
|
|
2032
2032
|
:type effective_at: str
|
2033
2033
|
:param as_at: 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.
|
2034
2034
|
:type as_at: datetime
|
2035
|
-
:param property_keys: A list of property keys from the 'ChartOfAccounts' domain to decorate onto the Chart of Accounts.
|
2035
|
+
:param property_keys: 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.
|
2036
2036
|
:type property_keys: List[str]
|
2037
2037
|
:param async_req: Whether to execute the request asynchronously.
|
2038
2038
|
:type async_req: bool, optional
|
@@ -2053,7 +2053,7 @@ class ChartOfAccountsApi:
|
|
2053
2053
|
return self.get_chart_of_accounts_with_http_info(scope, code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
|
2054
2054
|
|
2055
2055
|
@validate_arguments
|
2056
|
-
def get_chart_of_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ChartOfAccounts' domain to decorate onto the Chart of Accounts.
|
2056
|
+
def get_chart_of_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2057
2057
|
"""[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts # noqa: E501
|
2058
2058
|
|
2059
2059
|
Retrieve the definition of a particular Chart of Accounts. # noqa: E501
|
@@ -2071,7 +2071,7 @@ class ChartOfAccountsApi:
|
|
2071
2071
|
:type effective_at: str
|
2072
2072
|
:param as_at: 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.
|
2073
2073
|
:type as_at: datetime
|
2074
|
-
:param property_keys: A list of property keys from the 'ChartOfAccounts' domain to decorate onto the Chart of Accounts.
|
2074
|
+
:param property_keys: 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.
|
2075
2075
|
:type property_keys: List[str]
|
2076
2076
|
:param async_req: Whether to execute the request asynchronously.
|
2077
2077
|
:type async_req: bool, optional
|
@@ -2910,15 +2910,15 @@ class ChartOfAccountsApi:
|
|
2910
2910
|
|
2911
2911
|
|
2912
2912
|
@overload
|
2913
|
-
async def list_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
2913
|
+
async def list_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, **kwargs) -> PagedResourceListOfAccount: # noqa: E501
|
2914
2914
|
...
|
2915
2915
|
|
2916
2916
|
@overload
|
2917
|
-
def list_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
2917
|
+
def list_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfAccount: # noqa: E501
|
2918
2918
|
...
|
2919
2919
|
|
2920
2920
|
@validate_arguments
|
2921
|
-
def list_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
2921
|
+
def list_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfAccount, Awaitable[PagedResourceListOfAccount]]: # noqa: E501
|
2922
2922
|
"""[EXPERIMENTAL] ListAccounts: List Accounts # noqa: E501
|
2923
2923
|
|
2924
2924
|
List the accounts in a Chart of Accounts # noqa: E501
|
@@ -2930,19 +2930,19 @@ class ChartOfAccountsApi:
|
|
2930
2930
|
|
2931
2931
|
:param scope: The scope of the Chart of Accounts. (required)
|
2932
2932
|
:type scope: str
|
2933
|
-
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
2933
|
+
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
2934
2934
|
:type code: str
|
2935
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties decorated on Accounts. Defaults to the current LUSID
|
2935
|
+
:param effective_at: 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.
|
2936
2936
|
:type effective_at: str
|
2937
|
-
:param as_at: The asAt datetime at which to retrieve the Accounts. Defaults to
|
2937
|
+
:param as_at: The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.
|
2938
2938
|
:type as_at: datetime
|
2939
|
-
:param page: The pagination token to use to continue listing charts of accounts; this
|
2939
|
+
:param page: 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.
|
2940
2940
|
:type page: str
|
2941
2941
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
2942
2942
|
:type limit: int
|
2943
|
-
:param filter: Expression to filter the results.
|
2943
|
+
:param filter: 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.
|
2944
2944
|
:type filter: str
|
2945
|
-
:param property_keys: A list of property keys from the 'Account' domain to decorate onto the Account.
|
2945
|
+
:param property_keys: 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'.
|
2946
2946
|
:type property_keys: List[str]
|
2947
2947
|
:param async_req: Whether to execute the request asynchronously.
|
2948
2948
|
:type async_req: bool, optional
|
@@ -2963,7 +2963,7 @@ class ChartOfAccountsApi:
|
|
2963
2963
|
return self.list_accounts_with_http_info(scope, code, effective_at, as_at, page, limit, filter, property_keys, **kwargs) # noqa: E501
|
2964
2964
|
|
2965
2965
|
@validate_arguments
|
2966
|
-
def list_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
2966
|
+
def list_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2967
2967
|
"""[EXPERIMENTAL] ListAccounts: List Accounts # noqa: E501
|
2968
2968
|
|
2969
2969
|
List the accounts in a Chart of Accounts # noqa: E501
|
@@ -2975,19 +2975,19 @@ class ChartOfAccountsApi:
|
|
2975
2975
|
|
2976
2976
|
:param scope: The scope of the Chart of Accounts. (required)
|
2977
2977
|
:type scope: str
|
2978
|
-
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
2978
|
+
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
2979
2979
|
:type code: str
|
2980
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties decorated on Accounts. Defaults to the current LUSID
|
2980
|
+
:param effective_at: 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.
|
2981
2981
|
:type effective_at: str
|
2982
|
-
:param as_at: The asAt datetime at which to retrieve the Accounts. Defaults to
|
2982
|
+
:param as_at: The asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified.
|
2983
2983
|
:type as_at: datetime
|
2984
|
-
:param page: The pagination token to use to continue listing charts of accounts; this
|
2984
|
+
:param page: 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.
|
2985
2985
|
:type page: str
|
2986
2986
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
2987
2987
|
:type limit: int
|
2988
|
-
:param filter: Expression to filter the results.
|
2988
|
+
:param filter: 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.
|
2989
2989
|
:type filter: str
|
2990
|
-
:param property_keys: A list of property keys from the 'Account' domain to decorate onto the Account.
|
2990
|
+
:param property_keys: 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'.
|
2991
2991
|
:type property_keys: List[str]
|
2992
2992
|
:param async_req: Whether to execute the request asynchronously.
|
2993
2993
|
:type async_req: bool, optional
|
@@ -3122,15 +3122,15 @@ class ChartOfAccountsApi:
|
|
3122
3122
|
|
3123
3123
|
|
3124
3124
|
@overload
|
3125
|
-
async def list_charts_of_accounts(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID
|
3125
|
+
async def list_charts_of_accounts(self, effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, **kwargs) -> PagedResourceListOfChartOfAccounts: # noqa: E501
|
3126
3126
|
...
|
3127
3127
|
|
3128
3128
|
@overload
|
3129
|
-
def list_charts_of_accounts(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID
|
3129
|
+
def list_charts_of_accounts(self, effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfChartOfAccounts: # noqa: E501
|
3130
3130
|
...
|
3131
3131
|
|
3132
3132
|
@validate_arguments
|
3133
|
-
def list_charts_of_accounts(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID
|
3133
|
+
def list_charts_of_accounts(self, effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfChartOfAccounts, Awaitable[PagedResourceListOfChartOfAccounts]]: # noqa: E501
|
3134
3134
|
"""[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts # noqa: E501
|
3135
3135
|
|
3136
3136
|
List all the Charts of Accounts matching particular criteria. # noqa: E501
|
@@ -3140,19 +3140,19 @@ class ChartOfAccountsApi:
|
|
3140
3140
|
>>> thread = api.list_charts_of_accounts(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
|
3141
3141
|
>>> result = thread.get()
|
3142
3142
|
|
3143
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID
|
3143
|
+
:param effective_at: 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.
|
3144
3144
|
:type effective_at: str
|
3145
|
-
:param as_at: The asAt datetime at which to list the charts of accounts. Defaults to returning the latest version
|
3145
|
+
:param as_at: 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.
|
3146
3146
|
:type as_at: datetime
|
3147
|
-
:param page: The pagination token to use to continue listing charts of accounts; this
|
3147
|
+
:param page: 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.
|
3148
3148
|
:type page: str
|
3149
3149
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3150
3150
|
:type limit: int
|
3151
|
-
:param filter: Expression to filter the results.
|
3151
|
+
:param filter: 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.
|
3152
3152
|
:type filter: str
|
3153
3153
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3154
3154
|
:type sort_by: List[str]
|
3155
|
-
:param property_keys: A list of property keys from the 'ChartOfAccounts' domain to decorate onto each Chart of Accounts.
|
3155
|
+
:param property_keys: 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'.
|
3156
3156
|
:type property_keys: List[str]
|
3157
3157
|
:param async_req: Whether to execute the request asynchronously.
|
3158
3158
|
:type async_req: bool, optional
|
@@ -3173,7 +3173,7 @@ class ChartOfAccountsApi:
|
|
3173
3173
|
return self.list_charts_of_accounts_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
|
3174
3174
|
|
3175
3175
|
@validate_arguments
|
3176
|
-
def list_charts_of_accounts_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID
|
3176
|
+
def list_charts_of_accounts_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="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.")] = None, as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="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'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3177
3177
|
"""[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts # noqa: E501
|
3178
3178
|
|
3179
3179
|
List all the Charts of Accounts matching particular criteria. # noqa: E501
|
@@ -3183,19 +3183,19 @@ class ChartOfAccountsApi:
|
|
3183
3183
|
>>> thread = api.list_charts_of_accounts_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
|
3184
3184
|
>>> result = thread.get()
|
3185
3185
|
|
3186
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the Chart Of Accounts. Defaults to the current LUSID
|
3186
|
+
:param effective_at: 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.
|
3187
3187
|
:type effective_at: str
|
3188
|
-
:param as_at: The asAt datetime at which to list the charts of accounts. Defaults to returning the latest version
|
3188
|
+
:param as_at: 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.
|
3189
3189
|
:type as_at: datetime
|
3190
|
-
:param page: The pagination token to use to continue listing charts of accounts; this
|
3190
|
+
:param page: 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.
|
3191
3191
|
:type page: str
|
3192
3192
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3193
3193
|
:type limit: int
|
3194
|
-
:param filter: Expression to filter the results.
|
3194
|
+
:param filter: 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.
|
3195
3195
|
:type filter: str
|
3196
3196
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3197
3197
|
:type sort_by: List[str]
|
3198
|
-
:param property_keys: A list of property keys from the 'ChartOfAccounts' domain to decorate onto each Chart of Accounts.
|
3198
|
+
:param property_keys: 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'.
|
3199
3199
|
:type property_keys: List[str]
|
3200
3200
|
:param async_req: Whether to execute the request asynchronously.
|
3201
3201
|
:type async_req: bool, optional
|
@@ -3327,15 +3327,15 @@ class ChartOfAccountsApi:
|
|
3327
3327
|
|
3328
3328
|
|
3329
3329
|
@overload
|
3330
|
-
async def list_cleardown_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3330
|
+
async def list_cleardown_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, **kwargs) -> PagedResourceListOfCleardownModuleRule: # noqa: E501
|
3331
3331
|
...
|
3332
3332
|
|
3333
3333
|
@overload
|
3334
|
-
def list_cleardown_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3334
|
+
def list_cleardown_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCleardownModuleRule: # noqa: E501
|
3335
3335
|
...
|
3336
3336
|
|
3337
3337
|
@validate_arguments
|
3338
|
-
def list_cleardown_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3338
|
+
def list_cleardown_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCleardownModuleRule, Awaitable[PagedResourceListOfCleardownModuleRule]]: # noqa: E501
|
3339
3339
|
"""[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules # noqa: E501
|
3340
3340
|
|
3341
3341
|
List the Rules in a Cleardown Module # noqa: E501
|
@@ -3351,13 +3351,13 @@ class ChartOfAccountsApi:
|
|
3351
3351
|
:type code: str
|
3352
3352
|
:param cleardown_module_code: The code of the cleardown module. (required)
|
3353
3353
|
:type cleardown_module_code: str
|
3354
|
-
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to
|
3354
|
+
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
|
3355
3355
|
:type as_at: datetime
|
3356
|
-
:param page: The pagination token to use to continue listing cleardown module rules; this
|
3356
|
+
:param page: 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.
|
3357
3357
|
:type page: str
|
3358
3358
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3359
3359
|
:type limit: int
|
3360
|
-
:param filter: Expression to filter the results.
|
3360
|
+
:param filter: 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.
|
3361
3361
|
:type filter: str
|
3362
3362
|
:param async_req: Whether to execute the request asynchronously.
|
3363
3363
|
:type async_req: bool, optional
|
@@ -3378,7 +3378,7 @@ class ChartOfAccountsApi:
|
|
3378
3378
|
return self.list_cleardown_module_rules_with_http_info(scope, code, cleardown_module_code, as_at, page, limit, filter, **kwargs) # noqa: E501
|
3379
3379
|
|
3380
3380
|
@validate_arguments
|
3381
|
-
def list_cleardown_module_rules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3381
|
+
def list_cleardown_module_rules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], cleardown_module_code : Annotated[StrictStr, Field(..., description="The code of the cleardown module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3382
3382
|
"""[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules # noqa: E501
|
3383
3383
|
|
3384
3384
|
List the Rules in a Cleardown Module # noqa: E501
|
@@ -3394,13 +3394,13 @@ class ChartOfAccountsApi:
|
|
3394
3394
|
:type code: str
|
3395
3395
|
:param cleardown_module_code: The code of the cleardown module. (required)
|
3396
3396
|
:type cleardown_module_code: str
|
3397
|
-
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to
|
3397
|
+
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
|
3398
3398
|
:type as_at: datetime
|
3399
|
-
:param page: The pagination token to use to continue listing cleardown module rules; this
|
3399
|
+
:param page: 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.
|
3400
3400
|
:type page: str
|
3401
3401
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3402
3402
|
:type limit: int
|
3403
|
-
:param filter: Expression to filter the results.
|
3403
|
+
:param filter: 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.
|
3404
3404
|
:type filter: str
|
3405
3405
|
:param async_req: Whether to execute the request asynchronously.
|
3406
3406
|
:type async_req: bool, optional
|
@@ -3530,15 +3530,15 @@ class ChartOfAccountsApi:
|
|
3530
3530
|
|
3531
3531
|
|
3532
3532
|
@overload
|
3533
|
-
async def list_cleardown_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version
|
3533
|
+
async def list_cleardown_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> PagedResourceListOfCleardownModuleResponse: # noqa: E501
|
3534
3534
|
...
|
3535
3535
|
|
3536
3536
|
@overload
|
3537
|
-
def list_cleardown_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version
|
3537
|
+
def list_cleardown_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCleardownModuleResponse: # noqa: E501
|
3538
3538
|
...
|
3539
3539
|
|
3540
3540
|
@validate_arguments
|
3541
|
-
def list_cleardown_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version
|
3541
|
+
def list_cleardown_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCleardownModuleResponse, Awaitable[PagedResourceListOfCleardownModuleResponse]]: # noqa: E501
|
3542
3542
|
"""[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules # noqa: E501
|
3543
3543
|
|
3544
3544
|
List all the Cleardown Modules matching particular criteria. # noqa: E501
|
@@ -3552,13 +3552,13 @@ class ChartOfAccountsApi:
|
|
3552
3552
|
:type scope: str
|
3553
3553
|
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
3554
3554
|
:type code: str
|
3555
|
-
:param as_at: The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version
|
3555
|
+
:param as_at: The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.
|
3556
3556
|
:type as_at: datetime
|
3557
|
-
:param page: The pagination token to use to continue listing Cleardown Modules; this
|
3557
|
+
:param page: 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.
|
3558
3558
|
:type page: str
|
3559
3559
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3560
3560
|
:type limit: int
|
3561
|
-
:param filter: Expression to filter the results.
|
3561
|
+
:param filter: 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.
|
3562
3562
|
:type filter: str
|
3563
3563
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3564
3564
|
:type sort_by: List[str]
|
@@ -3581,7 +3581,7 @@ class ChartOfAccountsApi:
|
|
3581
3581
|
return self.list_cleardown_modules_with_http_info(scope, code, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
3582
3582
|
|
3583
3583
|
@validate_arguments
|
3584
|
-
def list_cleardown_modules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version
|
3584
|
+
def list_cleardown_modules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3585
3585
|
"""[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules # noqa: E501
|
3586
3586
|
|
3587
3587
|
List all the Cleardown Modules matching particular criteria. # noqa: E501
|
@@ -3595,13 +3595,13 @@ class ChartOfAccountsApi:
|
|
3595
3595
|
:type scope: str
|
3596
3596
|
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
3597
3597
|
:type code: str
|
3598
|
-
:param as_at: The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version
|
3598
|
+
:param as_at: The asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified.
|
3599
3599
|
:type as_at: datetime
|
3600
|
-
:param page: The pagination token to use to continue listing Cleardown Modules; this
|
3600
|
+
:param page: 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.
|
3601
3601
|
:type page: str
|
3602
3602
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3603
3603
|
:type limit: int
|
3604
|
-
:param filter: Expression to filter the results.
|
3604
|
+
:param filter: 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.
|
3605
3605
|
:type filter: str
|
3606
3606
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3607
3607
|
:type sort_by: List[str]
|
@@ -3734,15 +3734,15 @@ class ChartOfAccountsApi:
|
|
3734
3734
|
|
3735
3735
|
|
3736
3736
|
@overload
|
3737
|
-
async def list_general_ledger_profiles(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing General Ledger Profiles; this
|
3737
|
+
async def list_general_ledger_profiles(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> PagedResourceListOfGeneralLedgerProfileResponse: # noqa: E501
|
3738
3738
|
...
|
3739
3739
|
|
3740
3740
|
@overload
|
3741
|
-
def list_general_ledger_profiles(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing General Ledger Profiles; this
|
3741
|
+
def list_general_ledger_profiles(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfGeneralLedgerProfileResponse: # noqa: E501
|
3742
3742
|
...
|
3743
3743
|
|
3744
3744
|
@validate_arguments
|
3745
|
-
def list_general_ledger_profiles(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing General Ledger Profiles; this
|
3745
|
+
def list_general_ledger_profiles(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfGeneralLedgerProfileResponse, Awaitable[PagedResourceListOfGeneralLedgerProfileResponse]]: # noqa: E501
|
3746
3746
|
"""[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles. # noqa: E501
|
3747
3747
|
|
3748
3748
|
List all the General Ledger profiles matching particular criteria. # noqa: E501
|
@@ -3758,11 +3758,11 @@ class ChartOfAccountsApi:
|
|
3758
3758
|
:type code: str
|
3759
3759
|
:param as_at: 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.
|
3760
3760
|
:type as_at: datetime
|
3761
|
-
:param page: The pagination token to use to continue listing General Ledger Profiles; this
|
3761
|
+
:param page: 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.
|
3762
3762
|
:type page: str
|
3763
3763
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3764
3764
|
:type limit: int
|
3765
|
-
:param filter: Expression to filter the results.
|
3765
|
+
:param filter: 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.
|
3766
3766
|
:type filter: str
|
3767
3767
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3768
3768
|
:type sort_by: List[str]
|
@@ -3785,7 +3785,7 @@ class ChartOfAccountsApi:
|
|
3785
3785
|
return self.list_general_ledger_profiles_with_http_info(scope, code, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
3786
3786
|
|
3787
3787
|
@validate_arguments
|
3788
|
-
def list_general_ledger_profiles_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing General Ledger Profiles; this
|
3788
|
+
def list_general_ledger_profiles_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts")], as_at : Annotated[Optional[datetime], Field(description="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.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3789
3789
|
"""[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles. # noqa: E501
|
3790
3790
|
|
3791
3791
|
List all the General Ledger profiles matching particular criteria. # noqa: E501
|
@@ -3801,11 +3801,11 @@ class ChartOfAccountsApi:
|
|
3801
3801
|
:type code: str
|
3802
3802
|
:param as_at: 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.
|
3803
3803
|
:type as_at: datetime
|
3804
|
-
:param page: The pagination token to use to continue listing General Ledger Profiles; this
|
3804
|
+
:param page: 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.
|
3805
3805
|
:type page: str
|
3806
3806
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3807
3807
|
:type limit: int
|
3808
|
-
:param filter: Expression to filter the results.
|
3808
|
+
:param filter: 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.
|
3809
3809
|
:type filter: str
|
3810
3810
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3811
3811
|
:type sort_by: List[str]
|
@@ -3938,15 +3938,15 @@ class ChartOfAccountsApi:
|
|
3938
3938
|
|
3939
3939
|
|
3940
3940
|
@overload
|
3941
|
-
async def list_posting_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3941
|
+
async def list_posting_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, **kwargs) -> PagedResourceListOfPostingModuleRule: # noqa: E501
|
3942
3942
|
...
|
3943
3943
|
|
3944
3944
|
@overload
|
3945
|
-
def list_posting_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3945
|
+
def list_posting_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPostingModuleRule: # noqa: E501
|
3946
3946
|
...
|
3947
3947
|
|
3948
3948
|
@validate_arguments
|
3949
|
-
def list_posting_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3949
|
+
def list_posting_module_rules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPostingModuleRule, Awaitable[PagedResourceListOfPostingModuleRule]]: # noqa: E501
|
3950
3950
|
"""[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules # noqa: E501
|
3951
3951
|
|
3952
3952
|
List the Rules in a Posting Module # noqa: E501
|
@@ -3962,13 +3962,13 @@ class ChartOfAccountsApi:
|
|
3962
3962
|
:type code: str
|
3963
3963
|
:param posting_module_code: The code of the posting module. (required)
|
3964
3964
|
:type posting_module_code: str
|
3965
|
-
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to
|
3965
|
+
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
|
3966
3966
|
:type as_at: datetime
|
3967
|
-
:param page: The pagination token to use to continue listing posting module rules; this
|
3967
|
+
:param page: 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.
|
3968
3968
|
:type page: str
|
3969
3969
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3970
3970
|
:type limit: int
|
3971
|
-
:param filter: Expression to filter the results.
|
3971
|
+
:param filter: 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.
|
3972
3972
|
:type filter: str
|
3973
3973
|
:param async_req: Whether to execute the request asynchronously.
|
3974
3974
|
:type async_req: bool, optional
|
@@ -3989,7 +3989,7 @@ class ChartOfAccountsApi:
|
|
3989
3989
|
return self.list_posting_module_rules_with_http_info(scope, code, posting_module_code, as_at, page, limit, filter, **kwargs) # noqa: E501
|
3990
3990
|
|
3991
3991
|
@validate_arguments
|
3992
|
-
def list_posting_module_rules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to
|
3992
|
+
def list_posting_module_rules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], posting_module_code : Annotated[StrictStr, Field(..., description="The code of the posting module.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3993
3993
|
"""[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules # noqa: E501
|
3994
3994
|
|
3995
3995
|
List the Rules in a Posting Module # noqa: E501
|
@@ -4005,13 +4005,13 @@ class ChartOfAccountsApi:
|
|
4005
4005
|
:type code: str
|
4006
4006
|
:param posting_module_code: The code of the posting module. (required)
|
4007
4007
|
:type posting_module_code: str
|
4008
|
-
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to
|
4008
|
+
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
|
4009
4009
|
:type as_at: datetime
|
4010
|
-
:param page: The pagination token to use to continue listing posting module rules; this
|
4010
|
+
:param page: 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.
|
4011
4011
|
:type page: str
|
4012
4012
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4013
4013
|
:type limit: int
|
4014
|
-
:param filter: Expression to filter the results.
|
4014
|
+
:param filter: 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.
|
4015
4015
|
:type filter: str
|
4016
4016
|
:param async_req: Whether to execute the request asynchronously.
|
4017
4017
|
:type async_req: bool, optional
|
@@ -4141,15 +4141,15 @@ class ChartOfAccountsApi:
|
|
4141
4141
|
|
4142
4142
|
|
4143
4143
|
@overload
|
4144
|
-
async def list_posting_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version
|
4144
|
+
async def list_posting_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> PagedResourceListOfPostingModuleResponse: # noqa: E501
|
4145
4145
|
...
|
4146
4146
|
|
4147
4147
|
@overload
|
4148
|
-
def list_posting_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version
|
4148
|
+
def list_posting_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPostingModuleResponse: # noqa: E501
|
4149
4149
|
...
|
4150
4150
|
|
4151
4151
|
@validate_arguments
|
4152
|
-
def list_posting_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version
|
4152
|
+
def list_posting_modules(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPostingModuleResponse, Awaitable[PagedResourceListOfPostingModuleResponse]]: # noqa: E501
|
4153
4153
|
"""[EXPERIMENTAL] ListPostingModules: List Posting Modules # noqa: E501
|
4154
4154
|
|
4155
4155
|
List all the Posting Modules matching particular criteria. # noqa: E501
|
@@ -4163,13 +4163,13 @@ class ChartOfAccountsApi:
|
|
4163
4163
|
:type scope: str
|
4164
4164
|
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
4165
4165
|
:type code: str
|
4166
|
-
:param as_at: The asAt datetime at which to list the Posting Module. Defaults to returning the latest version
|
4166
|
+
:param as_at: The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.
|
4167
4167
|
:type as_at: datetime
|
4168
|
-
:param page: The pagination token to use to continue listing Posting Modules; this
|
4168
|
+
:param page: 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.
|
4169
4169
|
:type page: str
|
4170
4170
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4171
4171
|
:type limit: int
|
4172
|
-
:param filter: Expression to filter the results.
|
4172
|
+
:param filter: 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.
|
4173
4173
|
:type filter: str
|
4174
4174
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4175
4175
|
:type sort_by: List[str]
|
@@ -4192,7 +4192,7 @@ class ChartOfAccountsApi:
|
|
4192
4192
|
return self.list_posting_modules_with_http_info(scope, code, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
4193
4193
|
|
4194
4194
|
@validate_arguments
|
4195
|
-
def list_posting_modules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version
|
4195
|
+
def list_posting_modules_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="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.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="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.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4196
4196
|
"""[EXPERIMENTAL] ListPostingModules: List Posting Modules # noqa: E501
|
4197
4197
|
|
4198
4198
|
List all the Posting Modules matching particular criteria. # noqa: E501
|
@@ -4206,13 +4206,13 @@ class ChartOfAccountsApi:
|
|
4206
4206
|
:type scope: str
|
4207
4207
|
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
4208
4208
|
:type code: str
|
4209
|
-
:param as_at: The asAt datetime at which to list the Posting Module. Defaults to returning the latest version
|
4209
|
+
:param as_at: The asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified.
|
4210
4210
|
:type as_at: datetime
|
4211
|
-
:param page: The pagination token to use to continue listing Posting Modules; this
|
4211
|
+
:param page: 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.
|
4212
4212
|
:type page: str
|
4213
4213
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4214
4214
|
:type limit: int
|
4215
|
-
:param filter: Expression to filter the results.
|
4215
|
+
:param filter: 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.
|
4216
4216
|
:type filter: str
|
4217
4217
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4218
4218
|
:type sort_by: List[str]
|
@@ -5801,18 +5801,18 @@ class ChartOfAccountsApi:
|
|
5801
5801
|
|
5802
5802
|
|
5803
5803
|
@overload
|
5804
|
-
async def upsert_account_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
5804
|
+
async def upsert_account_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, **kwargs) -> AccountProperties: # noqa: E501
|
5805
5805
|
...
|
5806
5806
|
|
5807
5807
|
@overload
|
5808
|
-
def upsert_account_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
5808
|
+
def upsert_account_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, async_req: Optional[bool]=True, **kwargs) -> AccountProperties: # noqa: E501
|
5809
5809
|
...
|
5810
5810
|
|
5811
5811
|
@validate_arguments
|
5812
|
-
def upsert_account_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
5812
|
+
def upsert_account_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AccountProperties, Awaitable[AccountProperties]]: # noqa: E501
|
5813
5813
|
"""[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties # noqa: E501
|
5814
5814
|
|
5815
|
-
Update or insert one or more properties onto a single account. A property will be updated if it
|
5815
|
+
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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
5816
5816
|
This method makes a synchronous HTTP request by default. To make an
|
5817
5817
|
asynchronous HTTP request, please pass async_req=True
|
5818
5818
|
|
@@ -5825,7 +5825,7 @@ class ChartOfAccountsApi:
|
|
5825
5825
|
:type code: str
|
5826
5826
|
:param account_code: The unique ID of the account to create or update properties for. (required)
|
5827
5827
|
:type account_code: str
|
5828
|
-
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in
|
5828
|
+
:param request_body: 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\".
|
5829
5829
|
:type request_body: Dict[str, ModelProperty]
|
5830
5830
|
:param async_req: Whether to execute the request asynchronously.
|
5831
5831
|
:type async_req: bool, optional
|
@@ -5846,10 +5846,10 @@ class ChartOfAccountsApi:
|
|
5846
5846
|
return self.upsert_account_properties_with_http_info(scope, code, account_code, request_body, **kwargs) # noqa: E501
|
5847
5847
|
|
5848
5848
|
@validate_arguments
|
5849
|
-
def upsert_account_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
5849
|
+
def upsert_account_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], account_code : Annotated[StrictStr, Field(..., description="The unique ID of the account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5850
5850
|
"""[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties # noqa: E501
|
5851
5851
|
|
5852
|
-
Update or insert one or more properties onto a single account. A property will be updated if it
|
5852
|
+
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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
5853
5853
|
This method makes a synchronous HTTP request by default. To make an
|
5854
5854
|
asynchronous HTTP request, please pass async_req=True
|
5855
5855
|
|
@@ -5862,7 +5862,7 @@ class ChartOfAccountsApi:
|
|
5862
5862
|
:type code: str
|
5863
5863
|
:param account_code: The unique ID of the account to create or update properties for. (required)
|
5864
5864
|
:type account_code: str
|
5865
|
-
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in
|
5865
|
+
:param request_body: 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\".
|
5866
5866
|
:type request_body: Dict[str, ModelProperty]
|
5867
5867
|
:param async_req: Whether to execute the request asynchronously.
|
5868
5868
|
:type async_req: bool, optional
|
@@ -5984,18 +5984,18 @@ class ChartOfAccountsApi:
|
|
5984
5984
|
|
5985
5985
|
|
5986
5986
|
@overload
|
5987
|
-
async def upsert_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
5987
|
+
async def upsert_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account : Annotated[conlist(Account), Field(..., description="A list of accounts to be created or updated.")], **kwargs) -> AccountsUpsertResponse: # noqa: E501
|
5988
5988
|
...
|
5989
5989
|
|
5990
5990
|
@overload
|
5991
|
-
def upsert_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
5991
|
+
def upsert_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account : Annotated[conlist(Account), Field(..., description="A list of accounts to be created or updated.")], async_req: Optional[bool]=True, **kwargs) -> AccountsUpsertResponse: # noqa: E501
|
5992
5992
|
...
|
5993
5993
|
|
5994
5994
|
@validate_arguments
|
5995
|
-
def upsert_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
5995
|
+
def upsert_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account : Annotated[conlist(Account), Field(..., description="A list of accounts to be created or updated.")], async_req: Optional[bool]=None, **kwargs) -> Union[AccountsUpsertResponse, Awaitable[AccountsUpsertResponse]]: # noqa: E501
|
5996
5996
|
"""[EXPERIMENTAL] UpsertAccounts: Upsert Accounts # noqa: E501
|
5997
5997
|
|
5998
|
-
Create or update accounts in the Chart of Accounts. An account will be updated
|
5998
|
+
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
|
5999
5999
|
This method makes a synchronous HTTP request by default. To make an
|
6000
6000
|
asynchronous HTTP request, please pass async_req=True
|
6001
6001
|
|
@@ -6004,7 +6004,7 @@ class ChartOfAccountsApi:
|
|
6004
6004
|
|
6005
6005
|
:param scope: The scope of the Chart of Accounts. (required)
|
6006
6006
|
:type scope: str
|
6007
|
-
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
6007
|
+
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
6008
6008
|
:type code: str
|
6009
6009
|
:param account: A list of accounts to be created or updated. (required)
|
6010
6010
|
:type account: List[Account]
|
@@ -6027,10 +6027,10 @@ class ChartOfAccountsApi:
|
|
6027
6027
|
return self.upsert_accounts_with_http_info(scope, code, account, **kwargs) # noqa: E501
|
6028
6028
|
|
6029
6029
|
@validate_arguments
|
6030
|
-
def upsert_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
6030
|
+
def upsert_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts.")], code : Annotated[StrictStr, Field(..., description="The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.")], account : Annotated[conlist(Account), Field(..., description="A list of accounts to be created or updated.")], **kwargs) -> ApiResponse: # noqa: E501
|
6031
6031
|
"""[EXPERIMENTAL] UpsertAccounts: Upsert Accounts # noqa: E501
|
6032
6032
|
|
6033
|
-
Create or update accounts in the Chart of Accounts. An account will be updated
|
6033
|
+
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
|
6034
6034
|
This method makes a synchronous HTTP request by default. To make an
|
6035
6035
|
asynchronous HTTP request, please pass async_req=True
|
6036
6036
|
|
@@ -6039,7 +6039,7 @@ class ChartOfAccountsApi:
|
|
6039
6039
|
|
6040
6040
|
:param scope: The scope of the Chart of Accounts. (required)
|
6041
6041
|
:type scope: str
|
6042
|
-
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies
|
6042
|
+
:param code: The code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts. (required)
|
6043
6043
|
:type code: str
|
6044
6044
|
:param account: A list of accounts to be created or updated. (required)
|
6045
6045
|
:type account: List[Account]
|
@@ -6159,18 +6159,18 @@ class ChartOfAccountsApi:
|
|
6159
6159
|
|
6160
6160
|
|
6161
6161
|
@overload
|
6162
|
-
async def upsert_chart_of_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
6162
|
+
async def upsert_chart_of_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, **kwargs) -> ChartOfAccountsProperties: # noqa: E501
|
6163
6163
|
...
|
6164
6164
|
|
6165
6165
|
@overload
|
6166
|
-
def upsert_chart_of_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
6166
|
+
def upsert_chart_of_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, async_req: Optional[bool]=True, **kwargs) -> ChartOfAccountsProperties: # noqa: E501
|
6167
6167
|
...
|
6168
6168
|
|
6169
6169
|
@validate_arguments
|
6170
|
-
def upsert_chart_of_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
6170
|
+
def upsert_chart_of_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ChartOfAccountsProperties, Awaitable[ChartOfAccountsProperties]]: # noqa: E501
|
6171
6171
|
"""[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties # noqa: E501
|
6172
6172
|
|
6173
|
-
Update or insert one or more properties onto a single Chart of Accounts. A property will be updated if it
|
6173
|
+
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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
6174
6174
|
This method makes a synchronous HTTP request by default. To make an
|
6175
6175
|
asynchronous HTTP request, please pass async_req=True
|
6176
6176
|
|
@@ -6181,7 +6181,7 @@ class ChartOfAccountsApi:
|
|
6181
6181
|
:type scope: str
|
6182
6182
|
:param code: 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)
|
6183
6183
|
:type code: str
|
6184
|
-
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in
|
6184
|
+
:param request_body: 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\".
|
6185
6185
|
:type request_body: Dict[str, ModelProperty]
|
6186
6186
|
:param async_req: Whether to execute the request asynchronously.
|
6187
6187
|
:type async_req: bool, optional
|
@@ -6202,10 +6202,10 @@ class ChartOfAccountsApi:
|
|
6202
6202
|
return self.upsert_chart_of_accounts_properties_with_http_info(scope, code, request_body, **kwargs) # noqa: E501
|
6203
6203
|
|
6204
6204
|
@validate_arguments
|
6205
|
-
def upsert_chart_of_accounts_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
6205
|
+
def upsert_chart_of_accounts_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Chart of Accounts to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="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.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="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\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
6206
6206
|
"""[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties # noqa: E501
|
6207
6207
|
|
6208
|
-
Update or insert one or more properties onto a single Chart of Accounts. A property will be updated if it
|
6208
|
+
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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
6209
6209
|
This method makes a synchronous HTTP request by default. To make an
|
6210
6210
|
asynchronous HTTP request, please pass async_req=True
|
6211
6211
|
|
@@ -6216,7 +6216,7 @@ class ChartOfAccountsApi:
|
|
6216
6216
|
:type scope: str
|
6217
6217
|
:param code: 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)
|
6218
6218
|
:type code: str
|
6219
|
-
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in
|
6219
|
+
:param request_body: 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\".
|
6220
6220
|
:type request_body: Dict[str, ModelProperty]
|
6221
6221
|
:param async_req: Whether to execute the request asynchronously.
|
6222
6222
|
:type async_req: bool, optional
|