Setting Up a Testing Environment

Why Isolate Your Testing Environment?

When building or testing a new integration with the nXus REST API, you should never connect directly to your live production company file. QuickBooks databases can be sensitive, and executing experimental read/write operations carries a risk of data corruption.

To safely develop and troubleshoot, Intuit provides Not For Resale (NFR) licenses to developers. These licenses give you fully functional versions of QuickBooks Desktop (such as Enterprise) specifically for testing API connections and Web Connector setups.

---

Step-by-Step: Acquiring and Setting Up NFR Licenses

Step 1: Create an Intuit Developer Account

Before you can request testing software, you need to be registered as a developer with Intuit.

1. Navigate to the Intuit Developer Portal.
2. Sign up for a free developer account or log in with your existing Intuit credentials.
3. Complete your developer profile.

Step 2: Request Your NFR Licenses

Intuit provides NFR licenses through their support ticketing system.

1. Log into your Intuit Developer account and navigate to the Help or Support section.
2. Open a new support ticket requesting “QuickBooks Desktop NFR Licenses for API Development.”
3. In your request, specify the exact versions you need to test against (e.g., QuickBooks Enterprise Solutions 24.0, or older versions if your user base requires backward compatibility).
4. Intuit support will review the request and provide you with the installation links, license numbers, and product codes.

Step 3: Deploy an Isolated Virtual Machine (Recommended)

Installing multiple years or editions of QuickBooks Desktop on the same local Windows machine can cause registry conflicts and Web Connector cross-talk. We highly recommend using a Virtual Machine (VM) for your nXus testing environment.

1. Spin up a clean Windows environment (Windows 10 or Windows 11) using your preferred VM software (Hyper-V, VirtualBox, or a cloud provider).
2. Download the NFR installation executable provided by Intuit.
3. Install QuickBooks Desktop using your assigned NFR license number and product code.
4. Open QuickBooks and create a new, blank company file, or download one of Intuit’s sample company files to populate your environment with dummy data.

⚠️ Important Compliance Notice: Use Sample Data Only > When using nXus in a testing environment, a sample company file MUST be connected. Do not use a copy of your live production data. Some of the data transmitted during testing connections will be cached by our systems for performance analysis and to ensure compliance with our Terms of Use. To protect sensitive financial information, strictly use dummy data.

Step 4: Connect nXus to the Sandbox

With your NFR version of QuickBooks running:

1. Ensure you are logged into the sample company file as the Admin.
2. Install the QuickBooks Web Connector (QWC) on the VM.
3. Verify that the QBW and QWC executables share the exact same Windows permissions (as outlined in our Permission & Compatibility guide).
4. Load your nXus .qwc configuration file to establish the connection between the nXus API wrapper and your isolated sandbox.

You are now ready to safely test API calls, webhooks, and data syncing without any risk to live accounting records!