GetSubscriptionOrders

Filter inputs

Name
Type
Description
MandatoryAvailable from version
BrickIdsGuid[]

Filter by array of BrickIds. BrickId is the internal id of a trade order.



StatesString[]Filter by array of states. A subscription order has the following states:
  • Created
  • Done
  • Cancelled


OrderNosString[]Filter by array of OrderNos

InstrumentIdsGuid[]Filter by InstrumentIds.
2.30
TradeOrderIdGuid[]Filter by TradeOrderId
2.30
CommentsString[]Filter by array of Comments

CreatedDateFromDateTimeWhen used, both from date and to date should be provided in the request
2.20
CreatedDateToDateTime
2.20
ResellersGuid[]Filter by Resellers
2.22
ExpectedTradeDateFromDateTime?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
TradeOrderIdGuid[]The BrickIds of TradeOrders that are resulting from the filtered SubscriptionOrders.
2.30

Response rows (Array)

Name
Type
Description
Available from version
BrickIdGuid

The BrickId of the trade order


CreatedDateDateTimeThe date when the subscription order was created
LimitPriceDecimalThe limit price of the subscription order
OverrideCommissionAmountBoolTrue if the default commission amount should be overriden
CommissionAmountDecimalIf the OverrideCommissionAmount is true this value must be provided
CashAmountDecimalThe amount in cash
InstrumentAmountDecimalThe amount in units
OrderNoStringThe order number of the trade order
OrderTypeKeyStringThe type of the order
InstrumentIdGuidThe associated Instrument brickid
CashIdGuidThe associated Cash brickid
AccountIdGuidThe associated AccountID brickid
IsUnitOrderBoolTrue if the order is traded in units
ExecutionInterfaceIdGuidThe BrickId of the execution interface
StateString

The current state of the subscription order. A subscription order has the following states:

  • Created
  • Done
  • Cancelled

LastPaymentDateDateTimeThe last payment date for the subscription
LegalEntityIdGuidThe associated LegalEntity brickid
IsDVPBoolIf the settlement process is DVP or not
TransferReceiverIdGuidThe associated TransferReceiver brickid
DisplayPercentagePriceBool

If price is in persentage of MinimumLotSize


CommentStringComment on order
ExpectedTradeDateDateTimeExpected Trade date for order
ExpectedSettlementDateDateTimeExpected Settlement date for order
CustomFieldsObject[]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 order2.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
string LabelValue

2.21.1


Labels from 2.22

ResellerGuidReseller id of the order2.22
ReservationItemsReservationItem[]The ReservationItem of the subscription order. It contains the properties ReservedAsset (Guid) and ReservedAmount (decimal)2.23
TradeOrderIdGuidThe Id of a resulting TradeOrder.2.30



Code examples