...
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of an order | ||
States | String[] | Filter orders by states. To find a list with states use the back office GUI and navigate to System Data→Workflows and find the Key with the name FundBatchOrder | ||
Instruments | Guid[] | Filter by array of InstrumentIds. | ||
ExternalReferences | String[] | Filter by ExternalReferences | ||
OrderNos | String[] | Filter by order numbers | ||
ExecutionInterface | Guid[] | Filter by the BfsId of Execution Interface | ||
ExecutionInterfaceKey | String | Filter by Execution Interface key | ||
CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | ||
CreatedDateTo | DateTime | |||
IsPrePayed | Bool | This value is true if the order is of the type called pre-payed, meaning that cash for settlement is transferred before execution is done | ||
IsUnitOrder | Bool | This value is true if the order was placed in number of fund units as opposed to a cash value | ||
PaymentConfirmationDateFrom | DateTime | Filters the orders based on which date the confirmation of payment was recorded. When used, both from date and to date should be provided in the request. | ||
PaymentConfirmationDateTo | DateTime |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version | |
---|---|---|---|---|
BrickId | Guid | The BrickId of the order | ||
CashAmount | Decimal | The amount in cash | ||
InstrumentAmount | Decimal | The amount in units | ||
TradeOrderDirectionKey | String | "Buy" or "Sell" | ||
Instrument | Guid | The associated instrument | ||
Cash | Guid | The associated Cash | ||
Price | Double | The price of the order | ||
State | String | The current state of the order | ||
IsUnitOrder | Bool | True if the order is traded in units | ||
OrderNo | String | The order number of the order | ||
CashTradeDate | DateTime | The date the cash leg of the order was executed | 2.02 | |
InstrumentTradeDate | DateTime | The date the instrument leg of the order was executed | 2.02 | |
CashSettlementDate | DateTime | The date the cash leg of the order was settled 2.02.20160422 | ||
InstrumentSettlementDate | DateTime | The date the instrument leg of the order was settled | 2.02.20160422 | |
SentDate | DateTime | The date the order was sent to an order route | ||
ExternalReference | String | External reference on the order | ||
ExecutionInterfaceKey | String | The key name of the associated execution interface | 2.02 | |
ExecutionInterface | Guid | The BrickId of the execution interface 2.02 | ||
CreatedDate | DateTime | The timestamp of when the order was created 2.02 | ||
IsPrePayed | Bool | True if the order follows the pre pay order process | ||
2.02 PaymentConfirmationDate | DateTime | If the order has received a payment confirmation this field will display the date for the confirmation |
Code examples
C# - GetExternalFundBatchOrders
Code Block | ||
---|---|---|
| ||
//Use the GetFundBatchOrders method 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.GetFundBatchOrders(new BFSServiceReference.GetFundBatchOrdersRequest() { Credentials = credentials, identify = bfsidentifier, //Identifier is a unique token for your instance of BFS Args = new GetFundBatchOrdersArgs() { BrickIds = new Guid[] { new Guid("928f5a5a-5abf-45e7-977c-b716f73b7618"), } }, Fields = new BFSServiceReference.GetFundBatchOrderFields() { BrickId = true, CashAmount = true, InstrumentAmount = true, TradeOrderDirectionKey = true, Instrument = true, Cash = true, Price = true, State = true, IsUnitOrder = true, OrderNo = true, CashTradeDate = true, InstrumentTradeDate = true, ExternalReference = true, CreatedDate = true, ExecutionInterfaceKey = true, ExecutionInterface = true, IsPrePayed = true, CashSettlementDate = true, InstrumentSettlementDate = true, SentDate = true, SettledAmount = true, PaymentConfirmationDate = true }, }); foreach (var c in accounttypes.Result) { Console.WriteLine(c.BrickId + "," + c.CashAmount + "," + c.InstrumentAmount + "," + c.TradeOrderDirectionKey + "," + c.Instrument + "," + c.Cash + "," + c.Price + "," + c.State + "," + c.IsUnitOrder + "," + c.OrderNo + "," + c.TradeDate + "," + c.ExternalReference + "," + c.CreatedDate + "," + c.ExecutionInterfaceKey + "," + c.ExecutionInterface + "," + c.IsPrePayed + "," + c.CashSettlementDate + "," + c.InstrumentSettlementDate + "," + c.SentDate + "," + c.SettledAmount + "," + c.PaymentConfirmationDate ); } |
Blog Posts | ||||||
---|---|---|---|---|---|---|
|