Versions Compared

Key

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

...

Name
Type
Description
MandatoryAvailable from version
BrickIdGuidNot used.  
TradeOrderDirectionKeystring

Should be "Buy" or "Sell"

True 
AccountGuidThe account to be associated with the orderTrue 
InstrumentGuidThe instrument to be associated with the orderTrue 
CashGuid?The Cash to be associated with the order. If this Id is not known, CashCurrencyCode can be used instead.True 
CashCurrencyCodestringThe currency code, for example SEK, USD, EUR  
InstrumentAmountDecimal?The Amount in units. Negative amount is not allowed.True 
CashAmountDecimal?The Amount in units Cash. Negative amount is not allowed.True 
CommissionAmountDecimalThe commission amount. Negative amount is not allowed.True 
OverrideCommissionAmountboolTrue if commission should override the existing fee configuration  
IsUnitOrderboolTrue if order is in units  
ReserveAssetsboolTrue if asset (cash or instrument) should be reserved  
LimitPricedecimalLimit price. Negative amount is not allowed.  
OrderNostringNot used as an input. The created order will receive an order number that is returned in the output.  
ExternalReferencestringAn external reference that will be stored 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 of the Execution Interface that should be used for the order. The key can be found in the GUI depending on which interfaces are created for the BFS instance. This information can be found by navigating to SystemData->ExecutionInterfacesTrue2.02
OrderDateAndTimeDateTimeThe date representing when the order was placed. This is not the system CreationDate which is set by BFS when the order is inputted via this method. Saved as OrderDate in BFS 2.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

 

Outputs

Name
Type
Description
EntitiesArray

All trade orders is returned along with each trade order's BrickId, OrderNo and array of Errors per trade order

...