This integration is powered by Singer's QuickBooks tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
QuickBooks integration summary
Stitch’s QuickBooks integration replicates data using the QuickBooks Online API. Refer to the Schema section for a list of objects available for replication.
Note: Currently, replicating data from QuickBooks desktop apps isn’t supported.
QuickBooks feature snapshot
A high-level look at Stitch's QuickBooks (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on September 3, 2020 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Not available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting QuickBooks
QuickBooks setup requirements
To set up QuickBooks in Stitch, you need:
-
An online QuickBooks instance. Desktop instances aren’t currently supported.
Step 1: Add QuickBooks as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the QuickBooks icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch QuickBooks” would create a schema called
stitch_quickbooksin the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your QuickBooks integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond QuickBooks’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
QuickBooks integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access QuickBooks
Lastly, you’ll be directed to QuickBooks’ website to complete the setup.
- If you’re not already signed into your QuickBooks account, enter your credentials and click Login.
- A screen asking for authorization to QuickBooks will display.
- Click Authorize.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For QuickBooks integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up QuickBooks, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
QuickBooks table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
accounts
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
Metadata.LastUpdatedTime |
Primary Key  :
|
Id |
API endpoint : |
The accounts table contains info about the various account types in you QuickBooks instance. This table includes all account types: asset, liability, revenue (income), expenses, and equity.
Note: Both active and inactive accounts are included in the data for this table.
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The bills table contains info about the bills, or requests for payment from third parties, in your QuickBooks instance.
|
Id
The bill ID. Reference: |
||||||||||||||||||||||||
|
APAccountRef
Details about the AP account associated with the bill.
|
||||||||||||||||||||||||
|
Balance
|
||||||||||||||||||||||||
|
CurrencyRef
Details about the currency used in the bill.
|
||||||||||||||||||||||||
|
DepartmentRef
Details about the department associated with the bill.
|
||||||||||||||||||||||||
|
domain
|
||||||||||||||||||||||||
|
DueDate
|
||||||||||||||||||||||||
|
ExchangeRate
|
||||||||||||||||||||||||
|
Line
|
||||||||||||||||||||||||
|
LinkedTxn
A list of transactions associated with the bill.
|
||||||||||||||||||||||||
|
MetaData
|
||||||||||||||||||||||||
|
PrivateNote
|
||||||||||||||||||||||||
|
SalesTermRef
Details about the sales term associated with the bill.
|
||||||||||||||||||||||||
|
SyncToken
|
||||||||||||||||||||||||
|
TotalAmt
|
||||||||||||||||||||||||
|
TxnDate
|
||||||||||||||||||||||||
|
VendorRef
Details about the vendor associated with the bill.
|
bill_payments
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The bill_payments table contains info about payments made on bills received from vendors for goods or services.
|
Id
The bill payment ID. Reference: |
||||
|
APAccountRef
Details about the AP account associated with the bill payment.
|
||||
|
CheckPayment
|
||||
|
CreditCardPayment
|
||||
|
CurrencyRef
Details about the currency used in the bill payment.
|
||||
|
DepartmentRef
Details about the department associated with the bill payment.
|
||||
|
DocNumber
|
||||
|
domain
|
||||
|
ExchangeRate
|
||||
|
Line
Details about the individual line items associated with the bill payment.
|
||||
|
MetaData
|
||||
|
PayType
|
||||
|
SyncToken
|
||||
|
TotalAmt
|
||||
|
TxnDate
|
||||
|
VendorRef
Details about the vendor associated with the bill payment.
|
budgets
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The budgets table contains info about the current state of budgets in your QuickBooks instance. Note: Both active and inactive budgets are included in the data for this table.
|
Id
The budget ID. |
||||||||||||||
|
Active
|
||||||||||||||
|
BudgetDetail
|
||||||||||||||
|
BudgetEntryType
|
||||||||||||||
|
BudgetType
|
||||||||||||||
|
domain
|
||||||||||||||
|
EndDate
|
||||||||||||||
|
MetaData
|
||||||||||||||
|
Name
|
||||||||||||||
|
StartDate
|
||||||||||||||
|
SyncToken
|
classes
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The classes table contains info about the classes set up in your QuickBooks instance. Note: Both active and inactive classes are included in the data for this table.
|
Id
The class ID. Reference:
|
||
|
Active
|
||
|
domain
|
||
|
FullyQualifiedName
|
||
|
MetaData
|
||
|
ParentRef
Details about the parent class associated with the class.
|
||
|
Name
|
||
|
SubClass
|
||
|
SyncToken
|
credit_memos
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The credit_memos table contains info about the credit memos in your QuickBooks instance. A credit memo is a transaction representing a refund or credit of payment for goods or services that have been sold.
|
Id
The credit memo ID. Reference: |
|||||||||||||
|
ApplyTaxAfterDiscount
|
|||||||||||||
|
Balance
|
|||||||||||||
|
BillAddr
|
|||||||||||||
|
BillEmail
|
|||||||||||||
|
ClassRef
Details about the class associated with the credit memo.
|
|||||||||||||
|
CurrencyRef
Details about the currency used in the credit memo.
|
|||||||||||||
|
CustomField
Custom fields associated with the credit memo.
|
|||||||||||||
|
CustomerMemo
|
|||||||||||||
|
CustomerRef
Details about the customer associated with the credit memo.
|
|||||||||||||
|
DocNumber
|
|||||||||||||
|
EmailStatus
|
|||||||||||||
|
ExchangeRate
|
|||||||||||||
|
HomeTotalAmt
|
|||||||||||||
|
Line
|
|||||||||||||
|
MetaData
|
|||||||||||||
|
PrintStatus
|
|||||||||||||
|
RemainingCredit
|
|||||||||||||
|
SalesTermRef
Details about the term associated with the credit memo.
|
|||||||||||||
|
ShipAddr
|
|||||||||||||
|
SyncToken
|
|||||||||||||
|
TotalAmt
|
|||||||||||||
|
TxnDate
|
|||||||||||||
|
TxnTaxDetail
|
|||||||||||||
|
domain
|
customers
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The customers table contains info about the consumers of your business’s goods and services. Note: Both active and inactive customers are included in the data for this table.
|
Id
The customer ID. Reference:
|
||||||||
|
Active
|
||||||||
|
Balance
|
||||||||
|
BalanceWithJobs
|
||||||||
|
BillAddr
|
||||||||
|
BillWithParent
|
||||||||
|
CompanyName
|
||||||||
|
CurrencyRef
Details about the currency used by the customer.
|
||||||||
|
DefaultTaxCodeRef
Details about the default tax code used for the customer.
|
||||||||
|
DisplayName
|
||||||||
|
domain
|
||||||||
|
FamilyName
|
||||||||
|
Fax
|
||||||||
|
FullyQualifiedName
|
||||||||
|
GivenName
|
||||||||
|
Job
|
||||||||
|
Level
|
||||||||
|
MetaData
|
||||||||
|
MiddleName
|
||||||||
|
Mobile
|
||||||||
|
ParentRef
If the customer is a sub-customer, this will contain details about the parent-level customer.
|
||||||||
|
PaymentMethodRef
Details about the payment method used for the customer.
|
||||||||
|
PreferredDeliveryMethod
|
||||||||
|
PrimaryEmailAddr
|
||||||||
|
PrimaryPhone
|
||||||||
|
PrintOnCheckName
|
||||||||
|
ResaleNum
|
||||||||
|
SalesTermRef
Details about the sales term associated with the customer.
|
||||||||
|
ShipAddr
|
||||||||
|
SyncToken
|
||||||||
|
Taxable
|
||||||||
|
WebAddr
|
departments
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The departments table contains info about the departments in your QuickBooks instance. Note: Both active and inactive departments are included in the data for this table.
|
Id
The department ID. Reference:
|
||
|
Active
|
||
|
domain
|
||
|
FullyQualifiedName
|
||
|
MetaData
|
||
|
Name
|
||
|
ParentRef
If the department is a sub-department, this will contain details about the parent department.
|
||
|
SubDepartment
|
||
|
SyncToken
|
deposits
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The deposits table contains info about deposits in your QuickBooks instance. These can be customer payments or new direct deposits.
|
Id
The deposit ID. |
||||||||||||||
|
CashBack
|
||||||||||||||
|
CurrencyRef
Details about the currency the deposit is in.
|
||||||||||||||
|
DepartmentRef
Details about the department associated with the deposit.
|
||||||||||||||
|
DepositToAccountRef
Details about the account to which the deposit was made.
|
||||||||||||||
|
domain
|
||||||||||||||
|
ExchangeRate
|
||||||||||||||
|
Line
|
||||||||||||||
|
MetaData
|
||||||||||||||
|
PrivateNote
|
||||||||||||||
|
SyncToken
|
||||||||||||||
|
TotalAmt
|
||||||||||||||
|
TxnDate
|
employees
| Replication Method : |
Key-based Incremental |
Replication Key :
|
Metadata.LastUpdatedTime |
|
Primary Key :
|
Id |
API endpoint : |
The employees table contains info about the people working for your company. Note: Both active and inactive employees are included in the data for this table.
|
Id
The employee ID. Reference: |
|||||||||
|
Active
|
|||||||||
|
BillableTime
|
|||||||||
|
BillRate
|
|||||||||
|
BirthDate
|
|||||||||
|
DisplayName
|
|||||||||
|
EmployeeNumber
|
|||||||||
|
FamilyName
|
|||||||||
|
Gender
|
|||||||||
|
GivenName
|
|||||||||
|
HiredDate
|
|||||||||
|
MetaData
|
|||||||||
|
MiddleName
|
|||||||||
|
Mobile
|
|||||||||
|
Organization
|
|||||||||
|
PrimaryAddr
|