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

Inheritance diagram for Lusid.Sdk.Api.IOrderManagementApiSync:

[legend]

Public Member Functions
BookTransactionsResponse	BookTransactions (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), bool? markOrdersAndAllocationsAsBooked=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	BookTransactions: Books transactions using specific allocations as a source. More...

Lusid.Sdk.Client.ApiResponse< BookTransactionsResponse >	BookTransactionsWithHttpInfo (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), bool? markOrdersAndAllocationsAsBooked=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	BookTransactions: Books transactions using specific allocations as a source. More...

CancelOrdersResponse	CancelOrders (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CancelOrders: Cancel existing orders More...

Lusid.Sdk.Client.ApiResponse< CancelOrdersResponse >	CancelOrdersWithHttpInfo (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CancelOrders: Cancel existing orders More...

CancelOrdersAndMoveRemainingResponse	CancelOrdersAndMoveRemaining (Dictionary< string, CancelOrdersAndMoveRemainingRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks More...

Lusid.Sdk.Client.ApiResponse< CancelOrdersAndMoveRemainingResponse >	CancelOrdersAndMoveRemainingWithHttpInfo (Dictionary< string, CancelOrdersAndMoveRemainingRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks More...

CancelPlacementsResponse	CancelPlacements (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CancelPlacements: Cancel existing placements More...

Lusid.Sdk.Client.ApiResponse< CancelPlacementsResponse >	CancelPlacementsWithHttpInfo (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CancelPlacements: Cancel existing placements More...

ResourceListOfBlockAndOrders	CreateOrders (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreateOrders: Upsert a Block and associated orders More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfBlockAndOrders >	CreateOrdersWithHttpInfo (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreateOrders: Upsert a Block and associated orders More...

ResourceListOfChangeIntervalWithOrderManagementDetail	GetOrderHistory (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetOrderHistory: Get the history of an order and related entity changes More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfChangeIntervalWithOrderManagementDetail >	GetOrderHistoryWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetOrderHistory: Get the history of an order and related entity changes More...

ResourceListOfMovedOrderToDifferentBlockResponse	MoveOrders (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] MoveOrders: Move orders to new or existing block More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfMovedOrderToDifferentBlockResponse >	MoveOrdersWithHttpInfo (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] MoveOrders: Move orders to new or existing block More...

ResourceListOfPlacement	PlaceBlocks (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfPlacement >	PlaceBlocksWithHttpInfo (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. More...

AllocationServiceRunResponse	RunAllocationService (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	RunAllocationService: Runs the Allocation Service More...

Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponse >	RunAllocationServiceWithHttpInfo (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	RunAllocationService: Runs the Allocation Service More...

AllocationServiceRunResponse	RunAllocationServiceWithWeights (WeightedAllocationServiceRunRequest weightedAllocationServiceRunRequest, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights More...

Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponse >	RunAllocationServiceWithWeightsWithHttpInfo (WeightedAllocationServiceRunRequest weightedAllocationServiceRunRequest, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights More...

SweepBlocksResponse	SweepBlocks (SweepBlocksRequest sweepBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. More...

Lusid.Sdk.Client.ApiResponse< SweepBlocksResponse >	SweepBlocksWithHttpInfo (SweepBlocksRequest sweepBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. More...

UpdateOrdersResponse	UpdateOrders (Dictionary< string, OrderUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateOrders: Update existing orders More...

Lusid.Sdk.Client.ApiResponse< UpdateOrdersResponse >	UpdateOrdersWithHttpInfo (Dictionary< string, OrderUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateOrders: Update existing orders More...

UpdatePlacementsResponse	UpdatePlacements (Dictionary< string, PlacementUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdatePlacements: Update existing placements More...

Lusid.Sdk.Client.ApiResponse< UpdatePlacementsResponse >	UpdatePlacementsWithHttpInfo (Dictionary< string, PlacementUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdatePlacements: Update existing placements More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ BookTransactions()

BookTransactionsResponse Lusid.Sdk.Api.IOrderManagementApiSync.BookTransactions	(	BookTransactionsRequest	bookTransactionsRequest,
		bool?	applyFeesAndCommission = `default(bool?)`,
		bool?	markOrdersAndAllocationsAsBooked = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

BookTransactions: Books transactions using specific allocations as a source.

Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions.

Exceptions

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

Parameters

bookTransactionsRequest	The allocations to create transactions for
applyFeesAndCommission	Whether to apply fees and commissions to transactions (default: true) (optional, default to true)
markOrdersAndAllocationsAsBooked	Whether to mark allocations and fully-booked orders with state Booked (optional, default to false)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: BookTransactionsResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ BookTransactionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BookTransactionsResponse> Lusid.Sdk.Api.IOrderManagementApiSync.BookTransactionsWithHttpInfo	(	BookTransactionsRequest	bookTransactionsRequest,
		bool?	applyFeesAndCommission = `default(bool?)`,
		bool?	markOrdersAndAllocationsAsBooked = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

BookTransactions: Books transactions using specific allocations as a source.

Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions.

Exceptions

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

Parameters

bookTransactionsRequest	The allocations to create transactions for
applyFeesAndCommission	Whether to apply fees and commissions to transactions (default: true) (optional, default to true)
markOrdersAndAllocationsAsBooked	Whether to mark allocations and fully-booked orders with state Booked (optional, default to false)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of BookTransactionsResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CancelOrders()

CancelOrdersResponse Lusid.Sdk.Api.IOrderManagementApiSync.CancelOrders	(	Dictionary< string, ResourceId >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CancelOrders: Cancel existing orders

The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the ids of the orders to be cancelled.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CancelOrdersResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CancelOrdersAndMoveRemaining()

CancelOrdersAndMoveRemainingResponse Lusid.Sdk.Api.IOrderManagementApiSync.CancelOrdersAndMoveRemaining	(	Dictionary< string, CancelOrdersAndMoveRemainingRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks

Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis.

Exceptions

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

Parameters

requestBody	The request containing the orders to be cancelled, and the destinations of remaining quantities.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CancelOrdersAndMoveRemainingResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CancelOrdersAndMoveRemainingWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CancelOrdersAndMoveRemainingResponse> Lusid.Sdk.Api.IOrderManagementApiSync.CancelOrdersAndMoveRemainingWithHttpInfo	(	Dictionary< string, CancelOrdersAndMoveRemainingRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks

Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis.

Exceptions

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

Parameters

requestBody	The request containing the orders to be cancelled, and the destinations of remaining quantities.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CancelOrdersAndMoveRemainingResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CancelOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CancelOrdersResponse> Lusid.Sdk.Api.IOrderManagementApiSync.CancelOrdersWithHttpInfo	(	Dictionary< string, ResourceId >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CancelOrders: Cancel existing orders

The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the ids of the orders to be cancelled.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CancelOrdersResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CancelPlacements()

CancelPlacementsResponse Lusid.Sdk.Api.IOrderManagementApiSync.CancelPlacements	(	Dictionary< string, ResourceId >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CancelPlacements: Cancel existing placements

The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the ids of the placements to be cancelled.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CancelPlacementsResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CancelPlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CancelPlacementsResponse> Lusid.Sdk.Api.IOrderManagementApiSync.CancelPlacementsWithHttpInfo	(	Dictionary< string, ResourceId >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CancelPlacements: Cancel existing placements

The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the ids of the placements to be cancelled.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CancelPlacementsResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CreateOrders()

ResourceListOfBlockAndOrders Lusid.Sdk.Api.IOrderManagementApiSync.CreateOrders	(	BlockAndOrdersCreateRequest	blockAndOrdersCreateRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

CreateOrders: Upsert a Block and associated orders

Create orders, and blocks if they don't already exist. This will fail if the block exists and already references orders with differing blocking fields.

Exceptions

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

Parameters

blockAndOrdersCreateRequest	The collection of block and orders requests.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfBlockAndOrders

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CreateOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfBlockAndOrders> Lusid.Sdk.Api.IOrderManagementApiSync.CreateOrdersWithHttpInfo	(	BlockAndOrdersCreateRequest	blockAndOrdersCreateRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

CreateOrders: Upsert a Block and associated orders

Create orders, and blocks if they don't already exist. This will fail if the block exists and already references orders with differing blocking fields.

Exceptions

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

Parameters

blockAndOrdersCreateRequest	The collection of block and orders requests.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfBlockAndOrders

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ GetOrderHistory()

ResourceListOfChangeIntervalWithOrderManagementDetail Lusid.Sdk.Api.IOrderManagementApiSync.GetOrderHistory	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

GetOrderHistory: Get the history of an order and related entity changes

Get the changes that have happened to an order and related entities.

Exceptions

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

Parameters

scope	The scope of the order.
code	The code of the order.
asAt	The asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfChangeIntervalWithOrderManagementDetail

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ GetOrderHistoryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfChangeIntervalWithOrderManagementDetail> Lusid.Sdk.Api.IOrderManagementApiSync.GetOrderHistoryWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

GetOrderHistory: Get the history of an order and related entity changes

Get the changes that have happened to an order and related entities.

Exceptions

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

Parameters

scope	The scope of the order.
code	The code of the order.
asAt	The asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfChangeIntervalWithOrderManagementDetail

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ MoveOrders()

ResourceListOfMovedOrderToDifferentBlockResponse Lusid.Sdk.Api.IOrderManagementApiSync.MoveOrders	(	MoveOrdersToDifferentBlocksRequest	moveOrdersToDifferentBlocksRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] MoveOrders: Move orders to new or existing block

Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions

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

Parameters

moveOrdersToDifferentBlocksRequest	The collection of order and destination block ids.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfMovedOrderToDifferentBlockResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ MoveOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfMovedOrderToDifferentBlockResponse> Lusid.Sdk.Api.IOrderManagementApiSync.MoveOrdersWithHttpInfo	(	MoveOrdersToDifferentBlocksRequest	moveOrdersToDifferentBlocksRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] MoveOrders: Move orders to new or existing block

Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions

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

Parameters

moveOrdersToDifferentBlocksRequest	The collection of order and destination block ids.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfMovedOrderToDifferentBlockResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ PlaceBlocks()

ResourceListOfPlacement Lusid.Sdk.Api.IOrderManagementApiSync.PlaceBlocks	(	PlaceBlocksRequest?	placeBlocksRequest = `default(PlaceBlocksRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.

The referenced block's existence will be verified.

Exceptions

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

Parameters

placeBlocksRequest	The request containing the blocks to the placed. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfPlacement

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ PlaceBlocksWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPlacement> Lusid.Sdk.Api.IOrderManagementApiSync.PlaceBlocksWithHttpInfo	(	PlaceBlocksRequest?	placeBlocksRequest = `default(PlaceBlocksRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.

The referenced block's existence will be verified.

Exceptions

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

Parameters

placeBlocksRequest	The request containing the blocks to the placed. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfPlacement

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ RunAllocationService()

AllocationServiceRunResponse Lusid.Sdk.Api.IOrderManagementApiSync.RunAllocationService	(	List< ResourceId >	resourceId,
		string?	allocationAlgorithm = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

RunAllocationService: Runs the Allocation Service

Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results.

Exceptions

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

Parameters

resourceId	The List of Placement IDs for which you wish to allocate Executions.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-FIFO". This defaults to "PR-FIFO". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: AllocationServiceRunResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ RunAllocationServiceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AllocationServiceRunResponse> Lusid.Sdk.Api.IOrderManagementApiSync.RunAllocationServiceWithHttpInfo	(	List< ResourceId >	resourceId,
		string?	allocationAlgorithm = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

RunAllocationService: Runs the Allocation Service

Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results.

Exceptions

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

Parameters

resourceId	The List of Placement IDs for which you wish to allocate Executions.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-FIFO". This defaults to "PR-FIFO". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of AllocationServiceRunResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ RunAllocationServiceWithWeights()

AllocationServiceRunResponse Lusid.Sdk.Api.IOrderManagementApiSync.RunAllocationServiceWithWeights	(	WeightedAllocationServiceRunRequest	weightedAllocationServiceRunRequest,
		string?	allocationAlgorithm = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights

Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100.

Exceptions

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

Parameters

weightedAllocationServiceRunRequest	The placement IDs to allocate against, and the portfolio weights to use for the allocation split.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-LF". Allocating with weights means the base algorithm is always pro-rata, and the orphan allocation algorithm is either Largest First or Smallest First. This defaults to "PR-LF". Valid values are "PR-LF", "PR-SF", "LF", "SF". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: AllocationServiceRunResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ RunAllocationServiceWithWeightsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AllocationServiceRunResponse> Lusid.Sdk.Api.IOrderManagementApiSync.RunAllocationServiceWithWeightsWithHttpInfo	(	WeightedAllocationServiceRunRequest	weightedAllocationServiceRunRequest,
		string?	allocationAlgorithm = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights

Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100.

Exceptions

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

Parameters

weightedAllocationServiceRunRequest	The placement IDs to allocate against, and the portfolio weights to use for the allocation split.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-LF". Allocating with weights means the base algorithm is always pro-rata, and the orphan allocation algorithm is either Largest First or Smallest First. This defaults to "PR-LF". Valid values are "PR-LF", "PR-SF", "LF", "SF". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of AllocationServiceRunResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ SweepBlocks()

SweepBlocksResponse Lusid.Sdk.Api.IOrderManagementApiSync.SweepBlocks	(	SweepBlocksRequest	sweepBlocksRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful.

The requirements are: <list type="bullet"><term>The block exists.</term><term>All orders have state "Closed", "Cancelled", "Canceled" or "Booked".</term><term>All placements have state "Allocated" or "Over-allocated".</term><term>All allocations have state "Closed", "Cancelled", "Canceled" or "Booked".</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>

Exceptions

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

Parameters

sweepBlocksRequest
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: SweepBlocksResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ SweepBlocksWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<SweepBlocksResponse> Lusid.Sdk.Api.IOrderManagementApiSync.SweepBlocksWithHttpInfo	(	SweepBlocksRequest	sweepBlocksRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful.

The requirements are: <list type="bullet"><term>The block exists.</term><term>All orders have state "Closed", "Cancelled", "Canceled" or "Booked".</term><term>All placements have state "Allocated" or "Over-allocated".</term><term>All allocations have state "Closed", "Cancelled", "Canceled" or "Booked".</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>

Exceptions

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

Parameters

sweepBlocksRequest
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of SweepBlocksResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ UpdateOrders()

UpdateOrdersResponse Lusid.Sdk.Api.IOrderManagementApiSync.UpdateOrders	(	Dictionary< string, OrderUpdateRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpdateOrders: Update existing orders

The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the orders to be updated.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: UpdateOrdersResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ UpdateOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpdateOrdersResponse> Lusid.Sdk.Api.IOrderManagementApiSync.UpdateOrdersWithHttpInfo	(	Dictionary< string, OrderUpdateRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpdateOrders: Update existing orders

The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the orders to be updated.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of UpdateOrdersResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ UpdatePlacements()

UpdatePlacementsResponse Lusid.Sdk.Api.IOrderManagementApiSync.UpdatePlacements	(	Dictionary< string, PlacementUpdateRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpdatePlacements: Update existing placements

The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the placements to be updated.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: UpdatePlacementsResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ UpdatePlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpdatePlacementsResponse> Lusid.Sdk.Api.IOrderManagementApiSync.UpdatePlacementsWithHttpInfo	(	Dictionary< string, PlacementUpdateRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpdatePlacements: Update existing placements

The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions

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

Parameters

requestBody	The request containing the placements to be updated.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of UpdatePlacementsResponse

Implemented in Lusid.Sdk.Api.OrderManagementApi.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ BookTransactions()

◆ BookTransactionsWithHttpInfo()

◆ CancelOrders()

◆ CancelOrdersAndMoveRemaining()

◆ CancelOrdersAndMoveRemainingWithHttpInfo()

◆ CancelOrdersWithHttpInfo()

◆ CancelPlacements()

◆ CancelPlacementsWithHttpInfo()

◆ CreateOrders()

◆ CreateOrdersWithHttpInfo()

◆ GetOrderHistory()

◆ GetOrderHistoryWithHttpInfo()

◆ MoveOrders()

◆ MoveOrdersWithHttpInfo()

◆ PlaceBlocks()

◆ PlaceBlocksWithHttpInfo()

◆ RunAllocationService()

◆ RunAllocationServiceWithHttpInfo()

◆ RunAllocationServiceWithWeights()

◆ RunAllocationServiceWithWeightsWithHttpInfo()

◆ SweepBlocks()

◆ SweepBlocksWithHttpInfo()

◆ UpdateOrders()

◆ UpdateOrdersWithHttpInfo()

◆ UpdatePlacements()

◆ UpdatePlacementsWithHttpInfo()