GetDepositBatchTransferOrders

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]Filter by array of BrickIds. BrickId is the internal id of a deposit batch 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
CurrencyCodestring[]The ISO-code of the currency in the batch order, for example "EUR" 2.02.20160422
OrderNosstring[]The order number of the deposit batch order 2.02.20160422
BatchOrderTypestring[]The order type of the deposit batch order 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
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 batch order, for example "EUR"2.02.20160422
OrderNostringThe order number of the deposit batch order2.02.20160422
BatchOrderTypestringThe type of the deposit batch order2.02.20160422

Code examples

C# - GetDepositBatchTransferOrders
 //Use the GetDepositBatchTransferOrders 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.GetDepositBatchTransferOrders(new BFSServiceReference.GetDepositBatchTransferOrdersRequest()
{
    Credentials = credentials,

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

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

    Fields = new BFSServiceReference.GetDepositBatchTransferOrdersFields()
    {
        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.