Filter inputs

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Available from version
BrickIds	Guid[]	Filter by array of BrickIds. BrickId is the internal id of a currency exchange order.	2.25
OrderDirectionKey	String	Filter based on if you want to show buy or sell orders. Enter "Buy" for buy orders and "Sell" for sell orders.	2.25
AccountOwners	Guid[]	Filter based on the BrickId of the account owner Legal Entities.	2.25
Accounts	Guid[]	Filter based on the Account where the order is associated.	2.25
BuyCashAssetBrickIds	Guid[]	Filter based on the Cash asset BrickIds of the currency that should be bought.	2.25
SellCashAssetBrickIds	Guid[]	Filter based on the Cash asset BrickIds of the currency that should be sold.	2.25
Comments	String[]	Filter based on the comments on the orders.	2.25
CreatedDateFrom	DateTime	Filter on the created date of the orders.	2.25
CreatedDateTo	DateTime	Filter on the created date of the orders.	2.25
FromBuyAmount	Decimal	In case of a buy order you can filter based on the amount that should be bought.	2.25
ToBuyAmount	Decimal		2.25
FromSellAmount	Decimal	In case of a sell order you can filter based on the amount that should be sold.	2.25
ToSellAmount	Decimal		2.25
OrderNos	String[]	Filter by order numbers.	2.25
States	String[]	Filter by order status, available statuses are: Placed - the initial state PrePlaced - if the order is placed but money is not available to reserve Processed - the order is ready to be sent for execution Sent - the order was sent for execution Executed - the order was executed Settled - the order was settled Cancelled - the order was cancelled Review - the order is currently in review	2.25

Response rows (Array) inherits from EntityBase

Name	Type	Description	Available from version

Name	Type	Description	Available from version
BrickId	Guid	The internal id of the order	2.25
OrderDirectionKey	String	"Buy" or "Sell" describes what type of order this is.	2.25
LegalEntityId	Guid	The BrickId of the Legal Entity who owns the account that the order relates to.	2.25
AccountId	Guid	The BrickId of the Account that the order relates to.	2.25
BuyCashAssetBrickId	Guid	The BrickId of the Cash asset that is being bought by the order.	2.25
SellCashAssetBrickId	Guid	The BrickId of the Cash asset that is being sold by the order.	2.25
Comment	String	A comment for the order if any.	2.25
BuyAmount	Decimal	In case of a buy order this property shows how much should be bought by the order.	2.25
SellAmount	Decimal	In case of a sell order this property shows how much should be sold by the order.	2.25
OrderNo	String	The order number for the order.	2.25
AllocationOrder	Guid	The BrickId of the Allocation Order that the order relates to if any.	2.25
CurrencyExchangeBatchOrder	Guid	The BrickId of the batch order if the order is related to such.	2.25
ExecutionInterfaceId	Guid	The execution interface that the order belongs to.	2.25
State	String	The order status that can be any of the following: Placed - the initial state PrePlaced - if the order is placed but money is not available to reserve Processed - the order is ready to be sent for execution Sent - the order was sent for execution Executed - the order was executed Settled - the order was settled Cancelled - the order was cancelled Review - the order is currently in review	2.25

Code examples

C# - Get Currency Exchange Orders from a BFS instance

 var request = new GetCurrencyExchangeOrderRequest();

            request.Credentials = CorrectCredentials();
            request.identify = CorrectIdentify();

            request.Args = new GetCurrencyExchangeOrderArgs
            {
                OrderDirectionKey = "Buy",
                AccountOwners = new []{Guid.Empty, },
                Accounts = new []{Guid.Empty, },
                BrickIds = new []{Guid.Empty, },
                BuyCashAssetBrickIds = new []{Guid.Empty, },
                SellCashAssetBrickIds = new []{Guid.Empty, },
                Comments = new []{"Test"},
                CreatedDateFrom = DateTime.MinValue,
                CreatedDateTo = DateTime.MaxValue,
                FromBuyAmount = 0M,
                ToBuyAmount = 1000000M,
                OrderNos = new []{"878889", "7786"},
                States = new []{"Placed", "Settled"}
            };

            request.Fields = new GetCurrencyExchangeOrderFields
            {
                BuyCashAssetBrickId = true,
                SellCashAssetBrickId = true,
                Comment = true,
                BuyAmount = true,
                AccountId = true,
                AllocationOrder = true,
                CurrencyExchangeBatchOrder = true,
                BrickId = true,
                CreatedDate = true,
                CustomFields = true,
                ExecutionInterfaceId = true,
                LegalEntityId = true,
                OrderDirectionKey = true,
                OrderNo = true,
                State = true,
                SellAmount = true
            };

            var response = client.GetCurrencyExchangeOrders(request);

Blog stream

Create a blog post to share news and announcements with your team and company.