HaloPSA

HaloPSA Guides

Documentation to assist with the setup and configuration of the HaloPSA platform

Guides > GoCardless Integration

GoCardless Integration

In this guide we will cover:

- What is the GoCardless Integration?

- Enabling the Module

- Customer Imports

- Viewing Payments



What is the GoCardless Integration?

GoCardless can be integrated with Halo to import customers, assign custom fields to them, and sync payment statuses.


The GoCardless integration with Halo does not currently support payment processing, this will be available in the near future.


Enabling the Module

To begin integrating with GoCardless, you must enable the integration module in Halo (Configuration > Integrations), by clicking on the + sign on the module.


Fig 1. Enabling the GoCardless Module.


Customer Imports

You can match GoCardless Companies to Halo Customers/ Site if they are the same. When the Names are different across GoCardless and Halo, the user will be placed into the "Default Site" which is set on the integration page shown in Fig 2.


Fig 2. Custom Field Mappings.


The site which is synced to when importing users, will be the default site of the customer (The Invoice Site). After the initial import, you can move users into the correct sites, this will not affect the syncing of users, as the Halo integrator will match onto the user and not the site, when recurring syncs are enabled. 


If you have not yet setup the Halo Integrator, use the following guide.


Halo customers that are On-Premise can setup the Halo DB Integrator (This is only for On-Premise customers as hosted customers have this hosted on Halo by default).


The difference between the Integrator and the DB Integrator is explained in the DB Integrator guide. 


Fig 3. Enabling the Halo Integrator for this Integration.


From here you can enter your access token and begin mapping your customers in GoCardless to your users in Halo. There is an import users button for importing users into Halo, the below fields (Shown in Fig 4) will be populated based on the customers details in GoCardless. To sync custom fields from GoCardless to Halo, add them via the mappings table.


Fig 4. Importing Users from GoCardless.


You can add custom fields to a Customer in GoCardless, and then map to fields in Halo (As shown in Fig 2). Within Halo, these will have to be custom fields of type "Text" and Entity: User. The field mapping example is shown in Fig 2.


Fig 5. The "User" Entity for Custom Fields.


Custom Fields can be added to customers in GoCardless.


Fig 6. Adding Custom Fields in GoCardless.


This will be added to the user in Halo, notice that the custom field mappings will need to be added to for this below field to populate (Fig 7). The import screen does not have custom field columns, this is why you must add to the field mappings table.


Fig 7. The Custom Fields Tab on the User in Halo.


Viewing Payments

You will then be able to view any payments the User has made, this is done via the "GoCardless Payments" tab on their User Details.


Fig 8. GoCardless Payments Tab.


You can double click a Payment to open it in GoCardless.

Popular Guides