Filter inputs
| Name | Type | Description | Mandatory | 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 | 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 | 2.25 |
Response rows (Array) inherits from EntityBase
| Name | Type | Description | Available from version |
|---|---|---|---|
| BrickId | Guid | ||
| OrderDirectionKey | |||
| AccountOwner | |||
| Account | |||
| BuyCashAssetBrickId | |||
| SellCashAssetBrickId | |||
| Comment | |||
| BuyAmount | |||
| SellAmount | |||
| OrderNo |
Code examples