> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# QuickBooks

## Overview

The QuickBooks connector enables Zenskar to import and synchronize accounting data directly from your QuickBooks Online account. By integrating QuickBooks as a data source, Zenskar can automatically access key financial entities such as invoices, payments, customers, vendors, and journal entries — ensuring your billing and revenue workflows remain accurate and up to date.

## Prerequisites

Before connecting QuickBooks as a data source in Zenskar, ensure that you have the following:

| **Requirement**              | **Description**                                                                                                              | **Reference**                                                                                                                                    |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **QuickBooks account**       | A valid [Intuit QuickBooks account](https://quickbooks.intuit.com/global/) with access to the company data you want to sync. | [QuickBooks Global](https://quickbooks.intuit.com/global/)                                                                                       |
| **Intuit Developer account** | Required to create and manage apps that can access QuickBooks data via APIs.                                                 | [Get started with Intuit Developer](https://developer.intuit.com/app/developer/qbo/docs/get-started)                                             |
| **OAuth 2.0 credentials**    | Client ID, Client Secret, Access Token, Refresh Token, and optionally Client Token — used for secure API authentication.     | [OAuth 2.0 Authentication and Authorization Guide](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization) |
| **Realm ID**                 | A unique identifier for your QuickBooks company used to specify which company’s data to access.                              | [Learn about Realm ID](https://developer.intuit.com/app/developer/qbo/docs/learn/learn-basic-field-definitions#realm-id)                         |

<Callout icon="💡" theme="default">
  You can use the [OAuth 2.0 Playground](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0-playground) provided by Intuit to easily generate and test your OAuth credentials.
</Callout>

***

## Set up a QuickBooks data-source connector via Zenskar dashboard

1. Log into your Zenskar dashboard.
2. In the left side bar, click **Usage > Data Sources**.
3. In the top-right corner, click **+ ADD DATA SOURCE**.
4. On the **Add New Data Source** page, [configure the connector](https://docs.zenskar.com/docs/data-source-connector-for-quickbooks#configure-the-connector).
5. Click on the **SAVE SOURCE** button.

### Configure the connector

#### General configuration

| Field           | Description                                   | Required |
| :-------------- | :-------------------------------------------- | :------- |
| **Source Name** | Enter a unique name for this data source.     | Yes      |
| **Source Type** | Select **QuickBooks** from the dropdown menu. | Yes      |

#### Connector configuration

| Field             | Description                                                                                                    | Required |
| ----------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
| **Client ID**     | The OAuth 2.0 application ID issued when you register an app in the Intuit Developer Portal.                   | Yes      |
| **Client Secret** | The OAuth 2.0 application secret paired with the Client ID — used when exchanging codes for tokens.            | Yes      |
| **Access Token**  | A short-lived token (typically valid for about 1 hour) used to authenticate API calls to QuickBooks.           | Yes      |
| **Refresh Token** | A longer-lived token used to obtain a new Access Token when the current one expires.                           | Yes      |
| **Start Date**    | The date from which you’d like to begin replicating data: records created before this date will not be synced. | Yes      |
| **Sandbox**       | Select **Yes** if you’re replicating data from the sandbox (test) environment; otherwise select **No**.        | Yes      |
| **Realm ID**      | The unique company ID (also called “realmId”) of the QuickBooks Online company whose data you want to sync.    | Yes      |

#### Data source access mode (read-only)

Zenskar replicates data directly from the source to Zenskar’s data infrastructure. The data is periodically synced to maintain freshness. This option is:

* Ideal for small-mid size database (less than 30 GB)
* Ideal for periodical data ingestion
* Optimized for quicker invoice generation

***

## Addendum

### Supported streams

The Zenskar QuickBooks connector can sync data from the following [QuickBooks Accounting API entities](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account).

| **Stream**         | **Description**                                                          |
| ------------------ | ------------------------------------------------------------------------ |
| **Accounts**       | Chart of accounts that categorize transactions and track balances.       |
| **BillPayments**   | Payments made to vendors to settle bills.                                |
| **Budgets**        | Financial plans that define expected income and expenses over a period.  |
| **Bills**          | Vendor bills representing amounts owed for goods or services.            |
| **Classes**        | Categories used to track different segments of the business.             |
| **CreditMemos**    | Refunds or credit issued to customers.                                   |
| **Customers**      | Details about customers including contact info and balances.             |
| **Departments**    | Organizational units used for financial reporting.                       |
| **Deposits**       | Customer payments and other deposits recorded in the system.             |
| **Employees**      | Employee records for payroll and HR tracking.                            |
| **Estimates**      | Sales quotes or cost estimates provided to customers.                    |
| **Invoices**       | Sales invoices issued to customers for goods or services.                |
| **Items**          | Products or services sold or purchased.                                  |
| **JournalEntries** | General ledger entries that record transactions manually.                |
| **Payments**       | Payments received from customers.                                        |
| **PaymentMethods** | Accepted methods of payment such as cash, credit card, or bank transfer. |
| **Purchases**      | Expenses and purchases made that aren’t tied to bills.                   |
| **PurchaseOrders** | Orders placed with vendors for goods or services.                        |
| **RefundReceipts** | Refunds issued to customers for returned goods or overpayments.          |
| **SalesReceipts**  | Records of completed sales where payment was received immediately.       |
| **TaxAgencies**    | Agencies to which sales tax is remitted.                                 |
| **TaxCodes**       | Sales tax rules applied to transactions.                                 |
| **TaxRates**       | Individual tax rates used to calculate total sales tax.                  |
| **Terms**          | Payment terms for customers and vendors.                                 |
| **TimeActivities** | Time tracking records for employees and vendors.                         |
| **Transfers**      | Money transfers between accounts.                                        |
| **VendorCredits**  | Credits received from vendors for returns or overpayments.               |
| **Vendors**        | Supplier information including balances and contact details.             |
