GetAutoGiroOrders

This method retrieves autogiro orders which are a specific type of "TransferOrders". 

An autogiro deposit or withdrawal can be reattempted several times if a problem occurs (for example insufficient funds). The number of reattempts is specified by Bricknode and is 3 at the time of writing this article.

The property AutogiroOrderStatus can be "AutomaticOrder_Active" even if the property AutoGiroResponseCode is 1 (Insufficient funds) if the maximum number of reattempts has not been reached. Thus, if you want to find all AutogiroOrders that have been rejected because of insufficient funds and where no further reattempts will be made you should filter on AutogiroOrderStatus = "AutomaticOrder_Rejected" and AutoGiroResponseCode = 1.

If you want to find all AutogiroOrders where attempts were made to withdraw or deposit money where there were an insufficient funds error but where more attempts will be made, you should filter on AutogiroOrderStatus = "AutomaticOrder_Active" and AutoGiroResponseCode = 1.

Filter inputs

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


2.27.20201216
CreatedDateToDateTime?
2.27.20201216
CurrencyCodesstring[]The ISO-code of the currency in the order, for example "EUR"
2.27.20201216
ExternalReferencestring[]The external reference that was set at the creation of the order
2.27.20201216
BatchOrderIdsGuid[]The BrickIds of the batch orders that the autogiro orders should be included within
2.27.20201216
AccountIdsGuid[]The BrickIds of accounts that the autogiro orders should be associated with
2.27.20201216
AutogiroOrderStatusesstring[]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.27.20201216
TransferReceiverIdsGuid[]The BrickIds of the TransferReceiver that the order was associated with
2.27.20201216
SettlementDateFromDateTime?When used, both from date and to date should be provided in the request
2.27.20201216
SettlementDateToDateTime?
2.27.20201216
TransferOrderTypeKeysstring[]The type of autogiro order. Can be "AutoGiroTransferInOrder" or "AutoGiroTransferOutOrder"
2.27.20201216
AutogiroOrderNumbersstring[]The order numbers of the autogiro orders
2.27.20201216
AutoGiroResponseCodesstring[]

The autogiro response codes (payment codes). A null value means that the order has no response and has not been processed by the bank.

The code "0" means "payment processed". Insufficient funds are returned as "1", and code "2" is a lack of Autogiro connection (cancelled bank account). 


2.28

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId of the order2.27.20201216
CreatedDateDateTimeThe timestamp of when the order was created2.27.20201216
SettlementDateDateTimeThe date of when the order was settled2.27.20201216
CashAmountdecimalThe amount of the order2.27.20201216
AutogiroOrderStatusstringThe current state of the order as described by the workflow2.27.20201216
CurrencyCodestringThe ISO-code of the currency in the order, for example "EUR"2.27.20201216
AutogiroOrderNumberstringThe order number of the autogiro order2.27.20201216
ExternalReferencestringThe external reference that was set at the creation of the order2.27.20201216
AccountIdGuidThe BrickId of the associated accout for the order2.27.20201216
BatchOrderNumberstringThe order number of the associated batch order if the autogiro order is associated to one2.27.20201216
TransferOrderTypeKeystringWhether the autogiro order is incoming or outgoing2.27.20201216
TransferReceiverIdGuidThe BrickId of the associated TransferReceiver.2.28
AutoGiroResponseCodestringThe autogiro response code of the AutoGiro order. 2.28