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

Inheritance diagram for Lusid.Sdk.Api.ITransactionConfigurationApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteSideDefinitionAsync (string side, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteSideDefinition: Delete the given side definition More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteSideDefinitionWithHttpInfoAsync (string side, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteSideDefinition: Delete the given side definition More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteTransactionTypeAsync (string source, string type, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteTransactionType: Delete a transaction type More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteTransactionTypeWithHttpInfoAsync (string source, string type, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteTransactionType: Delete a transaction type More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteTransactionTypeSourceAsync (string source, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteTransactionTypeSource: Delete all transaction types for the given source and scope More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteTransactionTypeSourceWithHttpInfoAsync (string source, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteTransactionTypeSource: Delete all transaction types for the given source and scope More...

System.Threading.Tasks.Task< SideDefinition >	GetSideDefinitionAsync (string side, string? scope=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetSideDefinition: Get the side definition for a given side name( or label) More...

System.Threading.Tasks.Task< ApiResponse< SideDefinition > >	GetSideDefinitionWithHttpInfoAsync (string side, string? scope=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetSideDefinition: Get the side definition for a given side name( or label) More...

System.Threading.Tasks.Task< TransactionType >	GetTransactionTypeAsync (string source, string type, DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetTransactionType: Get a single transaction configuration type More...

System.Threading.Tasks.Task< ApiResponse< TransactionType > >	GetTransactionTypeWithHttpInfoAsync (string source, string type, DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetTransactionType: Get a single transaction configuration type More...

System.Threading.Tasks.Task< ResourceListOfSideDefinition >	ListSideDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListSideDefinitions: List the side definitions More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfSideDefinition > >	ListSideDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListSideDefinitions: List the side definitions More...

System.Threading.Tasks.Task< Dictionary< string, List< TransactionType > > >	ListTransactionTypesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListTransactionTypes: List transaction types More...

System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< TransactionType > > > >	ListTransactionTypesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListTransactionTypes: List transaction types More...

System.Threading.Tasks.Task< SideDefinition >	SetSideDefinitionAsync (string side, SideDefinitionRequest sideDefinitionRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetSideDefinition: Set a side definition More...

System.Threading.Tasks.Task< ApiResponse< SideDefinition > >	SetSideDefinitionWithHttpInfoAsync (string side, SideDefinitionRequest sideDefinitionRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetSideDefinition: Set a side definition More...

System.Threading.Tasks.Task< ResourceListOfSideDefinition >	SetSideDefinitionsAsync (List< SidesDefinitionRequest > sidesDefinitionRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetSideDefinitions: Set the given side definitions More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfSideDefinition > >	SetSideDefinitionsWithHttpInfoAsync (List< SidesDefinitionRequest > sidesDefinitionRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetSideDefinitions: Set the given side definitions More...

System.Threading.Tasks.Task< TransactionType >	SetTransactionTypeAsync (string source, string type, TransactionTypeRequest transactionTypeRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetTransactionType: Set a specific transaction type More...

System.Threading.Tasks.Task< ApiResponse< TransactionType > >	SetTransactionTypeWithHttpInfoAsync (string source, string type, TransactionTypeRequest transactionTypeRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetTransactionType: Set a specific transaction type More...

System.Threading.Tasks.Task< ResourceListOfTransactionType >	SetTransactionTypeSourceAsync (string source, List< TransactionTypeRequest > transactionTypeRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetTransactionTypeSource: Set the transaction types for the given source and scope More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfTransactionType > >	SetTransactionTypeSourceWithHttpInfoAsync (string source, List< TransactionTypeRequest > transactionTypeRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SetTransactionTypeSource: Set the transaction types for the given source and scope 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

◆ DeleteSideDefinitionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.DeleteSideDefinitionAsync	(	string	side,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteSideDefinition: Delete the given side definition

Delete the side which user specify in the request.

Exceptions

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

Parameters

side	The label to uniquely identify the side.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ DeleteSideDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.DeleteSideDefinitionWithHttpInfoAsync	(	string	side,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteSideDefinition: Delete the given side definition

Delete the side which user specify in the request.

Exceptions

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

Parameters

side	The label to uniquely identify the side.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ DeleteTransactionTypeAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.DeleteTransactionTypeAsync	(	string	source,
		string	type,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteTransactionType: Delete a transaction type

/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source that the type is in
type	One of the type's aliases
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ DeleteTransactionTypeSourceAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.DeleteTransactionTypeSourceAsync	(	string	source,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteTransactionTypeSource: Delete all transaction types for the given source and scope

Delete all the types for the given source and scope.

Exceptions

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

Parameters

source	The source to set the transaction types for.
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ DeleteTransactionTypeSourceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.DeleteTransactionTypeSourceWithHttpInfoAsync	(	string	source,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteTransactionTypeSource: Delete all transaction types for the given source and scope

Delete all the types for the given source and scope.

Exceptions

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

Parameters

source	The source to set the transaction types for.
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ DeleteTransactionTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.DeleteTransactionTypeWithHttpInfoAsync	(	string	source,
		string	type,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteTransactionType: Delete a transaction type

/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source that the type is in
type	One of the type's aliases
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ GetSideDefinitionAsync()

System.Threading.Tasks.Task<SideDefinition> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.GetSideDefinitionAsync	(	string	side,
		string?	scope = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetSideDefinition: Get the side definition for a given side name( or label)

Get the side definition user requested.

Exceptions

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

Parameters

side	The label to uniquely identify the side.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of SideDefinition

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ GetSideDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<SideDefinition> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.GetSideDefinitionWithHttpInfoAsync	(	string	side,
		string?	scope = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetSideDefinition: Get the side definition for a given side name( or label)

Get the side definition user requested.

Exceptions

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

Parameters

side	The label to uniquely identify the side.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (SideDefinition)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ GetTransactionTypeAsync()

System.Threading.Tasks.Task<TransactionType> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.GetTransactionTypeAsync	(	string	source,
		string	type,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetTransactionType: Get a single transaction configuration type

Get a single transaction type. Returns failure if not found

Exceptions

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

Parameters

source	The source that the type is in
type	One of the type's aliases
asAt	The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified (optional)
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionType

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ GetTransactionTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionType> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.GetTransactionTypeWithHttpInfoAsync	(	string	source,
		string	type,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetTransactionType: Get a single transaction configuration type

Get a single transaction type. Returns failure if not found

Exceptions

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

Parameters

source	The source that the type is in
type	One of the type's aliases
asAt	The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified (optional)
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionType)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ ListSideDefinitionsAsync()

System.Threading.Tasks.Task<ResourceListOfSideDefinition> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.ListSideDefinitionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListSideDefinitions: List the side definitions

List all the side definitions in the given scope

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfSideDefinition

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ ListSideDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfSideDefinition> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.ListSideDefinitionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListSideDefinitions: List the side definitions

List all the side definitions in the given scope

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfSideDefinition)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ ListTransactionTypesAsync()

System.Threading.Tasks.Task<Dictionary<string, List<TransactionType> > > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.ListTransactionTypesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListTransactionTypes: List transaction types

Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Dictionary<string, List<TransactionType>>

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ ListTransactionTypesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Dictionary<string, List<TransactionType> > > > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.ListTransactionTypesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListTransactionTypes: List transaction types

Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Dictionary<string, List<TransactionType>>)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetSideDefinitionAsync()

System.Threading.Tasks.Task<SideDefinition> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetSideDefinitionAsync	(	string	side,
		SideDefinitionRequest	sideDefinitionRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetSideDefinition: Set a side definition

Set a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions

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

Parameters

side	The label to uniquely identify the side.
sideDefinitionRequest	The side definition to create or replace.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of SideDefinition

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetSideDefinitionsAsync()

System.Threading.Tasks.Task<ResourceListOfSideDefinition> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetSideDefinitionsAsync	(	List< SidesDefinitionRequest >	sidesDefinitionRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetSideDefinitions: Set the given side definitions

Set a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions

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

Parameters

sidesDefinitionRequest	The list of side definitions to create, or replace.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfSideDefinition

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetSideDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfSideDefinition> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetSideDefinitionsWithHttpInfoAsync	(	List< SidesDefinitionRequest >	sidesDefinitionRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetSideDefinitions: Set the given side definitions

Set a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions

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

Parameters

sidesDefinitionRequest	The list of side definitions to create, or replace.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfSideDefinition)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetSideDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<SideDefinition> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetSideDefinitionWithHttpInfoAsync	(	string	side,
		SideDefinitionRequest	sideDefinitionRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetSideDefinition: Set a side definition

Set a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions

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

Parameters

side	The label to uniquely identify the side.
sideDefinitionRequest	The side definition to create or replace.
scope	The scope in which the side exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (SideDefinition)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetTransactionTypeAsync()

System.Threading.Tasks.Task<TransactionType> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetTransactionTypeAsync	(	string	source,
		string	type,
		TransactionTypeRequest	transactionTypeRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetTransactionType: Set a specific transaction type

Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source to set the transaction configuration for
type	One of the transaction configuration alias types to uniquely identify the configuration. If this type does not exist, then a new transaction type is created using the body of the request in the given source, without including this type
transactionTypeRequest	The transaction configuration to set
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionType

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetTransactionTypeSourceAsync()

System.Threading.Tasks.Task<ResourceListOfTransactionType> Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetTransactionTypeSourceAsync	(	string	source,
		List< TransactionTypeRequest >	transactionTypeRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetTransactionTypeSource: Set the transaction types for the given source and scope

The complete set of transaction types for the source.

Exceptions

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

Parameters

source	The source to set the transaction types for.
transactionTypeRequest	The set of transaction types.
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfTransactionType

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetTransactionTypeSourceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfTransactionType> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetTransactionTypeSourceWithHttpInfoAsync	(	string	source,
		List< TransactionTypeRequest >	transactionTypeRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetTransactionTypeSource: Set the transaction types for the given source and scope

The complete set of transaction types for the source.

Exceptions

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

Parameters

source	The source to set the transaction types for.
transactionTypeRequest	The set of transaction types.
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfTransactionType)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

◆ SetTransactionTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionType> > Lusid.Sdk.Api.ITransactionConfigurationApiAsync.SetTransactionTypeWithHttpInfoAsync	(	string	source,
		string	type,
		TransactionTypeRequest	transactionTypeRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SetTransactionType: Set a specific transaction type

Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source to set the transaction configuration for
type	One of the transaction configuration alias types to uniquely identify the configuration. If this type does not exist, then a new transaction type is created using the body of the request in the given source, without including this type
transactionTypeRequest	The transaction configuration to set
scope	The scope in which the transaction types exists. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionType)

Implemented in Lusid.Sdk.Api.TransactionConfigurationApi.

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/TransactionConfigurationApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteSideDefinitionAsync()

◆ DeleteSideDefinitionWithHttpInfoAsync()

◆ DeleteTransactionTypeAsync()

◆ DeleteTransactionTypeSourceAsync()

◆ DeleteTransactionTypeSourceWithHttpInfoAsync()

◆ DeleteTransactionTypeWithHttpInfoAsync()

◆ GetSideDefinitionAsync()

◆ GetSideDefinitionWithHttpInfoAsync()

◆ GetTransactionTypeAsync()

◆ GetTransactionTypeWithHttpInfoAsync()

◆ ListSideDefinitionsAsync()

◆ ListSideDefinitionsWithHttpInfoAsync()

◆ ListTransactionTypesAsync()

◆ ListTransactionTypesWithHttpInfoAsync()

◆ SetSideDefinitionAsync()

◆ SetSideDefinitionsAsync()

◆ SetSideDefinitionsWithHttpInfoAsync()

◆ SetSideDefinitionWithHttpInfoAsync()

◆ SetTransactionTypeAsync()

◆ SetTransactionTypeSourceAsync()

◆ SetTransactionTypeSourceWithHttpInfoAsync()

◆ SetTransactionTypeWithHttpInfoAsync()