QuickBooks Plugin

Overview

OmniFund integrates with QuickBooks Pro, Premier, and Enterprise to allow you to easily process payments from within QuickBooks using our payment gateway. 

System Requirements

  • Windows 7, 8, and 10 are supported
  • QuickBooks Pro and Premium 2006 through 2018 are supported, as well as QuickBooks Enterprise 6 through QuickBooks Enterprise 2018.

Main Features      

  • Process ACH and CC payments directly from within QuickBooks
  • Report on Transactions

1.   Installation

There are several tasks that need to be completed before installing the OmniFund Plugin.

  1. Ensure that you have already installed QuickBooks Pro, Enterprise, or Premium prior to installing the OmniFund Plugin.
  2. Close all the running instances of QuickBooks.
  3. Request an OmniFund Plugin license from OmniFund support if you have not already done so. They will provide you with a Name and Product Key for the plugin.  Note that you will need to request a separate license for each machine that you intend to install the plugin on.

1.1. OmniFund Plugin installation

Step 1

Obtain the OmniFund QuickBooks Plugin

Run the OmniFund Plugin setup by right clicking on its icon and selecting Run as Administrator. You will be prompted to approve running the program from an unknown publisher.  Click Yes to continue.  This screen is slightly different depending on your version of windows.


Step 2

On the main installation screen, click the Install button.



The installation will proceed and will indicate if there is an error during the process.

Step 3

Enter the Registered Name and Product key provided by OmniFund, and then select your edition of QuickBooks.  Click on the Next button to proceed.

You will see the Installation Success screen once your license information has been validated. If you are prompted to Restart your computer, click on the Restart button; otherwise, click on the Close button.

Step 4

Restart the system if it does not automatically restart.  This ensures a clean slate for the plugin’s setup in QuickBooks.

Step 5

After your computer boots up, open QuickBooks by right-clicking on the QuickBooks icon (either on your Desktop or on the Start Menu), and select Run as administrator.  On Windows 10, if you right click on the Start Menu icon for QuickBooks, you’ll find this option under the More menu; other versions of Windows show this option directly on the menu.  Windows may prompt you to authorize for this program to make changes to the system.  If it does, click Yes.  Once QuickBooks opens, you will see the following screen. Select Yes, whenever this QuickBooks company file is open.  Leave the Allow this application to access personal data such as Social Security Numbers and customer credit card information checkbox unchecked, as the plugin will not need to access that type of information.  Then click Continue.

Step 6

Click on Yes when QuickBooks asks if you would like to confirm to proceed.

Click Done once it finishes.

Step 7

Click on the Customers menu in QuickBooks and you should see OmniFund: Plugin listed.

1.2. Common Plugin Issues

IssueSolution
OmniFund Plugin does not show in the Customers drop down menu
  1. A system restart may be required to show the OmniFund Plugin in the menu.  Make sure to restart your computer after installing the plugin.  Once the system has restarted, check to see if the OmniFund plugin is visible in the drop-down menu.

  2. Open QuickBooks go to Edit/Preferences.

    1. Uncheck the “Keep QuickBooks running for quick startup” option, and click the “Ok” button.

    2. Close QuickBooks with File/Exit.

    3. Restart your computer and run QuickBooks normally.


2.   OmniFund Plugin Dashboard

The OmniFund plugin integrates directly within QuickBooks so that payments can be processed automatically when needed.  It additionally contains a Dashboard that provides additional functionality and diagnostic tools.  To launch the dashboard:

Step 1:  Click on OmniFund: Plugin under the Customers menu. The OmniFund Dashboard will display.

Multiple features are then accessible through the menus at the top of the Dashboard window.

3.   Tools Menu

3.1.  Settings

The Settings screen allows you to configure the OmniFund QuickBooks plugin.

Step 1:  From the OmniFund Plugin Dashboard click on Tools > Settings to launch the Settings screen.

3.2. Payment gateway

This tab contains your main settings for the plugin to interface with the OmniFund Gateway.  Enter the MID (User Login) and PIN (Password) for the OmniFund Gateway and select what types of payments you would like to enable within the plugin.  The Server Address should be left as is unless OmniFund support indicates that you should change this value.

3.3. Hardware

Select the card scanning and printing hardware you would like the plugin to interface with.  The Card Reader dropdown will show any detected card readers or check scanners.  Choose the one you plan to use with the plugin.  If you do not select a card reader or check scanner here, you will need to manually enter the card/check information later.  If a device is missing from this list that you believe should be there, please contact OmniFund support and let them know the make and model of the device to determine its compatibility with the plugin.

Select a printer in the list to enable receipt printing from within the plugin.

3.4. Receipt Configuration

Your receipts within the app are customizable, and a separate design can be used for both check and card transactions.  Choose which payment type to edit, and then you can update the Logo, Header, Footer, Disclaimer and other information for the receipt.

 

3.5.  Account

In this tab user can select appropriate items.

Save Customer Account Profile: This enables saving the customer profile for future use.  This means that each time you access a customer, you can quickly retrieve the payment information you previously entered for that customer without having to re-enter it.

Email send to OmniFund: If this is checked, the customer’s email address will be included with any transactions sent to the OmniFund Gateway, which will email a receipt to the customer automatically.  Leave it unchecked to ensure no emails get sent. 

3.6. Backup/Restore

Backup and restore configuration and other settings within the plugin.

Step 1: Click on Tools à Backup/Restore.

Step 2: The Backup and Restore screen will be displayed, allowing you to perform the following tasks:

  • Backup Settings and Log Files
  • Restore Settings
  • Restore Log Files

3.7. Virtual Terminal

Open the Virtual Terminal to process transactions outside of QuickBooks. 

Step 1: From the OmniFund Dashboard Click on Tools à Virtual Terminal.

Step 2: Click the OmniFund VT button to open the Virtual Terminal

3.8. Exit

Exit from the OmniFund Dashboard.

4.   Information Menu

The Information Menu gives you more in depth information about the plugin

4.1. About Us

This shows technical information.

Step 1: Click on Information > About Us

Step 2: Release information will be displayed about the plugin.

4.2. View Log

Step 1: Click on Information > View Log Details

Step 2: Log information from the plugin will be displayed.  To filter the information, select a log type and a date range.

5.   Support Menu

If any questions you may have are not answered by the User Manual, then use OmniFund support to get assistance.  The Support Menu will aid in diagnosing deeper issues or allow you to set more advanced settings with the plugin.

5.1. Custom Settings

Open the custom settings dialog (on advice of the OmniFund support team only)

Step 1: Click on Support > Custom Settings

5.2. Show Data Folder

Open the folder location where the plugin stores its data.

Step 1: Click on Support > Show Data Folder

Step 2: Windows Explorer/File Explorer will open with the data folder open.

5.3  OmniFund Support

Opens your web browser to the OmniFund Support website.

Step 1: Click on Support > OmniFund Support

Step 2: Your web browser will be launched to the OmniFund Support website.

5.4  User Manual

Downloads the user manual and opens it up in your word processing application.

Step 1: Click on Support > User Manual

Step 2: The manual will be downloaded to your Desktop and automatically opened.

6.   Report

The report displays all transactions based on the selected criteria.  Select the appropriate filters and then click on Generate to run the report.

  • Print Report: To print the report.
  • Export To PDF: Export the report as a PDF file.
  • Export To Excel: Export the file in a format that is compatible with Microsoft Excel.
  • Print Receipt: Print a receipt for the selected transaction.

7.   Payment

Create Invoices

Create an invoice from the QuickBooks Home screen. Fill in the customer details and invoice items, and then click on Receive Payments. Enter the payment information into QuickBooks, and then save the payment, and then the Payment Processing screen will be displayed.

 

Receive Payment

You can also process a payment using the plugin by using Receive Payments from the QuickBooks Home screen.  Enter the customer and payment information for QuickBooks, and then save the transaction.  The Payment Processing screen will then be displayed.

7.1. Payment through Credit Card

On the payment processing screen, enter the card number, CVV, zip code, card expiration date, name on card, and then select payment type.  Or alternatively, select the Customer from the list that is built from your list of Customers in OmniFund, and then select an existing account from the Select Account list.

Scan: This will allow scanning of a card from the plugin. Before scanning, make sure your card reader is configured in the plugin settings.

Pay: Click on Pay to initiate the transaction.

Transaction Result Window

This window displays information about the Credit Card or ACH transaction that occurred.

Close: Close the Transaction Result window.

Print Receipt: Print a receipt of the transaction.  Ensure that you have configured a printer in the plugin’s settings prior to printing a receipt.

Credit Card Approval

 

ACH Approval

7.2. Payment through ACH

The ACH tab will be visible if ACH is configured in the OmniFund settings.

Enter the routing number, account number and check number or click on Scan to scan a check.

Scan: Scan a check from within the plugin. Before scanning, make sure you have selected your check reader in the Card Reader dropdown in the plugin’s settings.

Pay: Click on Pay to initiate the transaction.

8.   OmniFund QB Diagnostic Tool

The plugin’s installation includes a diagnostic tool to assist OmniFund support with diagnosing issues with the plugin on your computer.  This tool can be found on your start menu by looking inside the OmniFund folder or by typing OmniFund QB Diagnostic Tool after clicking on the Start button.

The tool allows you to re-register various portions of the plugin with QuickBooks, and to ensure that QuickBooks is indicating success or failure of that registration.

In order to have the most flexibility using this utility, it should be launched by right-clicking on the icon, and selecting Run as administrator.  On Windows 10’s Start Menu, you may need to select More, and then Run as administrator

 

8.1. Register Server

This option re-registers the plugin as a COM object in the Windows registry.  This enables QuickBooks to find the plugin within the system.  A successful registration is indicated below.

If an error occurs, it will be displayed.  The most prevalent error for this function is from not running the utility as an Administrator.  That error is:  System.UnauthorizedAccessException: Access to the registry key 'HKEY_CLASSES_ROOT\CLSID\{62447f81-c195-446f-8201-94f0614e49d5}' is denied.

If you see that error, close the utility and restart it by running it as Administrator.

8.2. Register for Data Callback

This option re-registers the plugin’s Data Callback function in QuickBooks.  This enables us to receive callbacks from QuickBooks when specific data events occur.  A successful registration is indicated below.

If an error occurs, it will be indicated within the XML that is displayed.  QuickBooks will typically include a statusCode and a statusMessage that can help further diagnose the issue.

8.3. Register for UI Callback

This option re-registers the plugin’s User Interface Callback function in QuickBooks.  This enables us to receive callbacks from QuickBooks when our menu item is clicked and registers the menu item in the interface.  A successful registration is indicated below.

If an error occurs, it will be indicated within the XML that is displayed.  QuickBooks will typically include a statusCode and a statusMessage that can help further diagnose the issue.

8.4. Unregister for UI Callback and Unregister for Data Callback

Both options unregister the plugin’s callback functions from QuickBooks.  Once done, the plugin will no longer be integrated with QuickBooks unless the functionality is re-registered.

A successful un-registration is indicated below.  Note the statusCode is 0 and the statusMessage is Status OK.

If an error occurs, it will be indicated within the XML that is displayed.  QuickBooks will include a statusCode and a statusMessage that can help further diagnose the issue.

8.5. Launch OmniFund Plugin

This will launch the OmniFund plugin’s Dashboard so that you can make some initial updates to settings, etc.  This ensures that the plugin itself will run properly on the computer it is installed on.  This does not indicate whether QuickBooks will launch the plugin, as that will need to be tested from within QuickBooks.