4 min readUpdated Mar 2, 2026

QuickBooks Integration Documentation

Overview

The QuickBooks integration for Vantage provides seamless connectivity with QuickBooks Online, enabling users to access and manipulate financial data directly from the Vantage platform. This integration allows users to fetch company information, customer lists, invoices, and manage authentication securely through access tokens.

Purpose

The purpose of the QuickBooks integration is to enable users to streamline financial operations by offering features such as:

Accessing customer information
Retrieving invoice details
Fetching company information
Facilitating secure communications with QuickBooks' API via OAuth authentication

Settings

The QuickBooks integration has several important settings that dictate its behavior and configuration. Below is a detailed breakdown of each setting:

1. Client ID

Input Type: String
Description: The unique identifier for your QuickBooks application. This is used to authenticate API requests and link the app to the QuickBooks account.
Default Value: None (must be provided).

2. Client Secret

Input Type: String
Description: A secret key for your QuickBooks application that is used alongside the Client ID to secure API access. Changing the client secret invalidates any existing access tokens.
Default Value: None (must be provided).

3. Refresh Token

Input Type: String
Description: A token that allows the application to request a new access token without requiring user credentials. This is critical for maintaining long-term access to the QuickBooks API.
Default Value: None (must be provided).

4. Realm ID

Input Type: String
Description: The unique identifier for the QuickBooks company file. This ID is essential for making API requests for the specific company's data.
Default Value: None (must be provided).

5. Max Results

Input Type: Numeric (default is 100)
Description: This setting determines the maximum number of customer or invoice records to fetch in a single API call. Altering this value affects the volume of data returned in response to queries.
Default Value: 100

How It Works

Authentication: The integration uses OAuth 2.0 for secure API access:
- When initialized, it gathers sensitive credentials (Client ID, Client Secret, Refresh Token, and Realm ID).
- The method getAccessToken retrieves a valid access token, checking if the existing token is still valid before refreshing it.
API Requests:
- The integration makes requests to the QuickBooks API using the authorize method, which attaches the obtained access token to headers for subsequent API calls.
- It features methods to list customers (listCustomers), list invoices (listInvoices), and retrieve company information (getCompanyInfo).
Error Handling: The integration asserts that responses from the QuickBooks API are properly handled and any errors during token retrieval or data requests are explicitly reported.

Data Expectations

The integration expects the following data when making API requests:

Token Data: The access token required for authenticated API access.
Company ID: The realm ID to delineate which company data is to be accessed.
API Payload: Standard JSON format for requests, containing the parameters required by the QuickBooks API.

Use Cases & Examples

Use Case 1: Customer Relationship Management

A small business wants to integrate its customer management system with QuickBooks. Using the QuickBooks integration from Vantage, the business can pull customer data, including names and contact information, directly into the Vantage dashboard for analysis.

Use Case 2: Invoice Tracking

A finance team needs real-time visibility into outstanding invoices. By leveraging the listInvoices method, they can retrieve up-to-date information on all invoices issued and their payment status.

Specific Example Configuration

Scenario: A company will implement the QuickBooks integration to monitor customer data and invoices for analysis.

Sample Configuration Data:

{
    "client_id": "your-quickbooks-client-id",
    "client_secret": "your-quickbooks-client-secret",
    "refresh_token": "your-refresh-token",
    "realm_id": "your-realm-id",
    "max_results": 50
}

Configuration Details:

Client ID and Client Secret are obtained from the QuickBooks developer account.
Refresh Token is generated during the first OAuth authorization flow.
Realm ID corresponds to the specific QuickBooks company file.
Setting max_results to 50 allows for a focused pull of data, which may enhance performance by limiting the data size.

This configuration enables the finance team to quickly access pertinent customer information and invoice records without significant overhead.

← PreviousShopify Next →Zendesk