WHMCS Direct Debit SEPA: Userguide

Transcription

1 WHMCS Direct Debit SEPA: Userguide Introduction Functionality Userguide Introduction Installing and activating Direct Debit SEPA Generator module Configuration settings Custom fields linking Bank Details Filter Templates XML batch tab Process page View Batch The WHMCS Direct Debit module facilitates offering a direct debit right to your customers per invoice. Being extremely easy to install and use, this module is also ready for the SEPA European Direct Debit. WHMCS Direct Debit module creates an EXtensible Markup (XML), which you can upload to your bank account and this will result into a fast automatic payment of your invoice. You only need an IBAN number from the client, and their agreement of course. Functionality User friendly module Easily integrated in WHMCS Configurable per customer Ready for the new SEPA European Direct Debit Automatically marks invoices as paid Userguide Installing and activating Direct Debit SEPA Generator module Unzip and upload this folder into modules/addons directory of WHMCS installation. Login in the administrator area of your WHMCS. Hover the menu item "Setup" and click the sub menu item "Addon Modules". 1/6

2 Search for the addon you just uploaded and hit the Activate button on the right side. Choose the admin role groups to permit access to this module. Enter the license key in order to use all the features within this module. Now check the "Addons" section and find the module you've just installed. Configuration settings Custom fields linking While installing module, there will be 2 Custom Client fields added: IBAN Number and BIC code, which are required for the further usage of module. Those 2 fields must be filled in at the client's profile in order to process a payment in the bank (XML won't be downloaded if they are not filled in). There are also 2 other custom fields which are not required and these are not created automatically: Client Mandate Date (the date when the business relationship with client has started, for example Date of contract) and Client Mandate Reference (a unique reference number for the customer's direct debit contract). If these dates are not added, default values are used: for the first day and CID-[USERID] for the Reference. On the Custom Fields Linking tab you need to link the fields in module to the created Custom Client Fields. 2/6

3 ATTENTION Press the Save settings button in order to save the changes. To add a custom field go to Setup-> Custom Client field and add 2 text fields: Mandate Date and Mandate Reference. Make sure that you insert a unique pattern reference where [USERID] is inserted otherwise the user ID won't be shown in the file. Bank Details Enter the Settings tab to set your bank details, to which all the payments will be sent. 3/6

4 Fill in the fields with your own data: 4. IBAN number BIC code Creditor ID (which is mentioned in your SEPA contract). Pattern of unique reference number which will be inserted in XML file. Press the Save settings button to save all the changes. Filter Templates reate and manage the filter templates, download the XML files based on these filters. Create filter To create filter template press the Add Filter button. Insert a template name Choose a client group (if needed, leave None to search through all clients). Insert a client first name (if needed, leave empty to search through all clients). 4. Choose your payment gateways (if no gateway is selected, then all payment gateways will be chosen through filter). 5. There are 2 ways of selecting a period: Date range (date selection from and to) Recent period (insert the amount of last days, months, years) 6. Press the Create filter button to save your filter. 4/6

5 Edit filter To edit a filter template you can press the Edit button on the line of the exact template. The filter template settings will be opened with the last saved settings. Every option can be changed and will be applied in the same way as the creation. If you don t want to apply the changes you can return to the filter tab by pressing the Cancel button. Revisions After a filter is created, a revision (versions) of this filter will be added. A revision will be created after every edit and saving. You will be able to apply any revision and the filter will show invoices according to that version s settings. A revision can be deleted if you saved the filter with wrong settings by pressing the Delete revision button (this action will delete only current selected revision). Revision won't be applied until you press the Save filter button. Filter Templates tab The Filter Templates can be sorted by ID, name, number of Invoices, Updated (time of last editing) and Processed Date (when the XML file was downloaded). To check the invoices that are included to the filter, you can press the Process button. If no invoices are found, this button will be disabled. To enable it, there should be at least 1 Invoice that suits the filter settings. A Filter Template can be deleted by selecting it in the list, and pressing the Delete button. Process page The Process button leads to the Process page which shows the list of Unpaid Invoices that suit your filter settings. On the bottom of the table the Total sum is shown. Invoices can be sorted by ID, Client name, Client Group, Invoice date, Due Date, Status and Total sum. You can set the payment type (first or recurring). If the client is new and he didn't make any payments to you, the type should be set to First. If you change the payment type for one Invoice of the client, it will be automatically changed for the rest invoices in the batch of this client. You can Download XML for All Invoices or only for Selected Invoices (make sure that the IBAN number and the BIC code are set for this client). This action will download the file, add the Processed date to the Filter templates tab and create batch on X ML batch tab. 4. You can proceed the payment (change status to paid with an added transaction). The invoice will be deleted from this filter if the status is set to paid on this page. 5/6

6 XML batch tab XML batch tab shows the list of downloaded batches. You can sort batches by Date, Filter name and the amount of Paid Invoices. You can check the list of downloaded Invoices by pressing the View Batch button. You can delete the downloaded batch by selecting it and pressing the Delete button. View Batch The View Batch page shows the list of Invoices that are included in the XML file. All the actions from the Process page are available. You can also delete an Invoice from the batch by selecting it and pressing the Delet e Invoices from Batch button (for example if it wasn't paid, and user wants to have a list of paid Invoices in that batch). Downloading XML file on this page will create a new batch with the selected Invoices as on Process tab (1 Invoice can be included to different batches). 6/6