Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Filter inputs

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

  
CreatedDateToDateTime?  
CashKeyGuid[]The BrickId of the cash asset (GetCash)  
KeysOrderNosstring[]The order number of the deposit batch order  AccountNoSeriesKey
stringStatesstring[]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  int
SettlementDateFromDateTime?When used, both from date and to date should be provided in the request  
boolSettlementDateToDateTime?  

Response rows (Array) inherits from EntityBase

Key account key account type
NameTypeDescription
BrickIdGuidThe BrickId (unique id) of the account typeof the order
CreatedDateDateTimeThe timestamp of when the order was created
SettlementDateDateTimeThe date of when the order was settled
CashAmountdecimalThe amount of the order
StatestringThe current state of the order as described by the workflow
CashGuidThe BrickId of the cash asset (GetCash)
OrderNostringThe order number of the deposit batch order
BatchOrderTypestringThe type of the deposit batch order

Code examples

Code Block
languagec#
themeRDark
titleC# - GetDepositBatchTransferOrders
linenumberstrue
collapsetrue
 //Use the GetDepositTransferOrders 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,
        Cash = true,
        OrderNo = true,
        BatchOrderType = true
    },

});

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

 

Blog Posts
sortcreation
contenttitles
labelsGetDepositBatchTransferOrders