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

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Mandatory	Available from version
BrickIds	Guid[]	Filter by array of BrickIds. BrickId is the internal id of an autogiro order		2.27.20201216
CreatedDateFrom	DateTime?	When used, both from date and to date should be provided in the request		2.27.20201216
CreatedDateTo	DateTime?			2.27.20201216
CurrencyCodes	string[]	The ISO-code of the currency in the order, for example "EUR"		2.27.20201216
ExternalReference	string[]	The external reference that was set at the creation of the order		2.27.20201216
BatchOrderIds	Guid[]	The BrickIds of the batch orders that the autogiro orders should be included within		2.27.20201216
AccountIds	Guid[]	The BrickIds of accounts that the autogiro orders should be associated with		2.27.20201216
AutogiroOrderStatuses	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.27.20201216
TransferReceiverIds	Guid[]	The BrickIds of the TransferReceiver that the order was associated with		2.27.20201216
SettlementDateFrom	DateTime?	When used, both from date and to date should be provided in the request		2.27.20201216
SettlementDateTo	DateTime?			2.27.20201216
TransferOrderTypeKeys	string[]	The type of autogiro order. Can be "AutoGiroTransferInOrder" or "AutoGiroTransferOutOrder". At least one is required for results.	true	2.27.20201216
AutogiroOrderNumbers	string[]	The order numbers of the autogiro orders		2.27.20201216
AutoGiroResponseCodes	string[]	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

Name	Type	Description	Available from version

Name	Type	Description	Available from version
BrickId	Guid	The BrickId of the order	2.27.20201216
CreatedDate	DateTime	The timestamp of when the order was created	2.27.20201216
SettlementDate	DateTime	The date of when the order was settled	2.27.20201216
CashAmount	decimal	The amount of the order	2.27.20201216
AutogiroOrderStatus	string	The current state of the order as described by the workflow	2.27.20201216
CurrencyCode	string	The ISO-code of the currency in the order, for example "EUR"	2.27.20201216
AutogiroOrderNumber	string	The order number of the autogiro order	2.27.20201216
ExternalReference	string	The external reference that was set at the creation of the order	2.27.20201216
AccountId	Guid	The BrickId of the associated accout for the order	2.27.20201216
BatchOrderNumber	string	The order number of the associated batch order if the autogiro order is associated to one	2.27.20201216
TransferOrderTypeKey	string	Whether the autogiro order is incoming or outgoing	2.27.20201216
TransferReceiverId	Guid	The BrickId of the associated TransferReceiver.	2.28
AutoGiroResponseCode	string	The autogiro response code of the AutoGiro order.	2.28
RecurringOrderTemplateIds	Guid[]	RecurringOrderTemplateIds for RecurringOrderTemplate related to TransferOrder	2.33