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

Inheritance diagram for Lusid.Sdk.Api.IAborApiSync:

[legend]

Public Member Functions
DiaryEntry	AddDiaryEntry (string scope, string code, string diaryEntryCode, DiaryEntryRequest diaryEntryRequest, int operationIndex=0)
	[EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. More...

ApiResponse< DiaryEntry >	AddDiaryEntryWithHttpInfo (string scope, string code, string diaryEntryCode, DiaryEntryRequest diaryEntryRequest, int operationIndex=0)
	[EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. More...

DiaryEntry	ClosePeriod (string scope, string code, ClosePeriodDiaryEntryRequest closePeriodDiaryEntryRequest, int operationIndex=0)
	[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. More...

ApiResponse< DiaryEntry >	ClosePeriodWithHttpInfo (string scope, string code, ClosePeriodDiaryEntryRequest closePeriodDiaryEntryRequest, int operationIndex=0)
	[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. More...

Abor	CreateAbor (string scope, AborRequest aborRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateAbor: Create an Abor. More...

ApiResponse< Abor >	CreateAborWithHttpInfo (string scope, AborRequest aborRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateAbor: Create an Abor. More...

DeletedEntityResponse	DeleteAbor (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteAbor: Delete an Abor. More...

ApiResponse< DeletedEntityResponse >	DeleteAborWithHttpInfo (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteAbor: Delete an Abor. More...

Abor	GetAbor (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetAbor: Get Abor. More...

ApiResponse< Abor >	GetAborWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetAbor: Get Abor. More...

VersionedResourceListOfJournalEntryLine	GetJournalEntryLines (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)
	[EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. More...

ApiResponse< VersionedResourceListOfJournalEntryLine >	GetJournalEntryLinesWithHttpInfo (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)
	[EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. More...

VersionedResourceListOfTrialBalance	GetTrialBalance (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)
	[EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. More...

ApiResponse< VersionedResourceListOfTrialBalance >	GetTrialBalanceWithHttpInfo (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)
	[EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. More...

PagedResourceListOfAbor	ListAbors (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] ListAbors: List Abors. More...

ApiResponse< PagedResourceListOfAbor >	ListAborsWithHttpInfo (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] ListAbors: List Abors. More...

PagedResourceListOfDiaryEntry	ListDiaryEntries (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)
	[EXPERIMENTAL] ListDiaryEntries: List diary entries. More...

ApiResponse< PagedResourceListOfDiaryEntry >	ListDiaryEntriesWithHttpInfo (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)
	[EXPERIMENTAL] ListDiaryEntries: List diary entries. More...

DiaryEntry	LockPeriod (string scope, string code, LockPeriodDiaryEntryRequest? lockPeriodDiaryEntryRequest=default(LockPeriodDiaryEntryRequest?), int operationIndex=0)
	[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. More...

ApiResponse< DiaryEntry >	LockPeriodWithHttpInfo (string scope, string code, LockPeriodDiaryEntryRequest? lockPeriodDiaryEntryRequest=default(LockPeriodDiaryEntryRequest?), int operationIndex=0)
	[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. More...

Abor	PatchAbor (string scope, string code, List< Operation > operation, int operationIndex=0)
	[EXPERIMENTAL] PatchAbor: Patch Abor. More...

ApiResponse< Abor >	PatchAborWithHttpInfo (string scope, string code, List< Operation > operation, int operationIndex=0)
	[EXPERIMENTAL] PatchAbor: Patch Abor. More...

PeriodDiaryEntriesReopenedResponse	ReOpenPeriods (string scope, string code, ReOpenPeriodDiaryEntryRequest? reOpenPeriodDiaryEntryRequest=default(ReOpenPeriodDiaryEntryRequest?), int operationIndex=0)
	[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. More...

ApiResponse< PeriodDiaryEntriesReopenedResponse >	ReOpenPeriodsWithHttpInfo (string scope, string code, ReOpenPeriodDiaryEntryRequest? reOpenPeriodDiaryEntryRequest=default(ReOpenPeriodDiaryEntryRequest?), int operationIndex=0)
	[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. More...

AborProperties	UpsertAborProperties (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
	[EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties More...

ApiResponse< AborProperties >	UpsertAborPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
	[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

◆ AddDiaryEntry()

DiaryEntry Lusid.Sdk.Api.IAborApiSync.AddDiaryEntry	(	string	scope,
		string	code,
		string	diaryEntryCode,
		DiaryEntryRequest	diaryEntryRequest,
		int	operationIndex = `0`
	)

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

Adds a new diary entry to the specified Abor

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
diaryEntryCode	Diary entry code
diaryEntryRequest	The diary entry to add.
operationIndex	Index associated with the operation.

Returns: DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ AddDiaryEntryWithHttpInfo()

ApiResponse<DiaryEntry> Lusid.Sdk.Api.IAborApiSync.AddDiaryEntryWithHttpInfo	(	string	scope,
		string	code,
		string	diaryEntryCode,
		DiaryEntryRequest	diaryEntryRequest,
		int	operationIndex = `0`
	)

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

Adds a new diary entry to the specified Abor

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
diaryEntryCode	Diary entry code
diaryEntryRequest	The diary entry to add.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ ClosePeriod()

DiaryEntry Lusid.Sdk.Api.IAborApiSync.ClosePeriod	(	string	scope,
		string	code,
		ClosePeriodDiaryEntryRequest	closePeriodDiaryEntryRequest,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
closePeriodDiaryEntryRequest	The request body, containing details to apply to the closing/locking period.
operationIndex	Index associated with the operation.

Returns: DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ ClosePeriodWithHttpInfo()

ApiResponse<DiaryEntry> Lusid.Sdk.Api.IAborApiSync.ClosePeriodWithHttpInfo	(	string	scope,
		string	code,
		ClosePeriodDiaryEntryRequest	closePeriodDiaryEntryRequest,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
closePeriodDiaryEntryRequest	The request body, containing details to apply to the closing/locking period.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ CreateAbor()

Abor Lusid.Sdk.Api.IAborApiSync.CreateAbor	(	string	scope,
		AborRequest	aborRequest,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] CreateAbor: Create an Abor.

Create the given Abor.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
aborRequest	The definition of the Abor.
operationIndex	Index associated with the operation.

Returns: Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ CreateAborWithHttpInfo()

ApiResponse<Abor> Lusid.Sdk.Api.IAborApiSync.CreateAborWithHttpInfo	(	string	scope,
		AborRequest	aborRequest,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] CreateAbor: Create an Abor.

Create the given Abor.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
aborRequest	The definition of the Abor.
operationIndex	Index associated with the operation.

Returns: ApiResponse of Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ DeleteAbor()

DeletedEntityResponse Lusid.Sdk.Api.IAborApiSync.DeleteAbor	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] DeleteAbor: Delete an Abor.

Delete the given Abor.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor to be deleted.
code	The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AborApi.

◆ DeleteAborWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IAborApiSync.DeleteAborWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] DeleteAbor: Delete an Abor.

Delete the given Abor.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor to be deleted.
code	The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetAbor()

Abor Lusid.Sdk.Api.IAborApiSync.GetAbor	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetAbor: Get Abor.

Retrieve the definition of a particular Abor.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope this uniquely identifies the Abor.
effectiveAt	The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified. (optional)
propertyKeys	A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.

Returns: Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetAborWithHttpInfo()

ApiResponse<Abor> Lusid.Sdk.Api.IAborApiSync.GetAborWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetAbor: Get Abor.

Retrieve the definition of a particular Abor.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope this uniquely identifies the Abor.
effectiveAt	The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified. (optional)
propertyKeys	A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetJournalEntryLines()

VersionedResourceListOfJournalEntryLine Lusid.Sdk.Api.IAborApiSync.GetJournalEntryLines	(	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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope is creating the unique identifier for the given Abor.
journalEntryLinesQueryParameters	The query parameters used in running the generation of the Journal Entry lines.
asAt	The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	"Expression to filter the result set." (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines. (optional)
operationIndex	Index associated with the operation.

Returns: VersionedResourceListOfJournalEntryLine

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetJournalEntryLinesWithHttpInfo()

ApiResponse<VersionedResourceListOfJournalEntryLine> Lusid.Sdk.Api.IAborApiSync.GetJournalEntryLinesWithHttpInfo	(	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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope is creating the unique identifier for the given Abor.
journalEntryLinesQueryParameters	The query parameters used in running the generation of the Journal Entry lines.
asAt	The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	"Expression to filter the result set." (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of VersionedResourceListOfJournalEntryLine

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetTrialBalance()

VersionedResourceListOfTrialBalance Lusid.Sdk.Api.IAborApiSync.GetTrialBalance	(	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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope is the unique identifier for the given Abor.
trialBalanceQueryParameters	The query parameters used in running the generation of the Trial Balance.
asAt	The asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	"Expression to filter the result set." (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing Trial balance from a previous call to Trial balance. (optional)
operationIndex	Index associated with the operation.

Returns: VersionedResourceListOfTrialBalance

Implemented in Lusid.Sdk.Api.AborApi.

◆ GetTrialBalanceWithHttpInfo()

ApiResponse<VersionedResourceListOfTrialBalance> Lusid.Sdk.Api.IAborApiSync.GetTrialBalanceWithHttpInfo	(	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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope is the unique identifier for the given Abor.
trialBalanceQueryParameters	The query parameters used in running the generation of the Trial Balance.
asAt	The asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified. (optional)
filter	"Expression to filter the result set." (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing Trial balance from a previous call to Trial balance. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of VersionedResourceListOfTrialBalance

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListAbors()

PagedResourceListOfAbor Lusid.Sdk.Api.IAborApiSync.ListAbors	(	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] ListAbors: List Abors.

List all the Abors matching particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the Abor. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified. (optional)
page	The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the Abor type, specify "id.Code eq 'Abor1'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfAbor

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListAborsWithHttpInfo()

ApiResponse<PagedResourceListOfAbor> Lusid.Sdk.Api.IAborApiSync.ListAborsWithHttpInfo	(	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] ListAbors: List Abors.

List all the Abors matching particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the Abor. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified. (optional)
page	The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the Abor type, specify "id.Code eq 'Abor1'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfAbor

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListDiaryEntries()

PagedResourceListOfDiaryEntry Lusid.Sdk.Api.IAborApiSync.ListDiaryEntries	(	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`
	)

[EXPERIMENTAL] ListDiaryEntries: List diary entries.

List all the diary entries matching particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified. (optional)
page	The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the DiaryEntry type, specify "type eq 'PeriodBoundary'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'. (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfDiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ ListDiaryEntriesWithHttpInfo()

ApiResponse<PagedResourceListOfDiaryEntry> Lusid.Sdk.Api.IAborApiSync.ListDiaryEntriesWithHttpInfo	(	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`
	)

[EXPERIMENTAL] ListDiaryEntries: List diary entries.

List all the diary entries matching particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified. (optional)
page	The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the DiaryEntry type, specify "type eq 'PeriodBoundary'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfDiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ LockPeriod()

DiaryEntry Lusid.Sdk.Api.IAborApiSync.LockPeriod	(	string	scope,
		string	code,
		LockPeriodDiaryEntryRequest?	lockPeriodDiaryEntryRequest = `default(LockPeriodDiaryEntryRequest?)`,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
lockPeriodDiaryEntryRequest	The request body, detailing lock details (optional)
operationIndex	Index associated with the operation.

Returns: DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ LockPeriodWithHttpInfo()

ApiResponse<DiaryEntry> Lusid.Sdk.Api.IAborApiSync.LockPeriodWithHttpInfo	(	string	scope,
		string	code,
		LockPeriodDiaryEntryRequest?	lockPeriodDiaryEntryRequest = `default(LockPeriodDiaryEntryRequest?)`,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor.
lockPeriodDiaryEntryRequest	The request body, detailing lock details (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DiaryEntry

Implemented in Lusid.Sdk.Api.AborApi.

◆ PatchAbor()

Abor Lusid.Sdk.Api.IAborApiSync.PatchAbor	(	string	scope,
		string	code,
		List< Operation >	operation,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope this uniquely identifies the Abor.
operation	The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndex	Index associated with the operation.

Returns: Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ PatchAborWithHttpInfo()

ApiResponse<Abor> Lusid.Sdk.Api.IAborApiSync.PatchAborWithHttpInfo	(	string	scope,
		string	code,
		List< Operation >	operation,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor.
code	The code of the Abor. Together with the scope this uniquely identifies the Abor.
operation	The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndex	Index associated with the operation.

Returns: ApiResponse of Abor

Implemented in Lusid.Sdk.Api.AborApi.

◆ ReOpenPeriods()

PeriodDiaryEntriesReopenedResponse Lusid.Sdk.Api.IAborApiSync.ReOpenPeriods	(	string	scope,
		string	code,
		ReOpenPeriodDiaryEntryRequest?	reOpenPeriodDiaryEntryRequest = `default(ReOpenPeriodDiaryEntryRequest?)`,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor to be deleted.
code	The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
reOpenPeriodDiaryEntryRequest	The request body, detailing re open details (optional)
operationIndex	Index associated with the operation.

Returns: PeriodDiaryEntriesReopenedResponse

Implemented in Lusid.Sdk.Api.AborApi.

◆ ReOpenPeriodsWithHttpInfo()

ApiResponse<PeriodDiaryEntriesReopenedResponse> Lusid.Sdk.Api.IAborApiSync.ReOpenPeriodsWithHttpInfo	(	string	scope,
		string	code,
		ReOpenPeriodDiaryEntryRequest?	reOpenPeriodDiaryEntryRequest = `default(ReOpenPeriodDiaryEntryRequest?)`,
		int	operationIndex = `0`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor to be deleted.
code	The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.
reOpenPeriodDiaryEntryRequest	The request body, detailing re open details (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PeriodDiaryEntriesReopenedResponse

Implemented in Lusid.Sdk.Api.AborApi.

◆ UpsertAborProperties()

AborProperties Lusid.Sdk.Api.IAborApiSync.UpsertAborProperties	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary< string, Property >?)`,
		int	operationIndex = `0`
	)

[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 'Abor'. Upserting a property that exists for an Abor, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor to update or insert the properties onto.
code	The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor.
requestBody	The properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "Abor/Manager/Id". (optional)
operationIndex	Index associated with the operation.

Returns: AborProperties

Implemented in Lusid.Sdk.Api.AborApi.

◆ UpsertAborPropertiesWithHttpInfo()

ApiResponse<AborProperties> Lusid.Sdk.Api.IAborApiSync.UpsertAborPropertiesWithHttpInfo	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary< string, Property >?)`,
		int	operationIndex = `0`
	)

[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 'Abor'. Upserting a property that exists for an Abor, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Abor to update or insert the properties onto.
code	The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor.
requestBody	The properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "Abor/Manager/Id". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of AborProperties

Implemented in Lusid.Sdk.Api.AborApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/AborApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddDiaryEntry()

◆ AddDiaryEntryWithHttpInfo()

◆ ClosePeriod()

◆ ClosePeriodWithHttpInfo()

◆ CreateAbor()

◆ CreateAborWithHttpInfo()

◆ DeleteAbor()

◆ DeleteAborWithHttpInfo()

◆ GetAbor()

◆ GetAborWithHttpInfo()

◆ GetJournalEntryLines()

◆ GetJournalEntryLinesWithHttpInfo()

◆ GetTrialBalance()

◆ GetTrialBalanceWithHttpInfo()

◆ ListAbors()

◆ ListAborsWithHttpInfo()

◆ ListDiaryEntries()

◆ ListDiaryEntriesWithHttpInfo()

◆ LockPeriod()

◆ LockPeriodWithHttpInfo()

◆ PatchAbor()

◆ PatchAborWithHttpInfo()

◆ ReOpenPeriods()

◆ ReOpenPeriodsWithHttpInfo()

◆ UpsertAborProperties()

◆ UpsertAborPropertiesWithHttpInfo()