Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name
Type
Description
MandatoryAvailable from version
BrickIdsGuid[]

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



TradeOrderTypeStringFilter trade orders by type.

StatesString[]Filter trade orders by states.

InstrumentsGuid[]Filter by array of InstrumentIds.

AccountsGuid[]Filter by array of AccountIds.

ExternalReferenceStringFilter by ExternalReference

OrderNosString[]Filter by order numbers
2.02
ExternalFundBatchOrdersGuid[]Filter by array of External Fund Batch Orders
2.02.20160422
IsPrePayedBoolTrue if the orders should be filtered on the pre pay order process
2.02.20160513
AllocationInstanceGuid[]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
AllocationOrderGuid[]The BrickIds of any associated Allocation Orders
2.02.20160513
ExecutionInterfaceGuid[]The BrickId of any associated Execution Interface
2.02.20160513
ExecutionInterfaceKeyString[]The key name of any associated Execution Interface
2.02.20160513
CreatedDateFromDateTimeWhen used, both from date and to date should be provided in the request

CreatedDateToDateTime

SellTypestringFilter by the value that indicates whether the sell is a short sell or not. Can be on of the following values: "UNDI", "SELL", "SSEX", "SESH"false

This property will be deprecated as of verson 2.29 and ShortSellingIndicator should be used instead.

2.12

DecisionMakerWithinFirmGuidFilter by the BrickId of the person that decided to place the order that led to the deal.false2.12
OrderTypeKeysstring[]Filter on OrderTypeKeys (for Internal and manual orders)
2.22
ResellersGuid[]Filter by reseller idsfalse2.23
ShortSellingIndicatorEnum

TRS property. The short selling indicator is used in TRS reporting to define if a trade of the type Sell was a short sale or not. The allowed values are:

SESH = Short sale with no exemption
SELL = No short sale, selling a current position
SSEX = Short sale with exemption
UNDI = Information not available
NotApplicable = This can be used if the order was a buy order and the short sale indicator is not applicable. This will be set by default by BFS for any Buy orders.


2.27
FourEyesStatusEnum

The allowed values are:

UnApproved = Waiting for approvals
Approved = The order has been approved
InProgress = Approval process is in progress and waiting for all approvals to be finished


2.27

Response rows (Array)

Name
Type
Description
Available from version
BrickIdGuid

The BrickId of the trade order


TradeOrderTypeStringThe type of the order
AccountGuidThe trade order's associated account
CashAmountDecimalThe amount in cash
InstrumentAmountDecimalThe amount in units
TradeOrderDirectionKeyString"Buy" or "Sell"
InstrumentGuidThe associated instrument
CashGuidThe associated Cash
PriceDoubleThe price of the trade order
StateStringThe current state of the trade order
IsUnitOrderBoolTrue if the order is traded in units
OrderNoStringThe order number of the trade order
LimitPriceDecimalThe limit price of the trade order
CashTradeDateDateTimeThe date when the trade was executed2.02.20160422
CashSettlementDateDateTimeThe date the trade order was settled2.02.20160422
InstrumentTradeDateDateTimeThe date when the trade was executed2.02.20160422
InstrumentSettlementDateDateTimeThe date the instrument units was settled2.02.20160422
ExternalReferenceStringExternal reference on the order
OrderSettlementTypeEnum

Order settlement type is only applicable for orders with the Internal execution interface.

PAYMENT

CONFIRMATION

PRICE (Not supported)

2.02
ExecutionInterfaceKeyStringThe key name of the associated execution interface2.02
ExecutionInterfaceGuidThe BrickId of the execution interface2.02
AllocationOrderGuidThe BrickId of the associated Allocation Order if any2.02
AllocationInstanceGuidThe BrickId of the associated allocation instance if any. An allocation instance is created when implementing a new allocation model in the user interface of BFS2.02
CreatedDateDateTimeThe timestamp of when the order was created2.02
IsPrePayedBoolTrue if the order follows the pre pay order process2.02
ExternalFundBatchOrderGuidThe BfsId of any associated ExternalFundBatchOrder2.02.20160422
DisplayPercentagePriceBoolIf price is in persentage of MinimumLotSize2.02
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.09
IsNominalValueOrderEntryBoolIndicates whether the order is a nominal value order or not.2.12
SellTypestringThe value that indicates whether the sell is a short sell or not. Can be on of the following values: "UNDI", "SELL", "SSEX", "SESH"2.12
DecisionMakerWithinFirmGuidThe BrickId of the person that decided to place the order that led to the deal.2.12
FeeAmountDecimalThe total sum of fees on the order2.21.1
OrderFeeCategoriesOrderFeeCategory[]

Array of OrderFeeCategories. Each OrderFeeCategory 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

OrderTypeKeystringOrderTypeKey for Internal and Manual orders
ResellerGuidThe reseller of the order2.23
FilledCashAmountdecimalIf the orders is filled, this is the amount of cash that is filled.2.26
FilledInstrumentAmountdecimalIf the orders is filled, this is the amount of instrument units that is filled.2.26
FourEyesStatusEnum

The allowed values are:

UnApproved = Waiting for approvals
Approved = The order has been approved
InProgress = Approval process is in progress and waiting for all approvals to be finished

2.27

Code examples

Code Block
languagec#
themeRDark
titleC# - GetTradeOrders
linenumberstrue
collapsetrue
//Use the GetTradeOrders method to get all trading related orders with a certain reference in the BFS instance and write
//the information in the console
var client = new BFSServiceReference.bfsapiSoapClient();

var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};

var accounttypes = client.GetTradeOrders(new BFSServiceReference.GetTradeOrdersRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS  

    Args = new GetTradeOrdersArgs()
    {
        ExternalReference = "MyTestOrder"

    },

    Fields = new BFSServiceReference.GetTradeOrderFields()
    {
        BrickId = true,
        TradeOrderType = true,
        Account = true,
        CashAmount = true,
        InstrumentAmount = true,
        TradeOrderDirectionKey = true,
        Instrument = true,
        Cash = true,
        Price = true,
        State = true,
        IsUnitOrder = true,
        OrderNo = true,
        LimitPrice = true,
        CashTradeDate = true,
        CashSettlementDate = true,
        InstrumentTradeDate = true,
        InstrumentSettlementDate = true,
        ExternalReference = true,
        OrderSettlementType = true,
        ExecutionInterfaceKey = true,
        AllocationOrder = true,
        AllocationInstance = true,
        CreatedDate = true,
        ExecutionInterface = true,
        IsPrePayed = true,
		ExternalFundBatchOrder = true,
    },
});

foreach (var c in accounttypes.Result)
{
    Console.WriteLine(c.BrickId + ","
        + c.TradeOrderType
        + ","
        + c.Account
        + ","
        + c.CashAmount
        + ","
        + c.InstrumentAmount
        + ","
        + c.TradeOrderDirectionKey
        + ","
        + c.Instrument
        + ","
        + c.Cash
        + ","
        + c.Price
        + ","
        + c.State
        + ","
        + c.IsUnitOrder
        + ","
        + c.OrderNo
        + ","
        + c.LimitPrice
        + ","
        + c.CashTradeDate
        + ","
        + c.CashSettlementDate
        + ","
        + c.InstrumentTradeDate
        + ","
        + c.InstrumentSettlementDate
        + ","
        + c.ExternalReference
        + ","
        + c.OrderSettlementType
        + ","
        + c.ExecutionInterfaceKey
        + ","
        + c.ExecutionInterface
        + ","
        + c.AllocationOrder
        + ","
        + c.AllocationInstance
        + ","
        + c.CreatedDate
        + ","
        + c.IsPrePayed
		+ ","
		+ c.ExternalFundBatchOrder

        );
}

...