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 trade order.
States	String[]	Filter by array of states. A subscription order has the following states: Created Done Cancelled
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	DateTime?		2.23
ExpectedSettlementDateFrom	DateTime?	When used, both from date and to date should be provided in the request	2.23
ExpectedSettlementDateTo	DateTime?		2.23
TradeOrderId	Guid[]	The BrickIds of TradeOrders that are resulting from the filtered SubscriptionOrders.	2.30
TransferReceiverId	Guid	TransferReceiver of order (External Account)
TransferReceiverIdForCollectingFinancing	Guid	TransferReceiver from which to collect cash (Autogiro)	2.34

Response rows (Array)

Name	Type	Description	Available from version

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: Created Done Cancelled
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 string LabelValue	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
TransferReceiverIdForCollectingFinancing	Guid	TransferReceiver from which to collect cash (Autogiro)	2.34

XML request example

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetSubscriptionOrders xmlns="http://tempuri.org/">
      <req>
        <Credentials>
          <UserName>yourusername</UserName>
          <Password>yourpassword</Password>
        </Credentials>
        <identify>youridentifier</identify>
        <Args>
          <OrderNos>
            <string>2508</string>
          </OrderNos>
        </Args>
        <Fields>
          <BrickId>true</BrickId>
          <CreatedDate>true</CreatedDate>
          <LimitPrice>true</LimitPrice>
          <OverrideCommissionAmount>true</OverrideCommissionAmount>
          <CommissionAmount>true</CommissionAmount>
          <CashAmount>true</CashAmount>
          <InstrumentAmount>true</InstrumentAmount>
          <OrderNo>true</OrderNo>
          <OrderTypeKey>true</OrderTypeKey>
          <InstrumentId>true</InstrumentId>
          <CashId>true</CashId>
          <AccountId>true</AccountId>
          <IsUnitOrder>true</IsUnitOrder>
          <ExecutionInterfaceId>true</ExecutionInterfaceId>
          <State>true</State>
          <LastPaymentDate>true</LastPaymentDate>
          <LegalEntityId>true</LegalEntityId>
          <IsDVP>true</IsDVP>
          <TransferReceiverId>true</TransferReceiverId>
        </Fields>
      </req>
    </GetSubscriptionOrders>
  </s:Body>
</s:Envelope>

Code examples

Get subscription order by order no

 var client = new bfsapiSoapClient();

var request = new GetSubscriptionOrderRequest
{
	identify = bfsidentifier,
	Credentials = new Credentials
	{
		UserName = bfsudername,
		Password = bfspassword,
	},
	Args = new GetSubscriptionOrderArgs
	{
		OrderNos = new[] {"1234"}
	},
	Fields = new GetSubscriptionOrderFields
	{
		AccountId = true,
		ExecutionInterfaceId = true,
		BrickId = true,
		CashAmount = true,
		CashId = true,
		CommissionAmount = true,
		InstrumentAmount = true,
		InstrumentId = true,
		IsUnitOrder = true,
		LastPaymentDate = true,
		LimitPrice = true,
		OrderNo = true,
		OrderTypeKey = true,
		OverrideCommissionAmount = true,
		State = true,
		CreatedDate = true,
		LegalEntityId = true,
		IsDVP = true,
		TransferReceiverId = true
	}
};

var response = client.GetSubscriptionOrders(request);

Blog stream

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