Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a trade order. | ||
TradeOrderType | String | Filter trade orders by type. | ||
States | String[] | Filter trade orders by states. | ||
Instruments | Guid[] | Filter by array of InstrumentIds. | ||
Accounts | Guid[] | Filter by array of AccountIds. | ||
ExternalReference | String | Filter by ExternalReference | ||
OrderNos | String[] | Filter by order numbers | 2.02 | |
ExternalFundBatchOrders | Guid[] | Filter by array of External Fund Batch Orders | 2.02.20160422 | |
IsPrePayed | Bool | True if the orders should be filtered on the pre pay order process | 2.02.20160513 | |
AllocationInstance | Guid[] | The BrickIds of the associated allocation instance if any. An allocation instance is created when implementing a new allocation model in the user interface of BFS | 2.02.20160513 | |
AllocationOrder | Guid[] | The BrickIds of any associated Allocation Orders | 2.02.20160513 | |
ExecutionInterface | Guid[] | The BrickId of any associated Execution Interface | 2.02.20160513 | |
ExecutionInterfaceKey | String[] | The key name of any associated Execution Interface | 2.02.20160513 | |
CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | ||
CreatedDateTo | DateTime |
Response rows (Array)
Name | Type | Description | Available from version |
---|---|---|---|
BrickId | Guid | The BrickId of the trade order | |
TradeOrderType | String | The type of the order | |
Account | Guid | The trade order's associated account | |
CashAmount | Decimal | The amount in cash | |
InstrumentAmount | Decimal | The amount in units | |
TradeOrderDirectionKey | String | "Buy" or "Sell" | |
Instrument | Guid | The associated instrument | |
Cash | Guid | The associated Cash | |
Price | Double | The price of the trade order | |
State | String | The current state of the trade order | |
IsUnitOrder | Bool | True if the order is traded in units | |
OrderNo | String | The order number of the trade order | |
LimitPrice | Decimal | The limit price of the trade order | |
CashTradeDate | DateTime | The date when the trade was executed | 2.02.20160422 |
CashSettlementDate | DateTime | The date the trade order was settled | 2.02.20160422 |
InstrumentTradeDate | DateTime | The date when the trade was executed | 2.02.20160422 |
InstrumentSettlementDate | DateTime | The date the instrument units was settled | 2.02.20160422 |
ExternalReference | String | External reference on the order | |
OrderSettlementType | Enum | Order settlement type is only applicable for orders with the Internal execution interface. PAYMENT CONFIRMATION PRICE (Not supported) | 2.02 |
ExecutionInterfaceKey | String | The key name of the associated execution interface | 2.02 |
ExecutionInterface | Guid | The BrickId of the execution interface | 2.02 |
AllocationOrder | Guid | The BrickId of the associated Allocation Order if any | 2.02 |
AllocationInstance | Guid | The BrickId of the associated allocation instance if any. An allocation instance is created when implementing a new allocation model in the user interface of BFS | 2.02 |
CreatedDate | DateTime | The timestamp of when the order was created | 2.02 |
IsPrePayed | Bool | True if the order follows the pre pay order process | 2.02 |
ExternalFundBatchOrder | Guid | The BfsId of any associated ExternalFundBatchOrder | 2.02.20160422 |
DisplayPercentagePrice | Bool | If price is in persentage of MinimumLotSize | 2.02 |
CustomFields | Object[] | CustomFields is an array of CustomField objects. Each CustomField consists of two strings, FieldName and Value. There are no datatypes associated with these properties, they are just a way for api-users to add custimized data to the object. | 2.09 |
Code examples