Skip to Content

QuickBooks desktop connection guide


This guide describes the system requirements and instructions for connecting Vinyl to a QuickBooks Desktop. This guide uses an example QuickBooks file with a Customer table containing customer records to illustrate the core concepts.

In this example scenario QuickBooks and Vinyl reside on the same server. If you are connecting Vinyl to an external QuickBooks environment, be sure to follow proper security protocol for your infrastructure.

To connect your servers, you must have Vinyl 3.3+ installed.

System requirements

Application and remote connector

  • QuickBooks Desktop

  • QuickBooks Remote Connector

Client web browser

  • Chrome: 84+

  • Firefox: 73+

  • Safari: 13.0.1+

  • Edge: 84+

Connection instructions

Install QuickBooks remote connector

The Remote Connector is used to be able to write and read QuickBooks data in situations where direct access to QuickBooks is not available.

  1. Download the QuickBooks Remote Connector Setup.exe file from<

  2. Install the Remote Connector file on the same server where QuickBooks Desktop is installed

    1. Run the .exe file as an Administrator in Single-user Mode

    2. Click Next through the install wizard prompts and I agree to accept the License Agreement

    3. Click Install to install the Remote Connector for QuickBooks

    4. Click Finish to complete the installation and launch the Remote Connector


  3. Confirm that QuickBooks Desktop app is launched and running in Single-user Mode

  4. Click the Users tab from the Remote Connector

  5. Click the Add… button

    Graphical user interface, application Description automatically generated

  6. Create a record to register the user connecting in Vinyl:

    1. Enter the User. For example: VinylDemo

    2. Enter the Password. For example: vinyldemo123

    3. Confirm the Authentication type. For example: Basic Authentication

    4. Confirm the Software connecting to. For example: QB Desktop

    5. Leave the default value <currently open company> as the Company File

    6. Review and modify the Application Name if desired. For example: VinylDemo

    7. Review the Data Access value, and modify it as needed. For example: Full

  7. Click the OK button to save

  8. An Application Authorization prompt will appear


  1. Click the OK button to open QuickBooks Desktop as an Administrator

  2. Review the QuickBooks Application Certificate and select the appropriate option

    1. For this configuration, select Yes, always; allow access even if QuickBooks is not running
  3. Review the Authorization prompt and click Yes

  4. Review and determine if you wish to grant the application access to personal data

  5. Click the Continue… button

  6. Review the Access Confirmation screen

    Graphical user interface, application Description automatically generated

  7. Click the Done button

  8. An Authorization Successful prompt will now appear, asking if you want to save the Company File information.

  9. Click the Yes button

  10. Click the Status tab on the Remote Connector

  11. Review and confirm that the Remote Connector has connected to QuickBooks

Create a Vinyl app to connect to QuickBooks

In this section, we will create a Vinyl app and establish a connection to QuickBooks. Once configured properly, QuickBooks records can be viewed and modified from the Vinyl app.

  1. Navigate to the Vinyl Site Menu

  2. Click the + App button

  3. Assign an Application Name. For example: QuickBooks Demo

  4. For the Data Source, select Existing Source

  5. For the Home Page, select Left Menu

  6. Click the Proceed button

  7. From the Add a Source to your application screen, select New Connection

  8. Click the Next button

  9. For the Connection Category, select Other

  10. In the Types of Connections search field, enter "quick"

  11. Click the Selected radio button for Quick Books Desktop

    Graphical user interface, text, application Description automatically generated

  12. Click the Next button

  13. Enter the appropriate values for the New Connection Server Settings and Security Settings:

    1. Server Name: the name of the server. For example: QuickBooksDemo

    2. Type: the type of connection. For example: Quick Books Desktop

    3. URI: the server URI. For example:

    4. User Name: use the same User configured for the Remote Connector. For example: VinylDemo

    5. Password: use the same Password configured for the Remote Connector. For example: vinyldemo123

  14. Click the Next button. Vinyl now runs background processes and imports the Quick Books schema. This step may take a few minutes to complete.

  15. Navigate to the Site Menu and launch the new app created. For example: QuickBooks Demo

  16. Go to the App Workbench and confirm there is 1 Data Source registered and Tables exist from the source file connected to

  17. Click the Data Sources tile

  18. Confirm the Quick Books Desktop Data Source is registered

  19. Click the corresponding Server Details button

  20. Expand the Testing section

  21. Click the Test Connection button


  22. Confirm you see a green Success message, indicating the connection is configured correctly

  23. The Remote Connector Status tab will also show successful connection traffic in Recent Activity

  24. Navigate back to the App Workbench

  25. Click the Tables tile

  26. Locate the Customer table and click the corresponding Results icon

    1. While Vinyl loads the Quick Books table data you can see the connection handshake processing through the Remote Connector Status tab
  27. Vinyl will retrieve and display all records from the selected table in QuickBooks. Based on the configuration provided, changes made to data from the Vinyl app will be written and saved to QuickBooks.


The following sites offer more information, including the latest version of the QuickBooks Remote Connector Setup.exe file: