GetWithdrawalBatchTransferOrders

Filter inputs

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Available from version
BrickIds	Guid[]	Filter by array of BrickIds. BrickId is the internal id of a withdrawal batch 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
CurrencyCode	string[]	The ISO-code of the currency in the batch order, for example "EUR"	2.02.20160422
OrderNos	string[]	The order number of the withdrawal batch order	2.02.20160422
BatchOrderType	string[]	The order type of the withdrawal batch order	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
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

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 batch order, for example "EUR"	2.02.20160422
OrderNo	string	The order number of the withdrawal batch order	2.02.20160422
BatchOrderType	string	The type of the deposit batch order	2.02.20160422

Code examples

C# - GetWithdrawalBatchTransferOrders

 //Use the GetWithdrawalBatchTransferOrders 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.GetWithdrawalBatchTransferOrders(new BFSServiceReference.GetWithdrawalBatchTransferOrdersRequest()
{
    Credentials = credentials,

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

    Args = new GetWithdrawalBatchTransferOrdersArgs()
    {
        CreatedDateFrom = DateTime.Parse("2016-04-01"),
        CreatedDateTo = DateTime.Parse("2016-04-21")
    },

    Fields = new BFSServiceReference.GetWithdrawalBatchTransferOrdersFields()
    {
        BrickId = true,
        CreatedDate = true,
        SettlementDate = true,
        CashAmount = true,
        State = true,
        CurrencyCode = true,
        OrderNo = true,
        BatchOrderType = true
    },

});

foreach (var c in orders.Result)
{
    Console.WriteLine(c.BrickId + ";" + c.CreatedDate + ";" + c.SettlementDate + ";" + c.CashAmount + ";" + c.State + ";" + c.CurrencyCode + ";" + c.OrderNo + ";" + c.BatchOrderType);
}

Blog stream

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