Overview
The Lyftron Provider for QuickBooks offers the most natural way to access QuickBooks data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing QuickBooks data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s QuickBooks data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to QuickBooks.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for QuickBooks, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your QuickBooks connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click QuickBooks for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish QuickBooks connection with Lyftron.
'User=[your_user];Password=[your_password];URL=[your_url];'Key | Value | Field |
Connection Name | Enter your connection details | Required |
user | YourQuickBooks user | Required |
password | Your QuickBooks password | Required |
URL | Your QuickBooks URL | Required |
Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron QuickBooks connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The Lyftron Provider for QuickBooks models entities in the QuickBooks API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.
API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
Tables
The Lyftron Provider for QuickBooks models Item Listings in tables so that they can be easily queried, updated, and deleted. You can list items on your QuickBooks store by calling the AddItem stored procedure.
Views
Views are tables that cannot be modified. Typically, read-only data are shown as views.
Name | Type | Description |
Accounts | Tables | Create, update, delete, and query QuickBooks Accounts. To update Accounts, set the QBXMLVersion to 6.0 or higher. |
ARCreditCardRefunds | Tables | Query and Insert QuickBooks AR Credit Card Refund transactions. |
BillExpenseItems | Tables | Create, update, delete, and query QuickBooks Bill Expense Line Items. |
BillLineItems | Tables | Create, update, delete, and query QuickBooks Bill Line Items. |
BillPaymentChecks | Tables | Create, update, delete, and query QuickBooks Bill Payment Checks. QBXMLVersion must be set to 6.0 or higher to update a BillPaymentCheck. |
BillPaymentChecksAppliedTo | Tables | Create, update, delete, and query QuickBooks Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied. |
BillPaymentCreditCards | Tables | Create, update, delete, and query QuickBooks Bill Payments. |
BillPaymentCreditCardsAppliedTo | Tables | Create, update, delete, and query QuickBooks Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied. |
Bills | Tables | Create, update, delete, and query QuickBooks Bills. |
BuildAssemblies | Tables | Insert, Update, delete, and query QuickBooks Build Assembly transactions. |
BuildAssemblyLineItems | Tables | Create and query QuickBooks Build Assembly transactions. |
CheckExpenseItems | Tables | Create, update, delete, and query QuickBooks Check Expense Line Items. |
CheckLineItems | Tables | Create, update, delete, and query QuickBooks Check Line Items. |
Checks | Tables | Create, update, delete, and query QuickBooks Checks. |
Class | Tables | Create, update, delete, and query QuickBooks Classes. QuickBooks requires QBXML version 8.0 or higher for updates to a Class. |
CreditCardChargeExpenseItems | Tables | Create, update, delete, and query QuickBooks Credit Card Charge Expense Line Items. |
CreditCardChargeLineItems | Tables | Create, update, delete, and query QuickBooks Credit Card Charge Line Items. |
CreditCardCharges | Tables | Create, update, delete, and query QuickBooks Credit Card Charges. |
CreditCardCreditExpenseItems | Tables | Create, update, delete, and query QuickBooks Credit Card Credit Expense Line Items. |
CreditCardCreditLineItems | Tables | Create, update, delete, and query QuickBooks Credit Card Credit Line Items. |
CreditCardCredits | Tables | Create, update, delete, and query QuickBooks Credit Card Credits. |
CreditMemoLineItems | Tables | Create, update, delete, and query QuickBooks Credit Memo Line Items. |
CreditMemos | Tables | Create, update, delete, and query QuickBooks Credit Memos. |
Currency | Tables | Create, update, delete, and query QuickBooks Currencies. This table requires QBXML version 8.0 or higher, and you will need to enable multiple Currencies in your QuickBooks company file to use it. |
CustomerContacts | Tables | Create, update, delete, and query QuickBooks Customer Contacts. This table requires QBXML version 12.0 or higher, and is only available in QuickBooks editions 2016 and above. |
CustomerMessages | Tables | Create, delete, and query Customer Messages. |
CustomerNotes | Tables | Create, update, and query QuickBooks Customer Notes. This table requires QBXML version 12.0 or higher. |
Customers | Tables | Create, update, delete, and query QuickBooks Customers. |
CustomerShippingAddresses | Tables | Create, update, delete, and query QuickBooks Customer Shipping Addresses. Multiple Customer Shipping Addresses are supported in only QuickBooks 2013 and higher. Additionally, this table requires QBXML version 12.0 or higher. |
CustomerTypes | Tables | Create, update, delete, and query QuickBooks Customer Types. |
DateDrivenTerms | Tables | Create, delete, and query QuickBooks Date Driven Terms. |
DepositLineItems | Tables | Create, update, delete, and query QuickBooks Deposit Line Items. QBXMLVersion must be set to 7.0 or higher to update a deposit. |
Deposits | Tables | Create, update, delete, and query QuickBooks Deposits. QBXMLVersion must be set to 7.0 or higher to update a deposit. |
EmployeeEarnings | Tables | Create, update, delete, and query QuickBooks Employee Earnings. |
Employees | Tables | Create, update, delete, and query QuickBooks Employees. |
EstimateLineItems | Tables | Create, update, delete, and query QuickBooks Estimate Line Items. |
Estimates | Tables | Create, update, delete, and query QuickBooks Estimates. |
InventoryAdjustmentLineItems | Tables | Create and query QuickBooks Inventory Adjustment Line Items. |
InventoryAdjustments | Tables | Create, query, and delete QuickBooks Inventory Adjustments. |
InventorySites | Tables | Create, update, delete, and query QuickBooks Inventory Sites. Inventory Sites are only available in QuickBooks Enterprise 2010 and above, and only with the Advanced Inventory add-on. |
InvoiceLineItems | Tables | Create, update, delete, and query QuickBooks Invoice Line Items. |
Invoices | Tables | Create, update, delete, and query QuickBooks Invoices. |
ItemLineItems | Tables | Create, update, delete, and query QuickBooks Item Line Items. |
ItemReceiptExpenseItems | Tables | Create, update, delete, and query QuickBooks Item Receipt Expense Line Items. |
ItemReceiptLineItems | Tables | Create, update, delete, and query QuickBooks Item Receipt Line Items. |
ItemReceipts | Tables | Create, update, delete, and query QuickBooks Item Receipts. |
Items | Tables | Create, update, delete, and query QuickBooks Items. |
JobTypes | Tables | Create and query QuickBooks JobTypes. |
JournalEntries | Tables | Create, update, delete, and query QuickBooks Journal Entries. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry. |
JournalEntryLines | Tables | Create, update, delete, and query QuickBooks Journal Entries. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry. |
OtherNames | Tables | Create, update, delete, and query QuickBooks Other Name entities. |
PaymentMethods | Tables | Create, update, delete, and query QuickBooks Payment Methods. |
PayrollNonWageItems | Tables | Query QuickBooks Non-Wage Payroll Items. |
PayrollWageItems | Tables | Create and query QuickBooks Wage Payroll Items. |
PriceLevelPerItem | Tables | Create and query QuickBooks Price Levels Per Item. Only QuickBooks Premier and Enterprise support Per-Item Price Levels. Note that while Price Levels can be added from this table, you may only add Per-Item Price Levels from this table. Price Levels may be deleted from the PriceLevels table. This table requires QBXML version 4.0 or later. |
PriceLevels | Tables | Create, delete, and query QuickBooks Price Levels. Note that while Price Levels can be added and deleted from this table, you may add only fixed-percentage Price Levels from this table. Per-Item Price Levels may be added via the PriceLevelPerItem table. This table requires QBXML version 4.0 or higher. |
PurchaseOrderLineItems | Tables | Create, update, delete, and query QuickBooks Purchase Order Line Items. |
PurchaseOrders | Tables | Create, update, delete, and query QuickBooks Purchase Orders. |
ReceivePayments | Tables | Create, update, delete, and query QuickBooks Receive Payment transactions. QBXMLVersion must be set to 6.0 or higher to update a ReceivePayment. |
ReceivePaymentsAppliedTo | Tables | Create, update, and query QuickBooks Receive Payment AppliedTo aggregates. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied. QBXMLVersion must be set to 6.0 or higher to update a ReceivePayment. |
SalesOrderLineItems | Tables | Create, update, delete, and query QuickBooks Sales Order Line Items. |
SalesOrders | Tables | Create, update, delete, and query QuickBooks Sales Orders. |
SalesReceiptLineItems | Tables | Create, update, delete, and query QuickBooks Sales Receipt Line Items. |
SalesReceipts | Tables | Create, update, delete, and query QuickBooks Sales Receipts. |
SalesReps | Tables | Create, update, delete, and query QuickBooks Sales Rep entities. |
SalesTaxCodes | Tables | Create, update, delete, and query QuickBooks Sales Tax Codes. |
SalesTaxItems | Tables | Create, update, delete, and query QuickBooks Sales Tax Items. |
ShippingMethods | Tables | Create, update, delete, and query QuickBooks Shipping Methods. |
StandardTerms | Tables | Create, update, delete, and query QuickBooks Standard Terms. |
StatementCharges | Tables | Create, update, delete, and query QuickBooks Statement Charges. |
TimeTracking | Tables | Create, update, delete, and query QuickBooks Time Tracking events. |
ToDo | Tables | Create, update, delete, and query QuickBooks To Do entries. |
TransferInventory | Tables | Query and delete QuickBooks Transfer Inventory transactions. Transfer Inventory is available in only QuickBooks Enterprise 2010 and above, and only with the Advanced Inventory add-on. |
TransferInventoryLineItems | Tables | Create and query QuickBooks Transfer Inventory Line Items. Transfer Inventory is available in only QuickBooks Enterprise 2010 and above, and only with the Advanced Inventory add-on. |
Transfers | Tables | Create, update, and query QuickBooks transfers. Requires QBXML version 12.0 or higher. |
UnitOfMeasure | Tables | Create, update, delete, and query QuickBooks units of measure. QuickBooks requires QBXML version 7.0 or higher to use this table. |
UnitOfMeasureDefaultUnits | Tables | Create and query QuickBooks unit-of-measure default units. QuickBooks requires QBXML version 7.0 or higher to use this table. |
UnitOfMeasureRelatedUnits | Tables | Create and query QuickBooks unit-of-measure related units. QuickBooks requires QBXML version 7.0 or higher to use this table. |
VehicleMileage | Tables | Create, update, delete, and query QuickBooks Vehicle Mileage entities. QuickBooks requires QBXML version 6.0 or higher to use this table. |
VendorCreditExpenseItems | Tables | Create, update, delete, and query QuickBooks Vendor Credit Expense Line Items. |
VendorCreditLineItems | Tables | Create, update, delete, and query QuickBooks Vendor Credit Line Items. |
VendorCredits | Tables | Create, update, delete, and query QuickBooks Vendor Credits. |
Vendors | Tables | Create, update, delete, and query QuickBooks Vendors. |
VendorTypes | Tables | Create, update, delete, and query QuickBooks Vendor Types. |
WorkersCompCodeLines | Tables | Query QuickBooks Workers Comp Code entries by line. Requires QBXML Version 7.0 or higher. |
WorkersCompCodes | Tables | Query QuickBooks Workers Comp Code entries. Requires QBXML Version 7.0 or higher |
BalanceSheetDetail | Views | Balance Sheet Detail Report. |
BalanceSheetStandard | Views | Balance Sheet Standard Report. |
BalanceSheetSummary | Views | Balance Sheet Summary Report. |
BillLinkedTransactions | Views | Query QuickBooks Bill Linked Transactions. |
CompanyInfo | Views | Query the company information from QuickBooks. |
CreditMemoLinkedTransactions | Views | Query QuickBooks Credit Memo Linked Transactions. |
CustomColumns | Views | Query QuickBooks Custom Columns. |
DeletedEntities | Views | Query deleted Entities. |
DeletedTransactions | Views | Query deleted Transactions. |
EstimateLinkedTransactions | Views | Query QuickBooks Estimate Linked transactions. |
Host | Views | Query the QuickBooks host process. The Host represents information about the QuickBooks process currently being executed. |
InvoiceLinkedTransactions | Views | Query QuickBooks Invoice Linked Transactions. |
ItemReceiptLinkedTransactions | Views | Query QuickBooks Item Receipt Linked Transactions. |
ItemSites | Views | Create, update, delete, and query QuickBooks Item Sites. Item sites are only available in QuickBooks Enterprise 2010 and above, and only with the Advanced Inventory add-on. This table requires a minimum of QBXML version 10.0. |
Preferences | Views | Query information about many of the preferences the QuickBooks user has set in the company file. |
PurchaseOrderLinkedTransactions | Views | Query QuickBooks Purchase Order Linked Transactions. |
SalesOrderLinkedTransactions | Views | Query QuickBooks Sales Order Linked Transactions. |
StatementChargeLinkedTransactions | Views | Query QuickBooks Statement Charge Linked Transactions. |
Templates | Views | Query QuickBooks templates. |
Transactions | Views | Query QuickBooks transactions. You may search the Transactions using a number of values including Type, Entity, Account, ReferenceNumber, Item, Class, Date, and TimeModified. |
VendorCreditLinkedTransactions | Views | Query QuickBooks Vendor Credit Linked Transactions. |
Advanced Settings
To view a detailed advanced settings options, go to QuickBooks Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.