Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a deposit order |
2.02.20160422 | ||
CreatedDateFrom | DateTime? | When used, both from date and to date should be provided in the request |
2.02.20160422 | ||
CreatedDateTo | DateTime? |
2.02.20160422 | ||
CurrencyCodes | string[] | The ISO-code of the currency in the order, for example "EUR" |
2.02.20160422 | ||
ExternalReference | string[] | The external reference that was set at the creation of the order |
2.02.20160422 | ||
BatchOrders | Guid[] | The BrickIds of the DepositBatchTransferOrders that the DepositTransferOrders should be included within |
2.02.20160422 | ||
Accounts | Guid[] | The BrickIds of accounts where the DepositTransferOrders should be associated with |
2.02.20160422 | ||
States | string[] | The current state of the order. The states can be found in the back office GUI of BFS by navigating to SystemData→Workflows and then look at the workflow for this order type |
2.02.20160422 | ||
TransferReceiver | Guid[] | The BrickIds of the TransferReceiver that the order was associated with. This connection is more common when it comes to withdrawals but could be used for deposits as well |
2.02.20160422 | ||
SettlementDateFrom | DateTime? | When used, both from date and to date should be provided in the request |
2.02.20160422 | ||
SettlementDateTo | DateTime? |
2.02.20160422 |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
---|---|---|---|
BrickId | Guid | The BrickId of the order | 2.02.20160422 |
CreatedDate | DateTime | The timestamp of when the order was created | 2.02.20160422 |
SettlementDate | DateTime | The date of when the order was settled | 2.02.20160422 |
CashAmount | decimal | The amount of the order | 2.02.20160422 |
State | string | The current state of the order as described by the workflow | 2.02.20160422 |
CurrencyCode | string | The ISO-code of the currency in the order, for example "EUR" | 2.02.20160422 |
OrderNo | string | The order number of the deposit order | 2.02.20160422 |
ExternalReference | string | The external reference that was set at the creation of the order | 2.02.20160422 |
Account | Guid | The BrickId of the associated accout for the order | 2.02.20160422 |
TransferOrderType | string | The name of the order type | 2.02.20160422 |
BatchOrderNo | string | The order number of the associated batch order if the withdrawal transfer order is associated to one | 2.02.20160429 |
TransferReceiver | Guid | The BrickId of the TransferReceiver | 2.38 |
Code examples
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
//Use the GetWithdrawalTransferOrders 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 orders = client.GetWithdrawalTransferOrders(new BFSServiceReference.GetWithdrawalTransferOrdersRequest() { Credentials = credentials, identify = bfsidentifier, //Identifier is a unique token for your instance of BFS Args = new GetWithdrawalTransferOrdersArgs() { CreatedDateFrom = DateTime.Parse("2016-04-20"), CreatedDateTo = DateTime.Parse("2016-04-23"), }, Fields = new BFSServiceReference.GetWithdrawalTransferOrdersFields() { BrickId = true, CreatedDate = true, SettlementDate = true, CashAmount = true, State = true, CurrencyCode = true, OrderNo = true, ExternalReference = true, Account = true, TransferOrderType = true, BatchOrderNo = true, }, }); foreach (var c in orders.Result) { Console.WriteLine(c.BrickId + ";" + c.CreatedDate + ";" + c.SettlementDate + ";" + c.CashAmount + ";" + c.State + ";" + c.CurrencyCode + ";" + c.OrderNo + ";" + c.ExternalReference + ";" + c.Account + ";" + c.TransferOrderType + ";" + c.BatchOrderNo); } |
...
Blog Posts | ||||||
---|---|---|---|---|---|---|
|