HaloPSA Integration Set-Up Guide

Your step-by-step guide to integrating HaloPSA successfully.

How to Set up your HaloPSA Integration

Connecting HaloPSA with Alternative Payments is quick and seamless, allowing you to maintain your existing workflows while enhancing payment flexibility for your customers. Follow these steps to get started:

1. Navigate to Configuration > Integrations > HaloPSA API.

On your HaloPSA home screen, follow the below path:

a. Configuration

b. Integrations

c. HaloPSA API

2. Create a new application. You can name it “Alternative”.

Click “View Applications” and create a new application in the top right corner of the screen

Name the Application “Alternative”

3. Choose “Client ID and Secret (Services)” as the authentication method.

4. Generate a new Client Secret

5. Choose “Agent” as login type

• Select “Agent” for the login type

• Choose the Agent to log in as that has Admin permissions or create a new API agent

6. Configure Permissions & "Save” the Application in HaloPSA

• Toggle to the “Permissions” tab

• Click “Edit” in the top left corner, select the following boxes and then hit Save

1. Admin:webhooks

2. Read:customers

3. Edit:customers

4. Read:invoices

5. Edit:invoices

6. Read:contracts

7. Edit:contracts

7. Fill out the Alternative Payments form

Within your Partner dashboard, click on "Connect" within the HaloPSA module and fill out the form with the following details:

• App Domain

• Client ID

• Client Secret

• Invoices Created Since (optional, not required for secondary integration set up)

• Invoice Number Field (HaloPSA ID or Third Party Invoice Number)

Click “Continue” and your integration set-up is complete!

How to ensure agreement subtypes sync into Alternative Payments

1. Within HaloPSA, navigate to Configurations and then Agreements.

2. From Agreements, scroll down and select Agreement subtype.

3. Create any applicable agreements and any invoices associated with this agreement subtype will be synced into Alternative Payments where you'll be able to configure a contract-based auto-pay rule.

Preferences

For partners using HaloPSA as the primary integration, the functionality to initiate manual syncs is available. Click on the three dots and you'll see the option to "Fetch new data" "Fetch unpaid invoices."

1. Fetch New Data: This option allows for the sync of all invoices and customers created or updated within the last hour.

2. Fetch Unpaid Invoices: Partners can now initiate a manual sync for all unpaid invoices to capture any invoice updates to unpaid invoices if needed.

3. Limitations:

   • The Fetch New Data can be initiated once per hour.

   • The Fetch Unpaid Invoices can be executed once every 12 hours.

Love our platform? Rate us on Channel Program and check out our Referral Program page!