GetSubscriptionOrders
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. | ||
| States | String[] | Filter by array of states. A subscription order has the following states:
| ||
| OrderNos | String[] | Filter by array of OrderNos | ||
| InstrumentIds | Guid[] | Filter by InstrumentIds. | 2.30 | |
| TradeOrderId | Guid[] | Filter by TradeOrderId | 2.30 | |
| Comments | String[] | Filter by array of Comments | ||
| CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | 2.20 | |
| CreatedDateTo | DateTime | 2.20 | ||
| Resellers | Guid[] | Filter by Resellers | 2.22 | |
| ExpectedTradeDateFrom | DateTime? | When used, both from date and to date should be provided in the request | 2.23 | |
| ExpectedTradeDateTo | ||||
| ExpectedSettlementDateFrom | DateTime? | When used, both from date and to date should be provided in the request | 2.23 | |
| ExpectedSettlementDateTo | ||||
| TradeOrderId | Guid[] | The BrickIds of TradeOrders that are resulting from the filtered SubscriptionOrders. | 2.30 |
Response rows (Array)
Name | Type | Description | Available from version |
|---|---|---|---|
| BrickId | Guid | The BrickId of the trade order | |
| CreatedDate | DateTime | The date when the subscription order was created | |
| LimitPrice | Decimal | The limit price of the subscription order | |
| OverrideCommissionAmount | Bool | True if the default commission amount should be overriden | |
| CommissionAmount | Decimal | If the OverrideCommissionAmount is true this value must be provided | |
| CashAmount | Decimal | The amount in cash | |
| InstrumentAmount | Decimal | The amount in units | |
| OrderNo | String | The order number of the trade order | |
| OrderTypeKey | String | The type of the order | |
| InstrumentId | Guid | The associated Instrument brickid | |
| CashId | Guid | The associated Cash brickid | |
| AccountId | Guid | The associated AccountID brickid | |
| IsUnitOrder | Bool | True if the order is traded in units | |
| ExecutionInterfaceId | Guid | The BrickId of the execution interface | |
| State | String | The current state of the subscription order. A subscription order has the following states:
| |
| LastPaymentDate | DateTime | The last payment date for the subscription | |
| LegalEntityId | Guid | The associated LegalEntity brickid | |
| IsDVP | Bool | If the settlement process is DVP or not | |
| TransferReceiverId | Guid | The associated TransferReceiver brickid | |
| DisplayPercentagePrice | Bool | If price is in persentage of MinimumLotSize | |
| Comment | String | Comment on order | |
| ExpectedTradeDate | DateTime | Expected Trade date for order | |
| ExpectedSettlementDate | DateTime | Expected Settlement date for order | |
| 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.14 |
| FeeAmount | Decimal | The total sum of fees on the order | 2.21.1 |
OrderFeeCategories | OrderFeeCategory[] | Array of OrderFeeCategories. Each OrderFeeCategroy consists of: decimal Amount double Percentage string Key string TypeKey decimal MinAmount bool ApplyDiscount Guid FeeAccount Guid ToCustodyAccount Guid FromCustodyAccount bool HasCreatedTransactions decimal CalculatedAmount Label[] Labels Label consists of: string LabelKey | 2.21.1 Labels from 2.22 |
| Reseller | Guid | Reseller id of the order | 2.22 |
| ReservationItems | ReservationItem[] | The ReservationItem of the subscription order. It contains the properties ReservedAsset (Guid) and ReservedAmount (decimal) | 2.23 |
| TradeOrderId | Guid | The Id of a resulting TradeOrder. | 2.30 |
Code examples