QuickBooks

This connector captures data from QuickBooks into Estuary collections.

Supported data resources

The following data resources are supported through the QuickBooks API:

• Accounts
• Bill Payments
• Bills
• Budgets
• Classes
• Credit Memos
• Customers
• Departments
• Deposits
• Employees
• Estimates
• Invoices
• Items
• Journal Entries
• Payment Methods
• Payments
• Purchase Orders
• Purchases
• Refund Receipts
• Sales Receipts
• Tax Agencies
• Tax Codes
• Tax Rates
• Terms
• Time Activities
• Transfers
• Vendor Credits
• Vendors

By default, each resource is mapped to an Estuary collection through a separate binding.

Prerequisites

To set up the QuickBooks source connector, you'll need a QuickBooks company ID.

Configuration

You configure connectors either in the Estuary web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the QuickBooks source connector.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
/realm_id	Company ID	ID for the Company to Request Data From	string	Required
/credentials/access_token	Access Token	The access token received from the OAuth app.	string	Required
/credentials/access_token_expires_at	Access Token Expiration Datetime	The access token's expiration date and time in the format 2025-04-24T00:00:00Z.	string	Required
/credentials/client_id	OAuth Client ID	The OAuth app's client ID.	string	Required
/credentials/client_secret	OAuth Client Secret	The OAuth app's client secret.	string	Required
/credentials/credentials_title	Authentication Method	Name of the credentials set. Set to OAuth Credentials.	string	Required
/credentials/refresh_token	Refresh Token	The refresh token received from the OAuth app.	string	Required
/start_date	Start Date	The date from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data modified after this date will be replicated.	string	Default: 30 days ago

Bindings

Property	Title	Description	Type	Required/Default
/name	Resource Name	Name of the QuickBooks resource from which collections are captured	string	Required
/interval	Polling Interval	Frequency at which to poll for new data	string	Default: 5 minutes

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-quickbooks:v1
        config:
          realm_id: <your realm id>
          credentials:
            access_token: <secret>
            access_token_expires_at: "2025-04-24T12:00:00Z"
            credentials_title: "OAuth Credentials"
            client_id: <secret>
            client_secret: <secret>
            refresh_token: <secret>
          start_date: 2024-01-01T00:00:00Z
    bindings:
      - resource:
          name: Invoices
          interval: PT5M
        target: ${PREFIX}/invoices
      - resource:
          name: Customers
          interval: PT5M
        target: ${PREFIX}/customers