GetWithdrawalTransferOrders

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]Filter by array of BrickIds. BrickId is the internal id of a deposit order
2.02.20160422
CreatedDateFromDateTime?When used, both from date and to date should be provided in the request


2.02.20160422
CreatedDateToDateTime?
2.02.20160422
CurrencyCodesstring[]The ISO-code of the currency in the order, for example "EUR"
2.02.20160422
ExternalReferencestring[]The external reference that was set at the creation of the order
2.02.20160422
BatchOrdersGuid[]The BrickIds of the DepositBatchTransferOrders that the DepositTransferOrders should be included within
2.02.20160422
AccountsGuid[]The BrickIds of accounts where the DepositTransferOrders should be associated with
2.02.20160422
Statesstring[]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
TransferReceiverGuid[]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
SettlementDateFromDateTime?When used, both from date and to date should be provided in the request
2.02.20160422
SettlementDateToDateTime?
2.02.20160422

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId of the order2.02.20160422
CreatedDateDateTimeThe timestamp of when the order was created2.02.20160422
SettlementDateDateTimeThe date of when the order was settled2.02.20160422
CashAmountdecimalThe amount of the order2.02.20160422
StatestringThe current state of the order as described by the workflow2.02.20160422
CurrencyCodestringThe ISO-code of the currency in the order, for example "EUR"2.02.20160422
OrderNostringThe order number of the deposit order2.02.20160422
ExternalReferencestringThe external reference that was set at the creation of the order2.02.20160422
AccountGuidThe BrickId of the associated accout for the order2.02.20160422
TransferOrderTypestringThe name of the order type2.02.20160422
BatchOrderNostringThe order number of the associated batch order if the withdrawal transfer order is associated to one2.02.20160429
TransferReceiverGuidThe BrickId of the TransferReceiver2.38

Code examples

C# - GetWithdrawalTransferOrders
 //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 stream

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