Filter inputs

Name	Type	Description	Mandatory	Available from version
BrickIds	Guid[]
OrderNo	String[]
Accounts	Guid[]
Comments	String[]

Response rows (Array) inherits from EntityBase

Name	Type	Description	Available from version
BrickId	Guid	The BrickId (unique id) of the account type	2.14
CreatedDate	DateTime	Date the order template was created
PeriodicityCode	String	One of: "O" - One time "M" - Monthly "Q" - Quaterly "H" - Half yearly "Y" - Yearly
OrderNo	String	Order number
AccountId	Guid	Reference to the Account
Day	int	Day of month when payment will be executed
TransferReceiver	Guid	Reference to the transfer reciever
StatusKey	String	Active or InActive
Amount	decimal	Amount that will be transfered
BusinessDate	DateTime	The date of the next payment
IsRecurringOrder	bool	true if this is an recurring order
CurrencyCode	String	Currency code of amount (ex "SEK")
Comment	String	Comment for order	2.24

Code examples

XML - Example request GetRecurringOrderTemplates

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:tns="http://tempuri.org/" xmlns:s1="http://microsoft.com/wsdl/types/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/">
    <soap:Body>
        <GetRecurringOrderTemplates xmlns="http://tempuri.org/">
            <req>
                <Credentials>
                    <UserName>[Username]</UserName>
                    <Password>[Password]</Password>
                </Credentials>
                <identify>[Identifier]</identify>
                <Args>
                    <BrickIds>
                        <guid>[Insert guid of the Recurring Order]</guid>
                    </BrickIds>
                </Args>
                <Fields>
                    <BrickId>true</BrickId>
                    <CreatedDate>true</CreatedDate>
                    <SettlementDate>true</SettlementDate>
                    <CashAmount>true</CashAmount>
                    <AutogiroOrderStatus>true</AutogiroOrderStatus>
                    <CurrencyCode>true</CurrencyCode>
                    <AutogiroOrderNumber>true</AutogiroOrderNumber>
                    <ExternalReference>true</ExternalReference>
                    <AccountId>true</AccountId>
                    <TransferOrderTypeKey>true</TransferOrderTypeKey>
                    <BatchOrderNumber>false</BatchOrderNumber>
                    <TransferReceiverId>true</TransferReceiverId>
                    <AutoGiroResponseCode>true</AutoGiroResponseCode>
                    <RecurringOrderTemplateIds>false</RecurringOrderTemplateIds>
                </Fields>
            </req>
        </GetRecurringOrderTemplates>
    </soap:Body>
</soap:Envelope>

C# - GetRecurringOrderTemplates

            var req = new bfsapi.GetRecurringOrderTemplatesRequest()
            {
                Credentials = new bfsapi.Credentials
                {
                    UserName = "theUserName",
                    Password = "theVerySecurePassword"
                },
                identify = "theIdentifyString"
            };

            req.Args = new bfsapi.GetRecurringOrderTemplatesArgs()
            {
                BrickIds = new Guid[] { new Guid("4257b69d-32b3-4d7c-9f33-0f8d6350c35b") }
            };

            req.Fields = new bfsapi.GetRecurringOrderTemplatesFields()
            {
                BrickId = true,
                CreatedDate = true,
                PeriodicityCode = true,
                OrderNo = true,
                AccountId = true,
                TransferReceiver = true,
                StatusKey = true,
                Amount = true,
                BusinessDate = true,
                IsRecurringOrder = true,
                CurrencyCode = true
            };

            var response = target.GetRecurringOrderTemplates(req);

[data-colorid=z60ip6eikb]{color:#333333} html[data-color-mode=dark] [data-colorid=z60ip6eikb]{color:#cccccc}Filter inputs

Response rows (Array) inherits from EntityBase

Code examples

Filter inputs