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

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

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

Public Member Functions

System.Threading.Tasks.Task< DiaryEntryAddDiaryEntryAsync (string scope, string code, string diaryEntryCode, DiaryEntryRequest diaryEntryRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< DiaryEntry > > AddDiaryEntryWithHttpInfoAsync (string scope, string code, string diaryEntryCode, DiaryEntryRequest diaryEntryRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. More...
 
System.Threading.Tasks.Task< DiaryEntryClosePeriodAsync (string scope, string code, ClosePeriodDiaryEntryRequest closePeriodDiaryEntryRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< DiaryEntry > > ClosePeriodWithHttpInfoAsync (string scope, string code, ClosePeriodDiaryEntryRequest closePeriodDiaryEntryRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. More...
 
System.Threading.Tasks.Task< AborCreateAborAsync (string scope, AborRequest aborRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateAbor: Create an Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< Abor > > CreateAborWithHttpInfoAsync (string scope, AborRequest aborRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateAbor: Create an Abor. More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteAborAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteAbor: Delete an Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteAborWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteAbor: Delete an Abor. More...
 
System.Threading.Tasks.Task< AborGetAborAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetAbor: Get Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< Abor > > GetAborWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetAbor: Get Abor. More...
 
System.Threading.Tasks.Task< VersionedResourceListOfJournalEntryLineGetJournalEntryLinesAsync (string scope, string code, JournalEntryLinesQueryParameters journalEntryLinesQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfJournalEntryLine > > GetJournalEntryLinesWithHttpInfoAsync (string scope, string code, JournalEntryLinesQueryParameters journalEntryLinesQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. More...
 
System.Threading.Tasks.Task< VersionedResourceListOfTrialBalanceGetTrialBalanceAsync (string scope, string code, TrialBalanceQueryParameters trialBalanceQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< VersionedResourceListOfTrialBalance > > GetTrialBalanceWithHttpInfoAsync (string scope, string code, TrialBalanceQueryParameters trialBalanceQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. More...
 
System.Threading.Tasks.Task< PagedResourceListOfAborListAborsAsync (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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListAbors: List Abors. More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfAbor > > ListAborsWithHttpInfoAsync (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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListAbors: List Abors. More...
 
System.Threading.Tasks.Task< PagedResourceListOfDiaryEntryListDiaryEntriesAsync (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 >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListDiaryEntries: List diary entries. More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfDiaryEntry > > ListDiaryEntriesWithHttpInfoAsync (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 >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListDiaryEntries: List diary entries. More...
 
System.Threading.Tasks.Task< DiaryEntryLockPeriodAsync (string scope, string code, LockPeriodDiaryEntryRequest? lockPeriodDiaryEntryRequest=default(LockPeriodDiaryEntryRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. More...
 
System.Threading.Tasks.Task< ApiResponse< DiaryEntry > > LockPeriodWithHttpInfoAsync (string scope, string code, LockPeriodDiaryEntryRequest? lockPeriodDiaryEntryRequest=default(LockPeriodDiaryEntryRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. More...
 
System.Threading.Tasks.Task< AborPatchAborAsync (string scope, string code, List< Operation > operation, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] PatchAbor: Patch Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< Abor > > PatchAborWithHttpInfoAsync (string scope, string code, List< Operation > operation, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] PatchAbor: Patch Abor. More...
 
System.Threading.Tasks.Task< PeriodDiaryEntriesReopenedResponseReOpenPeriodsAsync (string scope, string code, ReOpenPeriodDiaryEntryRequest? reOpenPeriodDiaryEntryRequest=default(ReOpenPeriodDiaryEntryRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. More...
 
System.Threading.Tasks.Task< ApiResponse< PeriodDiaryEntriesReopenedResponse > > ReOpenPeriodsWithHttpInfoAsync (string scope, string code, ReOpenPeriodDiaryEntryRequest? reOpenPeriodDiaryEntryRequest=default(ReOpenPeriodDiaryEntryRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. More...
 
System.Threading.Tasks.Task< AborPropertiesUpsertAborPropertiesAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties More...
 
System.Threading.Tasks.Task< ApiResponse< AborProperties > > UpsertAborPropertiesWithHttpInfoAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertAborProperties: Upsert Abor 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

◆ AddDiaryEntryAsync()

System.Threading.Tasks.Task<DiaryEntry> Lusid.Sdk.Api.IAborApiAsync.AddDiaryEntryAsync ( string  scope,
string  code,
string  diaryEntryCode,
DiaryEntryRequest  diaryEntryRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Adds a new diary entry to the specified Abor

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
diaryEntryCodeDiary entry code
diaryEntryRequestThe diary entry to add.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ AddDiaryEntryWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DiaryEntry> > Lusid.Sdk.Api.IAborApiAsync.AddDiaryEntryWithHttpInfoAsync ( string  scope,
string  code,
string  diaryEntryCode,
DiaryEntryRequest  diaryEntryRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Adds a new diary entry to the specified Abor

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
diaryEntryCodeDiary entry code
diaryEntryRequestThe diary entry to add.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DiaryEntry)

Implemented in Lusid.Sdk.Api.AborApi.

◆ ClosePeriodAsync()

System.Threading.Tasks.Task<DiaryEntry> Lusid.Sdk.Api.IAborApiAsync.ClosePeriodAsync ( string  scope,
string  code,
ClosePeriodDiaryEntryRequest  closePeriodDiaryEntryRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Closes or Locks the current open period for the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
closePeriodDiaryEntryRequestThe request body, containing details to apply to the closing/locking period.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ ClosePeriodWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DiaryEntry> > Lusid.Sdk.Api.IAborApiAsync.ClosePeriodWithHttpInfoAsync ( string  scope,
string  code,
ClosePeriodDiaryEntryRequest  closePeriodDiaryEntryRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Closes or Locks the current open period for the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
closePeriodDiaryEntryRequestThe request body, containing details to apply to the closing/locking period.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DiaryEntry)

Implemented in Lusid.Sdk.Api.AborApi.

◆ CreateAborAsync()

System.Threading.Tasks.Task<Abor> Lusid.Sdk.Api.IAborApiAsync.CreateAborAsync ( string  scope,
AborRequest  aborRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] CreateAbor: Create an Abor.

Create the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
aborRequestThe definition of the Abor.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ CreateAborWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Abor> > Lusid.Sdk.Api.IAborApiAsync.CreateAborWithHttpInfoAsync ( string  scope,
AborRequest  aborRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] CreateAbor: Create an Abor.

Create the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
aborRequestThe definition of the Abor.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Abor)

Implemented in Lusid.Sdk.Api.AborApi.

◆ DeleteAborAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IAborApiAsync.DeleteAborAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteAbor: Delete an Abor.

Delete the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor to be deleted.
codeThe code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AborApi.

◆ DeleteAborWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IAborApiAsync.DeleteAborWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteAbor: Delete an Abor.

Delete the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor to be deleted.
codeThe code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetAborAsync()

System.Threading.Tasks.Task<Abor> Lusid.Sdk.Api.IAborApiAsync.GetAborAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetAbor: Get Abor.

Retrieve the definition of a particular Abor.

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

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetAborWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Abor> > Lusid.Sdk.Api.IAborApiAsync.GetAborWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetAbor: Get Abor.

Retrieve the definition of a particular Abor.

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

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetJournalEntryLinesAsync()

System.Threading.Tasks.Task<VersionedResourceListOfJournalEntryLine> Lusid.Sdk.Api.IAborApiAsync.GetJournalEntryLinesAsync ( string  scope,
string  code,
JournalEntryLinesQueryParameters  journalEntryLinesQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int?  limit = default(int?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Gets the Journal Entry lines for the given Abor The Journal Entry lines have been generated from transactions and translated via posting rules

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor. Together with the scope is creating the unique identifier for the given Abor.
journalEntryLinesQueryParametersThe query parameters used in running the generation of the Journal Entry lines.
asAtThe asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified. (optional)
filter&quot;Expression to filter the result set.&quot; (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfJournalEntryLine

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetJournalEntryLinesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfJournalEntryLine> > Lusid.Sdk.Api.IAborApiAsync.GetJournalEntryLinesWithHttpInfoAsync ( string  scope,
string  code,
JournalEntryLinesQueryParameters  journalEntryLinesQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int?  limit = default(int?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Gets the Journal Entry lines for the given Abor The Journal Entry lines have been generated from transactions and translated via posting rules

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor. Together with the scope is creating the unique identifier for the given Abor.
journalEntryLinesQueryParametersThe query parameters used in running the generation of the Journal Entry lines.
asAtThe asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified. (optional)
filter&quot;Expression to filter the result set.&quot; (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfJournalEntryLine)

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetTrialBalanceAsync()

System.Threading.Tasks.Task<VersionedResourceListOfTrialBalance> Lusid.Sdk.Api.IAborApiAsync.GetTrialBalanceAsync ( string  scope,
string  code,
TrialBalanceQueryParameters  trialBalanceQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int?  limit = default(int?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Gets the Trial balance for the given Abor The Trial balance has been generated from transactions, translated via posting rules and aggregated based on a General Ledger Profile (where specified)

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor. Together with the scope is the unique identifier for the given Abor.
trialBalanceQueryParametersThe query parameters used in running the generation of the Trial Balance.
asAtThe asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified. (optional)
filter&quot;Expression to filter the result set.&quot; (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing Trial balance from a previous call to Trial balance. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionedResourceListOfTrialBalance

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetTrialBalanceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionedResourceListOfTrialBalance> > Lusid.Sdk.Api.IAborApiAsync.GetTrialBalanceWithHttpInfoAsync ( string  scope,
string  code,
TrialBalanceQueryParameters  trialBalanceQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int?  limit = default(int?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Gets the Trial balance for the given Abor The Trial balance has been generated from transactions, translated via posting rules and aggregated based on a General Ledger Profile (where specified)

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor. Together with the scope is the unique identifier for the given Abor.
trialBalanceQueryParametersThe query parameters used in running the generation of the Trial Balance.
asAtThe asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified. (optional)
filter&quot;Expression to filter the result set.&quot; (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing Trial balance from a previous call to Trial balance. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionedResourceListOfTrialBalance)

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListAborsAsync()

System.Threading.Tasks.Task<PagedResourceListOfAbor> Lusid.Sdk.Api.IAborApiAsync.ListAborsAsync ( 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,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListAbors: List Abors.

List all the Abors 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 Abor. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified. (optional)
pageThe pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (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 Abor type, specify &quot;id.Code eq &#39;Abor1&#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;Abor&#39; domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example &#39;Abor/Manager/Id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfAbor

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListAborsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfAbor> > Lusid.Sdk.Api.IAborApiAsync.ListAborsWithHttpInfoAsync ( 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,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListAbors: List Abors.

List all the Abors 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 Abor. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified. (optional)
pageThe pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (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 Abor type, specify &quot;id.Code eq &#39;Abor1&#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;Abor&#39; domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example &#39;Abor/Manager/Id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfAbor)

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListDiaryEntriesAsync()

System.Threading.Tasks.Task<PagedResourceListOfDiaryEntry> Lusid.Sdk.Api.IAborApiAsync.ListDiaryEntriesAsync ( 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 >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListDiaryEntries: List diary entries.

List all the diary entries matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
effectiveAtThe effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified. (optional)
pageThe pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (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 DiaryEntry 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)
propertyKeysA list of property keys from the &#39;DiaryEntry&#39; domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example &#39;DiaryEntry/Report/Id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfDiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListDiaryEntriesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfDiaryEntry> > Lusid.Sdk.Api.IAborApiAsync.ListDiaryEntriesWithHttpInfoAsync ( 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 >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListDiaryEntries: List diary entries.

List all the diary entries matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
effectiveAtThe effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified. (optional)
pageThe pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (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 DiaryEntry 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)
propertyKeysA list of property keys from the &#39;DiaryEntry&#39; domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example &#39;DiaryEntry/Report/Id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfDiaryEntry)

Implemented in Lusid.Sdk.Api.AborApi.

◆ LockPeriodAsync()

System.Threading.Tasks.Task<DiaryEntry> Lusid.Sdk.Api.IAborApiAsync.LockPeriodAsync ( string  scope,
string  code,
LockPeriodDiaryEntryRequest lockPeriodDiaryEntryRequest = default(LockPeriodDiaryEntryRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Locks the specified or last locked period for the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
lockPeriodDiaryEntryRequestThe request body, detailing lock details (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ LockPeriodWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DiaryEntry> > Lusid.Sdk.Api.IAborApiAsync.LockPeriodWithHttpInfoAsync ( string  scope,
string  code,
LockPeriodDiaryEntryRequest lockPeriodDiaryEntryRequest = default(LockPeriodDiaryEntryRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Locks the specified or last locked period for the given Abor.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor.
lockPeriodDiaryEntryRequestThe request body, detailing lock details (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DiaryEntry)

Implemented in Lusid.Sdk.Api.AborApi.

◆ PatchAborAsync()

System.Threading.Tasks.Task<Abor> Lusid.Sdk.Api.IAborApiAsync.PatchAborAsync ( string  scope,
string  code,
List< Operation operation,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] PatchAbor: Patch Abor.

Create or update certain fields for a particular Abor. The behaviour is defined by the JSON Patch specification. Currently supported fields are: PortfolioIds.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor. Together with the scope this uniquely identifies the Abor.
operationThe json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ PatchAborWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Abor> > Lusid.Sdk.Api.IAborApiAsync.PatchAborWithHttpInfoAsync ( string  scope,
string  code,
List< Operation operation,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] PatchAbor: Patch Abor.

Create or update certain fields for a particular Abor. The behaviour is defined by the JSON Patch specification. Currently supported fields are: PortfolioIds.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor.
codeThe code of the Abor. Together with the scope this uniquely identifies the Abor.
operationThe json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Abor)

Implemented in Lusid.Sdk.Api.AborApi.

◆ ReOpenPeriodsAsync()

System.Threading.Tasks.Task<PeriodDiaryEntriesReopenedResponse> Lusid.Sdk.Api.IAborApiAsync.ReOpenPeriodsAsync ( string  scope,
string  code,
ReOpenPeriodDiaryEntryRequest reOpenPeriodDiaryEntryRequest = default(ReOpenPeriodDiaryEntryRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Reopens one or more periods.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor to be deleted.
codeThe code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
reOpenPeriodDiaryEntryRequestThe request body, detailing re open details (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PeriodDiaryEntriesReopenedResponse

Implemented in Lusid.Sdk.Api.AborApi.

◆ ReOpenPeriodsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PeriodDiaryEntriesReopenedResponse> > Lusid.Sdk.Api.IAborApiAsync.ReOpenPeriodsWithHttpInfoAsync ( string  scope,
string  code,
ReOpenPeriodDiaryEntryRequest reOpenPeriodDiaryEntryRequest = default(ReOpenPeriodDiaryEntryRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

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

Reopens one or more periods.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Abor to be deleted.
codeThe code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
reOpenPeriodDiaryEntryRequestThe request body, detailing re open details (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PeriodDiaryEntriesReopenedResponse)

Implemented in Lusid.Sdk.Api.AborApi.

◆ UpsertAborPropertiesAsync()

System.Threading.Tasks.Task<AborProperties> Lusid.Sdk.Api.IAborApiAsync.UpsertAborPropertiesAsync ( string  scope,
string  code,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties

Update or insert one or more properties onto a single Abor. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain &#39;Abor&#39;. Upserting a property that exists for an Abor, with a null value, will delete the instance of the property for that group. Properties have an <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 Abor to update or insert the properties onto.
codeThe code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor.
requestBodyThe properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. &quot;Abor/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AborProperties

Implemented in Lusid.Sdk.Api.AborApi.

◆ UpsertAborPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AborProperties> > Lusid.Sdk.Api.IAborApiAsync.UpsertAborPropertiesWithHttpInfoAsync ( string  scope,
string  code,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties

Update or insert one or more properties onto a single Abor. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain &#39;Abor&#39;. Upserting a property that exists for an Abor, with a null value, will delete the instance of the property for that group. Properties have an <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 Abor to update or insert the properties onto.
codeThe code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor.
requestBodyThe properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. &quot;Abor/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AborProperties)

Implemented in Lusid.Sdk.Api.AborApi.


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