Filter inputs
Name | Type | Description | Mandatory | Available from version | |
---|---|---|---|---|---|
BrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a deposit batch order | |||
CreatedDateFrom | DateTime? | When used, both from date and to date should be provided in the request | |||
CreatedDateTo | DateTime? | ||||
CashKey | Guid[] | The BrickId of the cash asset (GetCash) | |||
KeysOrderNos | string[] | The order number of the deposit batch order | AccountNoSeriesKey | ||
stringStates | 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 | int | ||
SettlementDateFrom | DateTime? | When used, both from date and to date should be provided in the request | |||
boolSettlementDateTo | DateTime? |
Response rows (Array) inherits from EntityBase
Name | Type | Description | |||
---|---|---|---|---|---|
BrickId | Guid | The BrickId (unique id) of the account type | Keyof the order | ||
CreatedDate | DateTime | The timestamp of when the order was created | |||
SettlementDate | DateTime | The date of when the order was settled | |||
CashAmount | decimal | The amount of the order | |||
State | string | The current state of the order as described by the workflow | |||
Cash | Guid | The BrickId of the cash asset (GetCash) | |||
OrderNo | string | The order number of the deposit batch order | |||
BatchOrderType | string | The | accounttype | keyof the | account typedeposit batch order |
Code examples
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
//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 | ||||||
---|---|---|---|---|---|---|
|