LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IChartOfAccountsApiSync Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.IChartOfAccountsApiSync:
Inheritance graph
[legend]

Public Member Functions

ChartOfAccounts CreateChartOfAccounts (string scope, ChartOfAccountsRequest chartOfAccountsRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts More...
 
ApiResponse< ChartOfAccountsCreateChartOfAccountsWithHttpInfo (string scope, ChartOfAccountsRequest chartOfAccountsRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts More...
 
CleardownModuleResponse CreateCleardownModule (string scope, string code, CleardownModuleRequest cleardownModuleRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module More...
 
ApiResponse< CleardownModuleResponseCreateCleardownModuleWithHttpInfo (string scope, string code, CleardownModuleRequest cleardownModuleRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module More...
 
GeneralLedgerProfileResponse CreateGeneralLedgerProfile (string scope, string code, GeneralLedgerProfileRequest generalLedgerProfileRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile. More...
 
ApiResponse< GeneralLedgerProfileResponseCreateGeneralLedgerProfileWithHttpInfo (string scope, string code, GeneralLedgerProfileRequest generalLedgerProfileRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile. More...
 
PostingModuleResponse CreatePostingModule (string scope, string code, PostingModuleRequest postingModuleRequest, int operationIndex=0)
 [EXPERIMENTAL] CreatePostingModule: Create a Posting Module More...
 
ApiResponse< PostingModuleResponseCreatePostingModuleWithHttpInfo (string scope, string code, PostingModuleRequest postingModuleRequest, int operationIndex=0)
 [EXPERIMENTAL] CreatePostingModule: Create a Posting Module More...
 
DeleteAccountsResponse DeleteAccounts (string scope, string code, List< string > requestBody, string? deleteMode=default(string?), int operationIndex=0)
 [EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts More...
 
ApiResponse< DeleteAccountsResponseDeleteAccountsWithHttpInfo (string scope, string code, List< string > requestBody, string? deleteMode=default(string?), int operationIndex=0)
 [EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts More...
 
DeletedEntityResponse DeleteChartOfAccounts (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts More...
 
ApiResponse< DeletedEntityResponseDeleteChartOfAccountsWithHttpInfo (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts More...
 
DeletedEntityResponse DeleteCleardownModule (string scope, string code, string cleardownModuleCode, int operationIndex=0)
 [EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module. More...
 
ApiResponse< DeletedEntityResponseDeleteCleardownModuleWithHttpInfo (string scope, string code, string cleardownModuleCode, int operationIndex=0)
 [EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module. More...
 
DeletedEntityResponse DeleteGeneralLedgerProfile (string scope, string code, string generalLedgerProfileCode, int operationIndex=0)
 [EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile. More...
 
ApiResponse< DeletedEntityResponseDeleteGeneralLedgerProfileWithHttpInfo (string scope, string code, string generalLedgerProfileCode, int operationIndex=0)
 [EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile. More...
 
DeletedEntityResponse DeletePostingModule (string scope, string code, string postingModuleCode, int operationIndex=0)
 [EXPERIMENTAL] DeletePostingModule: Delete a Posting Module. More...
 
ApiResponse< DeletedEntityResponseDeletePostingModuleWithHttpInfo (string scope, string code, string postingModuleCode, int operationIndex=0)
 [EXPERIMENTAL] DeletePostingModule: Delete a Posting Module. More...
 
Account GetAccount (string scope, string code, string accountCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetAccount: Get Account More...
 
ApiResponse< AccountGetAccountWithHttpInfo (string scope, string code, string accountCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetAccount: Get Account More...
 
ChartOfAccounts GetChartOfAccounts (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts More...
 
ApiResponse< ChartOfAccountsGetChartOfAccountsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts More...
 
CleardownModuleResponse GetCleardownModule (string scope, string code, string cleardownModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module More...
 
ApiResponse< CleardownModuleResponseGetCleardownModuleWithHttpInfo (string scope, string code, string cleardownModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module More...
 
GeneralLedgerProfileResponse GetGeneralLedgerProfile (string scope, string code, string generalLedgerProfileCode, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile. More...
 
ApiResponse< GeneralLedgerProfileResponseGetGeneralLedgerProfileWithHttpInfo (string scope, string code, string generalLedgerProfileCode, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile. More...
 
PostingModuleResponse GetPostingModule (string scope, string code, string postingModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetPostingModule: Get a Posting Module More...
 
ApiResponse< PostingModuleResponseGetPostingModuleWithHttpInfo (string scope, string code, string postingModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetPostingModule: Get a Posting Module More...
 
PagedResourceListOfAccount ListAccounts (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListAccounts: List Accounts More...
 
ApiResponse< PagedResourceListOfAccountListAccountsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListAccounts: List Accounts More...
 
PagedResourceListOfChartOfAccounts ListChartsOfAccounts (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts More...
 
ApiResponse< PagedResourceListOfChartOfAccountsListChartsOfAccountsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts More...
 
PagedResourceListOfCleardownModuleRule ListCleardownModuleRules (string scope, string code, string cleardownModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules More...
 
ApiResponse< PagedResourceListOfCleardownModuleRuleListCleardownModuleRulesWithHttpInfo (string scope, string code, string cleardownModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules More...
 
PagedResourceListOfCleardownModuleResponse ListCleardownModules (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListCleardownModules: List Cleardown Modules More...
 
ApiResponse< PagedResourceListOfCleardownModuleResponseListCleardownModulesWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListCleardownModules: List Cleardown Modules More...
 
PagedResourceListOfGeneralLedgerProfileResponse ListGeneralLedgerProfiles (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles. More...
 
ApiResponse< PagedResourceListOfGeneralLedgerProfileResponseListGeneralLedgerProfilesWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles. More...
 
PagedResourceListOfPostingModuleRule ListPostingModuleRules (string scope, string code, string postingModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules More...
 
ApiResponse< PagedResourceListOfPostingModuleRuleListPostingModuleRulesWithHttpInfo (string scope, string code, string postingModuleCode, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules More...
 
PagedResourceListOfPostingModuleResponse ListPostingModules (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListPostingModules: List Posting Modules More...
 
ApiResponse< PagedResourceListOfPostingModuleResponseListPostingModulesWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] ListPostingModules: List Posting Modules More...
 
CleardownModuleResponse PatchCleardownModule (string scope, string code, string cleardownModuleCode, List< Operation > operation, int operationIndex=0)
 [EXPERIMENTAL] PatchCleardownModule: Patch a Cleardown Module More...
 
ApiResponse< CleardownModuleResponsePatchCleardownModuleWithHttpInfo (string scope, string code, string cleardownModuleCode, List< Operation > operation, int operationIndex=0)
 [EXPERIMENTAL] PatchCleardownModule: Patch a Cleardown Module More...
 
PostingModuleResponse PatchPostingModule (string scope, string code, string postingModuleCode, List< Operation > operation, int operationIndex=0)
 [EXPERIMENTAL] PatchPostingModule: Patch a Posting Module More...
 
ApiResponse< PostingModuleResponsePatchPostingModuleWithHttpInfo (string scope, string code, string postingModuleCode, List< Operation > operation, int operationIndex=0)
 [EXPERIMENTAL] PatchPostingModule: Patch a Posting Module More...
 
CleardownModuleResponse SetCleardownModuleDetails (string scope, string code, string cleardownModuleCode, CleardownModuleDetails cleardownModuleDetails, int operationIndex=0)
 [EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module More...
 
ApiResponse< CleardownModuleResponseSetCleardownModuleDetailsWithHttpInfo (string scope, string code, string cleardownModuleCode, CleardownModuleDetails cleardownModuleDetails, int operationIndex=0)
 [EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module More...
 
CleardownModuleRulesUpdatedResponse SetCleardownModuleRules (string scope, string code, string cleardownModuleCode, List< CleardownModuleRule > cleardownModuleRule, int operationIndex=0)
 [EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module More...
 
ApiResponse< CleardownModuleRulesUpdatedResponseSetCleardownModuleRulesWithHttpInfo (string scope, string code, string cleardownModuleCode, List< CleardownModuleRule > cleardownModuleRule, int operationIndex=0)
 [EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module More...
 
GeneralLedgerProfileResponse SetGeneralLedgerProfileMappings (string scope, string code, string generalLedgerProfileCode, List< GeneralLedgerProfileMapping > generalLedgerProfileMapping, int operationIndex=0)
 [EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings. More...
 
ApiResponse< GeneralLedgerProfileResponseSetGeneralLedgerProfileMappingsWithHttpInfo (string scope, string code, string generalLedgerProfileCode, List< GeneralLedgerProfileMapping > generalLedgerProfileMapping, int operationIndex=0)
 [EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings. More...
 
PostingModuleResponse SetPostingModuleDetails (string scope, string code, string postingModuleCode, PostingModuleDetails postingModuleDetails, int operationIndex=0)
 [EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module More...
 
ApiResponse< PostingModuleResponseSetPostingModuleDetailsWithHttpInfo (string scope, string code, string postingModuleCode, PostingModuleDetails postingModuleDetails, int operationIndex=0)
 [EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module More...
 
PostingModuleRulesUpdatedResponse SetPostingModuleRules (string scope, string code, string postingModuleCode, List< PostingModuleRule > postingModuleRule, int operationIndex=0)
 [EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module More...
 
ApiResponse< PostingModuleRulesUpdatedResponseSetPostingModuleRulesWithHttpInfo (string scope, string code, string postingModuleCode, List< PostingModuleRule > postingModuleRule, int operationIndex=0)
 [EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module More...
 
AccountProperties UpsertAccountProperties (string scope, string code, string accountCode, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
 [EXPERIMENTAL] UpsertAccountProperties: Upsert account properties More...
 
ApiResponse< AccountPropertiesUpsertAccountPropertiesWithHttpInfo (string scope, string code, string accountCode, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
 [EXPERIMENTAL] UpsertAccountProperties: Upsert account properties More...
 
AccountsUpsertResponse UpsertAccounts (string scope, string code, List< Account > account, int operationIndex=0)
 [EXPERIMENTAL] UpsertAccounts: Upsert Accounts More...
 
ApiResponse< AccountsUpsertResponseUpsertAccountsWithHttpInfo (string scope, string code, List< Account > account, int operationIndex=0)
 [EXPERIMENTAL] UpsertAccounts: Upsert Accounts More...
 
ChartOfAccountsProperties UpsertChartOfAccountsProperties (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
 [EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties More...
 
ApiResponse< ChartOfAccountsPropertiesUpsertChartOfAccountsPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
 [EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateChartOfAccounts()

ChartOfAccounts Lusid.Sdk.Api.IChartOfAccountsApiSync.CreateChartOfAccounts ( string  scope,
ChartOfAccountsRequest  chartOfAccountsRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts

Create the given Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
chartOfAccountsRequestThe definition of the Chart of Accounts.
operationIndexIndex associated with the operation.
Returns
ChartOfAccounts

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreateChartOfAccountsWithHttpInfo()

ApiResponse<ChartOfAccounts> Lusid.Sdk.Api.IChartOfAccountsApiSync.CreateChartOfAccountsWithHttpInfo ( string  scope,
ChartOfAccountsRequest  chartOfAccountsRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts

Create the given Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
chartOfAccountsRequestThe definition of the Chart of Accounts.
operationIndexIndex associated with the operation.
Returns
ApiResponse of ChartOfAccounts

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreateCleardownModule()

CleardownModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.CreateCleardownModule ( string  scope,
string  code,
CleardownModuleRequest  cleardownModuleRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module

Create the given Cleardown Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleRequestThe definition of the Cleardown Module.
operationIndexIndex associated with the operation.
Returns
CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreateCleardownModuleWithHttpInfo()

ApiResponse<CleardownModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.CreateCleardownModuleWithHttpInfo ( string  scope,
string  code,
CleardownModuleRequest  cleardownModuleRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module

Create the given Cleardown Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleRequestThe definition of the Cleardown Module.
operationIndexIndex associated with the operation.
Returns
ApiResponse of CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreateGeneralLedgerProfile()

GeneralLedgerProfileResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.CreateGeneralLedgerProfile ( string  scope,
string  code,
GeneralLedgerProfileRequest  generalLedgerProfileRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile.

Create the given General Ledger profile.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts.
generalLedgerProfileRequestThe definition of the General Ledger Profile.
operationIndexIndex associated with the operation.
Returns
GeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreateGeneralLedgerProfileWithHttpInfo()

ApiResponse<GeneralLedgerProfileResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.CreateGeneralLedgerProfileWithHttpInfo ( string  scope,
string  code,
GeneralLedgerProfileRequest  generalLedgerProfileRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile.

Create the given General Ledger profile.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts.
generalLedgerProfileRequestThe definition of the General Ledger Profile.
operationIndexIndex associated with the operation.
Returns
ApiResponse of GeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreatePostingModule()

PostingModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.CreatePostingModule ( string  scope,
string  code,
PostingModuleRequest  postingModuleRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreatePostingModule: Create a Posting Module

Create the given Posting Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleRequestThe definition of the Posting Module.
operationIndexIndex associated with the operation.
Returns
PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ CreatePostingModuleWithHttpInfo()

ApiResponse<PostingModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.CreatePostingModuleWithHttpInfo ( string  scope,
string  code,
PostingModuleRequest  postingModuleRequest,
int  operationIndex = 0 
)

[EXPERIMENTAL] CreatePostingModule: Create a Posting Module

Create the given Posting Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleRequestThe definition of the Posting Module.
operationIndexIndex associated with the operation.
Returns
ApiResponse of PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteAccounts()

DeleteAccountsResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteAccounts ( string  scope,
string  code,
List< string >  requestBody,
string?  deleteMode = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
requestBodyThe codes of the accounts to delete.
deleteModeThe delete mode to use (defaults to &#39;Soft&#39;). (optional)
operationIndexIndex associated with the operation.
Returns
DeleteAccountsResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteAccountsWithHttpInfo()

ApiResponse<DeleteAccountsResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteAccountsWithHttpInfo ( string  scope,
string  code,
List< string >  requestBody,
string?  deleteMode = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
requestBodyThe codes of the accounts to delete.
deleteModeThe delete mode to use (defaults to &#39;Soft&#39;). (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeleteAccountsResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteChartOfAccounts()

DeletedEntityResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteChartOfAccounts ( string  scope,
string  code,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts

Delete the given Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts to be deleted.
codeThe code of the Chart of Accounts to be deleted. Together with the scope this uniquely identifies the Chart of Accounts.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteChartOfAccountsWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteChartOfAccountsWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts

Delete the given Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts to be deleted.
codeThe code of the Chart of Accounts to be deleted. Together with the scope this uniquely identifies the Chart of Accounts.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteCleardownModule()

DeletedEntityResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteCleardownModule ( string  scope,
string  code,
string  cleardownModuleCode,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module.

Delete the given Cleardown Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be deleted.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteCleardownModuleWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteCleardownModuleWithHttpInfo ( string  scope,
string  code,
string  cleardownModuleCode,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module.

Delete the given Cleardown Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be deleted.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteGeneralLedgerProfile()

DeletedEntityResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteGeneralLedgerProfile ( string  scope,
string  code,
string  generalLedgerProfileCode,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile.

Delete the given General Ledger Profile.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts for the General Ledger Profile.
codeThe code of the Chart of Accounts for the General Ledger Profile.
generalLedgerProfileCodeThe Code of the General Ledger Profile.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeleteGeneralLedgerProfileWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.DeleteGeneralLedgerProfileWithHttpInfo ( string  scope,
string  code,
string  generalLedgerProfileCode,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile.

Delete the given General Ledger Profile.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts for the General Ledger Profile.
codeThe code of the Chart of Accounts for the General Ledger Profile.
generalLedgerProfileCodeThe Code of the General Ledger Profile.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeletePostingModule()

DeletedEntityResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.DeletePostingModule ( string  scope,
string  code,
string  postingModuleCode,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeletePostingModule: Delete a Posting Module.

Delete the given Posting Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be deleted.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ DeletePostingModuleWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.DeletePostingModuleWithHttpInfo ( string  scope,
string  code,
string  postingModuleCode,
int  operationIndex = 0 
)

[EXPERIMENTAL] DeletePostingModule: Delete a Posting Module.

Delete the given Posting Module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be deleted.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetAccount()

Account Lusid.Sdk.Api.IChartOfAccountsApiSync.GetAccount ( string  scope,
string  code,
string  accountCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetAccount: Get Account

Retrieve the definition of a particular Account which is part of a Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
accountCodeThe code of the Account.
effectiveAtThe effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Account&#39; domain to decorate onto the Account. These must take the format {domain}/{scope}/{code}, for example &#39;Account/Manager/Id&#39;. If not provided will return all the entitled properties for that Account. (optional)
operationIndexIndex associated with the operation.
Returns
Account

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetAccountWithHttpInfo()

ApiResponse<Account> Lusid.Sdk.Api.IChartOfAccountsApiSync.GetAccountWithHttpInfo ( string  scope,
string  code,
string  accountCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetAccount: Get Account

Retrieve the definition of a particular Account which is part of a Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
accountCodeThe code of the Account.
effectiveAtThe effective datetime or cut label at which to retrieve the Account properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Account definition. Defaults to returning the latest version of the Account definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Account&#39; domain to decorate onto the Account. These must take the format {domain}/{scope}/{code}, for example &#39;Account/Manager/Id&#39;. If not provided will return all the entitled properties for that Account. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Account

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetChartOfAccounts()

ChartOfAccounts Lusid.Sdk.Api.IChartOfAccountsApiSync.GetChartOfAccounts ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts

Retrieve the definition of a particular Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
effectiveAtThe effective datetime or cut label at which to retrieve the Chart of Accounts properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe 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. (optional)
propertyKeysA list of property keys from the &#39;ChartOfAccounts&#39; domain to decorate onto the Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example &#39;ChartOfAccounts/Manager/Id&#39;. If no properties are specified, then no properties will be returned. (optional)
operationIndexIndex associated with the operation.
Returns
ChartOfAccounts

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetChartOfAccountsWithHttpInfo()

ApiResponse<ChartOfAccounts> Lusid.Sdk.Api.IChartOfAccountsApiSync.GetChartOfAccountsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts

Retrieve the definition of a particular Chart of Accounts.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
effectiveAtThe effective datetime or cut label at which to retrieve the Chart of Accounts properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe 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. (optional)
propertyKeysA list of property keys from the &#39;ChartOfAccounts&#39; domain to decorate onto the Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example &#39;ChartOfAccounts/Manager/Id&#39;. If no properties are specified, then no properties will be returned. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ChartOfAccounts

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetCleardownModule()

CleardownModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.GetCleardownModule ( string  scope,
string  code,
string  cleardownModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module

Retrieve the definition of a Cleardown Module complete with its rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module.
asAtThe asAt datetime at which to retrieve the Cleardown Module. Defaults to return the latest version of the Cleardown Module if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetCleardownModuleWithHttpInfo()

ApiResponse<CleardownModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.GetCleardownModuleWithHttpInfo ( string  scope,
string  code,
string  cleardownModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module

Retrieve the definition of a Cleardown Module complete with its rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module.
asAtThe asAt datetime at which to retrieve the Cleardown Module. Defaults to return the latest version of the Cleardown Module if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetGeneralLedgerProfile()

GeneralLedgerProfileResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.GetGeneralLedgerProfile ( string  scope,
string  code,
string  generalLedgerProfileCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile.

Get the given General Ledger Profile.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts for the General Ledger Profile.
codeThe code of the Chart of Accounts for the General Ledger Profile.
generalLedgerProfileCodeThe General Ledger Profile Code of the General Ledger Profile.
asAtThe asAt datetime at which to retrieve the General Ledger Profile. Defaults to return the latest version of the General Ledger Profile if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
GeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetGeneralLedgerProfileWithHttpInfo()

ApiResponse<GeneralLedgerProfileResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.GetGeneralLedgerProfileWithHttpInfo ( string  scope,
string  code,
string  generalLedgerProfileCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile.

Get the given General Ledger Profile.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts for the General Ledger Profile.
codeThe code of the Chart of Accounts for the General Ledger Profile.
generalLedgerProfileCodeThe General Ledger Profile Code of the General Ledger Profile.
asAtThe asAt datetime at which to retrieve the General Ledger Profile. Defaults to return the latest version of the General Ledger Profile if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of GeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetPostingModule()

PostingModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.GetPostingModule ( string  scope,
string  code,
string  postingModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetPostingModule: Get a Posting Module

Retrieve the definition of a Posting Module complete with its rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module.
asAtThe asAt datetime at which to retrieve the Posting Module. Defaults to return the latest version of the Posting Module if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ GetPostingModuleWithHttpInfo()

ApiResponse<PostingModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.GetPostingModuleWithHttpInfo ( string  scope,
string  code,
string  postingModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetPostingModule: Get a Posting Module

Retrieve the definition of a Posting Module complete with its rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module.
asAtThe asAt datetime at which to retrieve the Posting Module. Defaults to return the latest version of the Posting Module if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListAccounts()

PagedResourceListOfAccount Lusid.Sdk.Api.IChartOfAccountsApiSync.ListAccounts ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListAccounts: List Accounts

List the accounts in a Chart of Accounts

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
effectiveAtThe 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. (optional)
asAtThe asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Account type, specify &quot;code eq &#39;001&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;Account&#39; domain to decorate onto the Account. These must have the format {domain}/{scope}/{code}, for example &#39;Account/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfAccount

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListAccountsWithHttpInfo()

ApiResponse<PagedResourceListOfAccount> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListAccountsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListAccounts: List Accounts

List the accounts in a Chart of Accounts

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
effectiveAtThe 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. (optional)
asAtThe asAt datetime at which to retrieve the Accounts. Defaults to returning the latest version if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Account type, specify &quot;code eq &#39;001&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;Account&#39; domain to decorate onto the Account. These must have the format {domain}/{scope}/{code}, for example &#39;Account/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfAccount

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListChartsOfAccounts()

PagedResourceListOfChartOfAccounts Lusid.Sdk.Api.IChartOfAccountsApiSync.ListChartsOfAccounts ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts

List all the Charts of Accounts matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe 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. (optional)
asAtThe asAt datetime at which to list the charts of accounts. Defaults to returning the latest version of each Chart of Accounts if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Chart of Accounts type, specify &quot;id.Code eq &#39;001&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;ChartOfAccounts&#39; domain to decorate onto each Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example &#39;ChartOfAccounts/Manager/Id&#39;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfChartOfAccounts

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListChartsOfAccountsWithHttpInfo()

ApiResponse<PagedResourceListOfChartOfAccounts> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListChartsOfAccountsWithHttpInfo ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts

List all the Charts of Accounts matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe 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. (optional)
asAtThe asAt datetime at which to list the charts of accounts. Defaults to returning the latest version of each Chart of Accounts if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Chart of Accounts type, specify &quot;id.Code eq &#39;001&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;ChartOfAccounts&#39; domain to decorate onto each Chart of Accounts. These must take the format {domain}/{scope}/{code}, for example &#39;ChartOfAccounts/Manager/Id&#39;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfChartOfAccounts

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListCleardownModuleRules()

PagedResourceListOfCleardownModuleRule Lusid.Sdk.Api.IChartOfAccountsApiSync.ListCleardownModuleRules ( string  scope,
string  code,
string  cleardownModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules

List the Rules in a Cleardown Module

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the cleardown module.
asAtThe asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the rule id, specify &quot;ruleId eq &#39;rule 1&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfCleardownModuleRule

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListCleardownModuleRulesWithHttpInfo()

ApiResponse<PagedResourceListOfCleardownModuleRule> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListCleardownModuleRulesWithHttpInfo ( string  scope,
string  code,
string  cleardownModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules

List the Rules in a Cleardown Module

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the cleardown module.
asAtThe asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the rule id, specify &quot;ruleId eq &#39;rule 1&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfCleardownModuleRule

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListCleardownModules()

PagedResourceListOfCleardownModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.ListCleardownModules ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules

List all the Cleardown Modules matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
asAtThe asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Cleardown Module status, specify &quot;status eq &#39;Active&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfCleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListCleardownModulesWithHttpInfo()

ApiResponse<PagedResourceListOfCleardownModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListCleardownModulesWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListCleardownModules: List Cleardown Modules

List all the Cleardown Modules matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
asAtThe asAt datetime at which to list the Cleardown Module. Defaults to returning the latest version of each Cleardown Module if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Cleardown Module status, specify &quot;status eq &#39;Active&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfCleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListGeneralLedgerProfiles()

PagedResourceListOfGeneralLedgerProfileResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.ListGeneralLedgerProfiles ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles.

List all the General Ledger profiles matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts
codeThe code of the Chart of Accounts
asAtThe asAt datetime at which to list the General Ledger Profiles. Defaults to returning the latest version of each General Ledger Profile if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the General Ledger profiles type, specify &quot;type eq &#39;PeriodBoundary&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfGeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListGeneralLedgerProfilesWithHttpInfo()

ApiResponse<PagedResourceListOfGeneralLedgerProfileResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListGeneralLedgerProfilesWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles.

List all the General Ledger profiles matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts
codeThe code of the Chart of Accounts
asAtThe asAt datetime at which to list the General Ledger Profiles. Defaults to returning the latest version of each General Ledger Profile if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the General Ledger profiles type, specify &quot;type eq &#39;PeriodBoundary&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfGeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListPostingModuleRules()

PagedResourceListOfPostingModuleRule Lusid.Sdk.Api.IChartOfAccountsApiSync.ListPostingModuleRules ( string  scope,
string  code,
string  postingModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules

List the Rules in a Posting Module

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the posting module.
asAtThe asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the rule id, specify &quot;ruleId eq &#39;rule 1&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfPostingModuleRule

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListPostingModuleRulesWithHttpInfo()

ApiResponse<PagedResourceListOfPostingModuleRule> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListPostingModuleRulesWithHttpInfo ( string  scope,
string  code,
string  postingModuleCode,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules

List the Rules in a Posting Module

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the posting module.
asAtThe asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the rule id, specify &quot;ruleId eq &#39;rule 1&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfPostingModuleRule

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListPostingModules()

PagedResourceListOfPostingModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.ListPostingModules ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListPostingModules: List Posting Modules

List all the Posting Modules matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
asAtThe asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Posting Module status, specify &quot;status eq &#39;Active&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfPostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ ListPostingModulesWithHttpInfo()

ApiResponse<PagedResourceListOfPostingModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.ListPostingModulesWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListPostingModules: List Posting Modules

List all the Posting Modules matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
asAtThe asAt datetime at which to list the Posting Module. Defaults to returning the latest version of each Posting Module if not specified. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Posting Module status, specify &quot;status eq &#39;Active&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfPostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ PatchCleardownModule()

CleardownModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.PatchCleardownModule ( string  scope,
string  code,
string  cleardownModuleCode,
List< Operation operation,
int  operationIndex = 0 
)

[EXPERIMENTAL] PatchCleardownModule: Patch a Cleardown Module

Update fields on a Cleardown Module. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, Rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be updated.
operationThe json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ PatchCleardownModuleWithHttpInfo()

ApiResponse<CleardownModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.PatchCleardownModuleWithHttpInfo ( string  scope,
string  code,
string  cleardownModuleCode,
List< Operation operation,
int  operationIndex = 0 
)

[EXPERIMENTAL] PatchCleardownModule: Patch a Cleardown Module

Update fields on a Cleardown Module. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, Rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be updated.
operationThe json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
ApiResponse of CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ PatchPostingModule()

PostingModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.PatchPostingModule ( string  scope,
string  code,
string  postingModuleCode,
List< Operation operation,
int  operationIndex = 0 
)

[EXPERIMENTAL] PatchPostingModule: Patch a Posting Module

Update fields on a Posting Module. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, Rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be updated.
operationThe json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ PatchPostingModuleWithHttpInfo()

ApiResponse<PostingModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.PatchPostingModuleWithHttpInfo ( string  scope,
string  code,
string  postingModuleCode,
List< Operation operation,
int  operationIndex = 0 
)

[EXPERIMENTAL] PatchPostingModule: Patch a Posting Module

Update fields on a Posting Module. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, Rules.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be updated.
operationThe json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
ApiResponse of PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetCleardownModuleDetails()

CleardownModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.SetCleardownModuleDetails ( string  scope,
string  code,
string  cleardownModuleCode,
CleardownModuleDetails  cleardownModuleDetails,
int  operationIndex = 0 
)

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

Update the given Cleardown Module details.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be updated.
cleardownModuleDetailsThe new details for the Cleardown Module.
operationIndexIndex associated with the operation.
Returns
CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetCleardownModuleDetailsWithHttpInfo()

ApiResponse<CleardownModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.SetCleardownModuleDetailsWithHttpInfo ( string  scope,
string  code,
string  cleardownModuleCode,
CleardownModuleDetails  cleardownModuleDetails,
int  operationIndex = 0 
)

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

Update the given Cleardown Module details.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be updated.
cleardownModuleDetailsThe new details for the Cleardown Module.
operationIndexIndex associated with the operation.
Returns
ApiResponse of CleardownModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetCleardownModuleRules()

CleardownModuleRulesUpdatedResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.SetCleardownModuleRules ( string  scope,
string  code,
string  cleardownModuleCode,
List< CleardownModuleRule cleardownModuleRule,
int  operationIndex = 0 
)

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

Set the given Cleardown Modules rules, this will replace the existing set of rules for the cleardown module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be updated.
cleardownModuleRuleThe new rule set for the Cleardown Module.
operationIndexIndex associated with the operation.
Returns
CleardownModuleRulesUpdatedResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetCleardownModuleRulesWithHttpInfo()

ApiResponse<CleardownModuleRulesUpdatedResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.SetCleardownModuleRulesWithHttpInfo ( string  scope,
string  code,
string  cleardownModuleCode,
List< CleardownModuleRule cleardownModuleRule,
int  operationIndex = 0 
)

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

Set the given Cleardown Modules rules, this will replace the existing set of rules for the cleardown module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
cleardownModuleCodeThe code of the Cleardown Module to be updated.
cleardownModuleRuleThe new rule set for the Cleardown Module.
operationIndexIndex associated with the operation.
Returns
ApiResponse of CleardownModuleRulesUpdatedResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetGeneralLedgerProfileMappings()

GeneralLedgerProfileResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.SetGeneralLedgerProfileMappings ( string  scope,
string  code,
string  generalLedgerProfileCode,
List< GeneralLedgerProfileMapping generalLedgerProfileMapping,
int  operationIndex = 0 
)

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

Update the given General Ledger profile Mappings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts.
generalLedgerProfileCodeThe code of the General Ledger Profile
generalLedgerProfileMappingThe updated General Ledger Profile Mappings, the previous mappings will be wholly replaced with this data. Mappings will be evaluated in the order they are provided.
operationIndexIndex associated with the operation.
Returns
GeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetGeneralLedgerProfileMappingsWithHttpInfo()

ApiResponse<GeneralLedgerProfileResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.SetGeneralLedgerProfileMappingsWithHttpInfo ( string  scope,
string  code,
string  generalLedgerProfileCode,
List< GeneralLedgerProfileMapping generalLedgerProfileMapping,
int  operationIndex = 0 
)

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

Update the given General Ledger profile Mappings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts.
generalLedgerProfileCodeThe code of the General Ledger Profile
generalLedgerProfileMappingThe updated General Ledger Profile Mappings, the previous mappings will be wholly replaced with this data. Mappings will be evaluated in the order they are provided.
operationIndexIndex associated with the operation.
Returns
ApiResponse of GeneralLedgerProfileResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetPostingModuleDetails()

PostingModuleResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.SetPostingModuleDetails ( string  scope,
string  code,
string  postingModuleCode,
PostingModuleDetails  postingModuleDetails,
int  operationIndex = 0 
)

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

Update the given Posting Module details.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be updated.
postingModuleDetailsThe new details for the Posting Module.
operationIndexIndex associated with the operation.
Returns
PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetPostingModuleDetailsWithHttpInfo()

ApiResponse<PostingModuleResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.SetPostingModuleDetailsWithHttpInfo ( string  scope,
string  code,
string  postingModuleCode,
PostingModuleDetails  postingModuleDetails,
int  operationIndex = 0 
)

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

Update the given Posting Module details.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be updated.
postingModuleDetailsThe new details for the Posting Module.
operationIndexIndex associated with the operation.
Returns
ApiResponse of PostingModuleResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetPostingModuleRules()

PostingModuleRulesUpdatedResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.SetPostingModuleRules ( string  scope,
string  code,
string  postingModuleCode,
List< PostingModuleRule postingModuleRule,
int  operationIndex = 0 
)

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

Set the given Posting Modules rules, this will replace the existing set of rules for the posting module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be updated.
postingModuleRuleThe new rule set for the Posting Module.
operationIndexIndex associated with the operation.
Returns
PostingModuleRulesUpdatedResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ SetPostingModuleRulesWithHttpInfo()

ApiResponse<PostingModuleRulesUpdatedResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.SetPostingModuleRulesWithHttpInfo ( string  scope,
string  code,
string  postingModuleCode,
List< PostingModuleRule postingModuleRule,
int  operationIndex = 0 
)

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

Set the given Posting Modules rules, this will replace the existing set of rules for the posting module.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
postingModuleCodeThe code of the Posting Module to be updated.
postingModuleRuleThe new rule set for the Posting Module.
operationIndexIndex associated with the operation.
Returns
ApiResponse of PostingModuleRulesUpdatedResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ UpsertAccountProperties()

AccountProperties Lusid.Sdk.Api.IChartOfAccountsApiSync.UpsertAccountProperties ( string  scope,
string  code,
string  accountCode,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties

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 &#39;Account&#39;. 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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts to update or insert the properties onto.
codeThe code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts.
accountCodeThe unique ID of the account to create or update properties for.
requestBodyThe 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. &quot;Account/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
AccountProperties

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ UpsertAccountPropertiesWithHttpInfo()

ApiResponse<AccountProperties> Lusid.Sdk.Api.IChartOfAccountsApiSync.UpsertAccountPropertiesWithHttpInfo ( string  scope,
string  code,
string  accountCode,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertAccountProperties: Upsert account properties

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 &#39;Account&#39;. 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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts to update or insert the properties onto.
codeThe code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts.
accountCodeThe unique ID of the account to create or update properties for.
requestBodyThe 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. &quot;Account/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of AccountProperties

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ UpsertAccounts()

AccountsUpsertResponse Lusid.Sdk.Api.IChartOfAccountsApiSync.UpsertAccounts ( string  scope,
string  code,
List< Account account,
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertAccounts: Upsert Accounts

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
accountA list of accounts to be created or updated.
operationIndexIndex associated with the operation.
Returns
AccountsUpsertResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ UpsertAccountsWithHttpInfo()

ApiResponse<AccountsUpsertResponse> Lusid.Sdk.Api.IChartOfAccountsApiSync.UpsertAccountsWithHttpInfo ( string  scope,
string  code,
List< Account account,
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertAccounts: Upsert Accounts

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts.
codeThe code of the Chart of Accounts. Together with the scope this uniquely identifies the Chart of Accounts.
accountA list of accounts to be created or updated.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AccountsUpsertResponse

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ UpsertChartOfAccountsProperties()

ChartOfAccountsProperties Lusid.Sdk.Api.IChartOfAccountsApiSync.UpsertChartOfAccountsProperties ( string  scope,
string  code,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties

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 &#39;ChartOfAccounts&#39;. 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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts to update or insert the properties onto.
codeThe code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts.
requestBodyThe 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. &quot;ChartOfAccounts/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ChartOfAccountsProperties

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.

◆ UpsertChartOfAccountsPropertiesWithHttpInfo()

ApiResponse<ChartOfAccountsProperties> Lusid.Sdk.Api.IChartOfAccountsApiSync.UpsertChartOfAccountsPropertiesWithHttpInfo ( string  scope,
string  code,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties

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 &#39;ChartOfAccounts&#39;. 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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Chart of Accounts to update or insert the properties onto.
codeThe code of the Chart of Accounts to update or insert the properties onto. Together with the scope this uniquely identifies the Chart of Accounts.
requestBodyThe 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. &quot;ChartOfAccounts/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ChartOfAccountsProperties

Implemented in Lusid.Sdk.Api.ChartOfAccountsApi.


The documentation for this interface was generated from the following file: