User Tools

Site Tools


magento2:extensions:magento-2-quickbooks-online-connector

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
magento2:extensions:magento-2-quickbooks-online-connector [2026/10/08 16:15] – swatwikmagento2:extensions:magento-2-quickbooks-online-connector [2026/10/08 16:20] (current) – swatwik
Line 1: Line 1:
-= Toweringmedia QuickBooks Connector =+====== Toweringmedia QuickBooks Connector ======
  
 User guide for Magento 2 User guide for Magento 2
  
-== Overview ==+===== Overview =====
  
 Toweringmedia QuickBooks Connector connects your Magento 2 store to QuickBooks Online. It helps you move store data into QuickBooks and reduces the need to enter the same information twice. Toweringmedia QuickBooks Connector connects your Magento 2 store to QuickBooks Online. It helps you move store data into QuickBooks and reduces the need to enter the same information twice.
  
-== What this extension does ==+===== What this extension does =====
  
 * '''Customers and products.''' Send customers and products to QuickBooks, or import them into Magento. * '''Customers and products.''' Send customers and products to QuickBooks, or import them into Magento.
Line 19: Line 19:
 This guide covers QuickBooks Online. Full QuickBooks Desktop sync is planned but has not been released. This guide covers QuickBooks Online. Full QuickBooks Desktop sync is planned but has not been released.
  
-== Installation ==+===== Installation =====
  
 Please refer to the installation guide in the following article: [https://toweringmedia.com/installation https://toweringmedia.com/installation] Please refer to the installation guide in the following article: [https://toweringmedia.com/installation https://toweringmedia.com/installation]
Line 25: Line 25:
 Product reference: https://toweringmedia.com/toweringmedia-quickbooks-connector Product reference: https://toweringmedia.com/toweringmedia-quickbooks-connector
  
-== Intuit QuickBooks configuration ==+===== Intuit QuickBooks configuration =====
  
 First, set up your app in the Intuit Developer portal. You will need its Client ID and Client Secret to connect Magento to your QuickBooks company. First, set up your app in the Intuit Developer portal. You will need its Client ID and Client Secret to connect Magento to your QuickBooks company.
Line 37: Line 37:
 You can use an existing workspace for this setup. You can use an existing workspace for this setup.
  
-[[File:30-intuit-create-workspace.png|frameless|900px|Figure 1 Create an Intuit workspace]]+
  
 {{:magento2:extensions:30-intuit-create-workspace.jpg?400|}} {{:magento2:extensions:30-intuit-create-workspace.jpg?400|}}
Line 49: Line 49:
 Click Next and complete Contact info. Use your own company details. Click Next and complete Contact info. Use your own company details.
  
-[[File:31-intuit-company-info.png|frameless|900px|Figure 2 Enter company and contact information]]+
  
 {{:magento2:extensions:31-intuit-company-info.jpg?400|}} {{:magento2:extensions:31-intuit-company-info.jpg?400|}}
Line 63: Line 63:
 Open App Overview to check the app you selected. The app shown here is In Development. Use Get production keys when you are ready to set up live credentials. Open App Overview to check the app you selected. The app shown here is In Development. Use Get production keys when you are ready to set up live credentials.
  
-[[File:24-intuit-app-overview.png|frameless|900px|Figure 3 Select your QuickBooks app]] 
  
 {{:magento2:extensions:24-intuit-app-overview.jpg?400|}} {{:magento2:extensions:24-intuit-app-overview.jpg?400|}}
Line 77: Line 76:
 Development credentials are for testing. In the app settings, register the exact Redirect URL shown in Magento for the same environment. Development credentials are for testing. In the app settings, register the exact Redirect URL shown in Magento for the same environment.
  
-[[File:25-intuit-keys-credentials.png|frameless|900px|Figure 4 Obtain the correct credentials]] 
  
 {{:magento2:extensions:25-intuit-keys-credentials.jpg?400|}} {{:magento2:extensions:25-intuit-keys-credentials.jpg?400|}}
Line 91: Line 89:
 Use the scopes required by the connector and save any changes. Use the scopes required by the connector and save any changes.
  
-[[File:27-intuit-permissions.png|frameless|900px|Figure 5 Review authorization permissions]] 
  
 {{:magento2:extensions:27-intuit-permissions.jpg?400|}} {{:magento2:extensions:27-intuit-permissions.jpg?400|}}
Line 105: Line 102:
 Enter the endpoint, set the verifier token as instructed, select the required events, and save. You do not need to select every event shown in the screenshot. Webhooks and scheduled cron sync are separate. Enter the endpoint, set the verifier token as instructed, select the required events, and save. You do not need to select every event shown in the screenshot. Webhooks and scheduled cron sync are separate.
  
-[[File:26-intuit-webhooks.png|frameless|900px|Figure 6 Review webhook configuration]] 
  
 {{:magento2:extensions:26-intuit-webhooks.jpg?400|}} {{:magento2:extensions:26-intuit-webhooks.jpg?400|}}
Line 117: Line 113:
 Choose a date range under Connection Reports to view connection activity. To check whether a product, customer, or invoice synced, use the Magento operation logs. Choose a date range under Connection Reports to view connection activity. To check whether a product, customer, or invoice synced, use the Magento operation logs.
  
-[[File:28-intuit-analytics.png|frameless|900px|Figure 7 Monitor app connections]] 
  
 {{:magento2:extensions:28-intuit-analytics.jpg?400|}} {{:magento2:extensions:28-intuit-analytics.jpg?400|}}
Line 131: Line 126:
 For sync errors, check the connector logs in Magento. For sync errors, check the connector logs in Magento.
  
-[[File:29-intuit-audit-log.png|frameless|900px|Figure 8 Review changes in the audit log]] 
  
 {{:magento2:extensions:29-intuit-audit-log.jpg?400|}} {{:magento2:extensions:29-intuit-audit-log.jpg?400|}}
Line 186: Line 180:
 '''Log Retention Period.''' Choose how long to keep logs. The screenshot uses 90 days. Click Save Config when finished. '''Log Retention Period.''' Choose how long to keep logs. The screenshot uses 90 days. Click Save Config when finished.
  
-[[File:01-config-general.png|frameless|900px|Figure 9 General settings]] 
  
 {{:magento2:extensions:01-config-general.png?400|}} {{:magento2:extensions:01-config-general.png?400|}}
Line 206: Line 199:
 '''Default Expense Account ID.''' Enter the QuickBooks expense or COGS account ID used when items are created or updated. This is also required when Purchase Cost Mode is percent of sale price. '''Default Expense Account ID.''' Enter the QuickBooks expense or COGS account ID used when items are created or updated. This is also required when Purchase Cost Mode is percent of sale price.
  
-[[File:02-config-quickbooks-online.png|frameless|900px|Figure 10 QuickBooks Online credentials and accounts]] 
  
 {{:magento2:extensions:02-config-quickbooks-online.png?400|}} {{:magento2:extensions:02-config-quickbooks-online.png?400|}}
Line 224: Line 216:
 '''Payment Method Deposit Account Mappings.''' Enter one mapping per line: payment_method_code=quickbooks_deposit_account_id. Use your payment method codes and QuickBooks account IDs. Lines starting with # are comments. '''Payment Method Deposit Account Mappings.''' Enter one mapping per line: payment_method_code=quickbooks_deposit_account_id. Use your payment method codes and QuickBooks account IDs. Lines starting with # are comments.
  
-[[File:02-config-quickbooks-online-2.png|frameless|900px|Figure 11 QuickBooks Online items and authorization]] 
  
 {{:magento2:extensions:02-config-quickbooks-online-2.png?400|}} {{:magento2:extensions:02-config-quickbooks-online-2.png?400|}}
Line 242: Line 233:
 '''Review mappings.''' Check the entries in the Field Mapping grid. Validate the JSON and test a record before using changed mappings on live data. '''Review mappings.''' Check the entries in the Field Mapping grid. Validate the JSON and test a record before using changed mappings on live data.
  
-[[File:03-config-field-mapping.png|frameless|900px|Figure 12 Field mapping]] 
  
 {{:magento2:extensions:03-config-field-mapping.png?400|}} {{:magento2:extensions:03-config-field-mapping.png?400|}}
Line 262: Line 252:
 '''Test invoice.''' Compare line amounts, discounts, shipping, tax, and totals in Magento and QuickBooks before turning on live automation. '''Test invoice.''' Compare line amounts, discounts, shipping, tax, and totals in Magento and QuickBooks before turning on live automation.
  
-[[File:04-config-tax-mapping.png|frameless|900px|Figure 13 Tax mapping]] 
  
 {{:magento2:extensions:04-config-tax-mapping.png?400|}} {{:magento2:extensions:04-config-tax-mapping.png?400|}}
Line 276: Line 265:
 '''Enable QBWC Polling Preparation.''' Leave this set to No for QuickBooks Online. QBWC polling is not implemented in the version shown. '''Enable QBWC Polling Preparation.''' Leave this set to No for QuickBooks Online. QBWC polling is not implemented in the version shown.
  
-[[File:05-config-quickbooks-desktop.png|frameless|900px|Figure 14 QuickBooks Desktop placeholders]] 
  
 {{:magento2:extensions:05-config-quickbooks-desktop.png?400|}} {{:magento2:extensions:05-config-quickbooks-desktop.png?400|}}
Line 294: Line 282:
 '''Magento cron.''' Make sure cron is running on the server. Set the interval and batch size to suit your store. '''Magento cron.''' Make sure cron is running on the server. Set the interval and batch size to suit your store.
  
-[[File:06-config-sync-schedule.png|frameless|900px|Figure 15 Cron dispatch timing and limits]] 
  
 {{:magento2:extensions:06-config-sync-schedule.png?400|}} {{:magento2:extensions:06-config-sync-schedule.png?400|}}
Line 308: Line 295:
 '''Enable the tasks you need.''' Check the matching export and Auto-Sync settings as well. Customer and product imports have their own settings under Inbound Import. '''Enable the tasks you need.''' Check the matching export and Auto-Sync settings as well. Customer and product imports have their own settings under Inbound Import.
  
-[[File:06-config-sync-schedule-2.png|frameless|900px|Figure 16 Cron dispatch by entity]] 
  
 {{:magento2:extensions:06-config-sync-schedule-2.png?400|}} {{:magento2:extensions:06-config-sync-schedule-2.png?400|}}
Line 324: Line 310:
 '''Export-only setup.''' Leave imports disabled if you only want to send data from Magento to QuickBooks. Import settings are separate from exports and cron dispatch. '''Export-only setup.''' Leave imports disabled if you only want to send data from Magento to QuickBooks. Import settings are separate from exports and cron dispatch.
  
-[[File:07-config-inbound-import.png|frameless|900px|Figure 17 Inbound import]] 
  
 {{:magento2:extensions:07-config-inbound-import.png?400|}} {{:magento2:extensions:07-config-inbound-import.png?400|}}
Line 342: Line 327:
 '''Sync direction.''' Entity Sync controls Magento exports. Customer and product imports from QuickBooks are configured under Inbound Import. '''Sync direction.''' Entity Sync controls Magento exports. Customer and product imports from QuickBooks are configured under Inbound Import.
  
-[[File:08-config-entity-sync.png|frameless|900px|Figure 18 Product inventory and customer exports]] 
  
 {{:magento2:extensions:08-config-entity-sync.png?400|}} {{:magento2:extensions:08-config-entity-sync.png?400|}}
Line 358: Line 342:
 '''Sync on save.''' Auto-Sync Customers on Save and Auto-Sync Products on Save add tasks to the queue when records are saved. Product saves are ignored in Sold-only mode. '''Sync on save.''' Auto-Sync Customers on Save and Auto-Sync Products on Save add tasks to the queue when records are saved. Product saves are ignored in Sold-only mode.
  
-[[File:08-config-entity-sync-2.png|frameless|900px|Figure 19 Invoice customers and sales exports]] 
  
 {{:magento2:extensions:08-config-entity-sync-2.png?400|}} {{:magento2:extensions:08-config-entity-sync-2.png?400|}}
Line 378: Line 361:
 '''Process the queue.''' Enable the Auto-Sync triggers you need, the matching exports, and cron dispatch. '''Process the queue.''' Enable the Auto-Sync triggers you need, the matching exports, and cron dispatch.
  
-[[File:08-config-entity-sync-3.png|frameless|900px|Figure 20 Automatic synchronization triggers]] 
  
 {{:magento2:extensions:08-config-entity-sync-3.png?400|}} {{:magento2:extensions:08-config-entity-sync-3.png?400|}}
Line 396: Line 378:
 '''Screenshot settings.''' Many export and Auto-Sync switches are disabled in the examples. Set them for your own workflow. '''Screenshot settings.''' Many export and Auto-Sync switches are disabled in the examples. Set them for your own workflow.
  
-[[File:08-config-entity-sync-4.png|frameless|900px|Figure 21 Save and verify the configuration]] 
  
 {{:magento2:extensions:08-config-entity-sync-4.png?400|}} {{:magento2:extensions:08-config-entity-sync-4.png?400|}}
Line 414: Line 395:
 Use Filters and Columns to find the task you need. If the queue is empty, check Sync Operation Logs for the result. Use Filters and Columns to find the task you need. If the queue is empty, check Sync Operation Logs for the result.
  
-[[File:09-pending-sync-queue.png|frameless|900px|Figure 22 Pending Sync Queue]] 
  
 {{:magento2:extensions:09-pending-sync-queue.png?400|}} {{:magento2:extensions:09-pending-sync-queue.png?400|}}
Line 430: Line 410:
 Find the operation and read Error Code and Error Message. Fix the cause before using the Retry mass action for a failed task. The grid also shows status, retry count, direction, entity, operation/profile IDs, and dates. Find the operation and read Error Code and Error Message. Fix the cause before using the Retry mass action for a failed task. The grid also shows status, retry count, direction, entity, operation/profile IDs, and dates.
  
-[[File:10-sync-operation-logs.png|frameless|900px|Figure 23 Sync Operation Logs]] 
  
 {{:magento2:extensions:10-sync-operation-logs.png?400|}} {{:magento2:extensions:10-sync-operation-logs.png?400|}}
Line 446: Line 425:
 Compare the Magento and QuickBooks records before resolving the conflict. The screenshot shows an empty list. Compare the Magento and QuickBooks records before resolving the conflict. The screenshot shows an empty list.
  
-[[File:11-conflict-review.png|frameless|900px|Figure 24 Conflict Review]] 
  
 {{:magento2:extensions:11-conflict-review.png?400|}} {{:magento2:extensions:11-conflict-review.png?400|}}
Line 460: Line 438:
 Click Edit Mappings to update Customer, Product, or Invoice Line JSON mappings. See the Field mapping instructions under Magento Admin configuration for the format. Click Edit Mappings to update Customer, Product, or Invoice Line JSON mappings. See the Field mapping instructions under Magento Admin configuration for the format.
  
-[[File:12-field-mapping.png|frameless|900px|Figure 25 Field Mapping grid]] 
  
 {{:magento2:extensions:12-field-mapping.png?400|}} {{:magento2:extensions:12-field-mapping.png?400|}}
Line 474: Line 451:
 Click Add New Rule to create a rule. If you use several rules, test how they work together. Click Add New Rule to create a rule. If you use several rules, test how they work together.
  
-[[File:13-sync-rules.png|frameless|900px|Figure 26 Sync Rules list]] 
  
 {{:magento2:extensions:13-sync-rules.png?400|}} {{:magento2:extensions:13-sync-rules.png?400|}}
Line 490: Line 466:
 Expand Conditions and set your criteria. Click Save, or Save and Continue Edit if you want to keep editing. Click Back to return to the list. Expand Conditions and set your criteria. Click Save, or Save and Continue Edit if you want to keep editing. Click Back to return to the list.
  
-[[File:14-sync-rule-new.png|frameless|900px|Figure 27 Create a sync rule]] 
  
 {{:magento2:extensions:14-sync-rule-new.png?400|}} {{:magento2:extensions:14-sync-rule-new.png?400|}}
Line 506: Line 481:
 For example, you could match Complete orders within a specific total range and customer group. Save the rule and test records that should match, as well as records that should not. For example, you could match Complete orders within a specific total range and customer group. Save the rule and test records that should match, as well as records that should not.
  
-[[File:14-sync-rule-conditions.png|frameless|900px|Figure 28 Set sync rule conditions]] 
  
 {{:magento2:extensions:14-sync-rule-conditions.png?400|}} {{:magento2:extensions:14-sync-rule-conditions.png?400|}}
Line 522: Line 496:
 Inactive records are not imported. Imported records that disappear from the active QuickBooks list are marked inactive and hidden from dropdowns. Products already using their IDs keep a fallback option so saving the product does not clear the value. Inactive records are not imported. Imported records that disappear from the active QuickBooks list are marked inactive and hidden from dropdowns. Products already using their IDs keep a fallback option so saving the product does not clear the value.
  
-[[File:15-class-vendor-lists.png|frameless|900px|Figure 29 Class and preferred vendor lists]] 
  
 {{:magento2:extensions:15-class-vendor-lists.png?400|}} {{:magento2:extensions:15-class-vendor-lists.png?400|}}
Line 538: Line 511:
 Before syncing, check Enable Product Export and the product export strategy. Before syncing, check Enable Product Export and the product export strategy.
  
-[[File:17-product-grid-actions.png|frameless|900px|Figure 30 Bulk product synchronization]] 
  
 {{:magento2:extensions:17-product-grid-actions.png?400|}} {{:magento2:extensions:17-product-grid-actions.png?400|}}
Line 554: Line 526:
 The button is shown on the product edit page. Fields from Magento or other extensions are not connector settings. The button is shown on the product edit page. Fields from Magento or other extensions are not connector settings.
  
-[[File:18-product-edit-sync.png|frameless|900px|Figure 31 Synchronize a single product]] 
  
 {{:magento2:extensions:18-product-edit-sync.png?400|}} {{:magento2:extensions:18-product-edit-sync.png?400|}}
Line 568: Line 539:
 This screenshot shows the error under a loading overlay; QuickBooks product attributes are not visible. This screenshot shows the error under a loading overlay; QuickBooks product attributes are not visible.
  
-[[File:19-product-quickbooks-attributes.png|frameless|900px|Figure 32 Disabled connector message]] 
  
 {{:magento2:extensions:19-product-quickbooks-attributes.png?400|}} {{:magento2:extensions:19-product-quickbooks-attributes.png?400|}}
Line 584: Line 554:
 Before syncing, check Enable Customer Export and the customer field mappings. Before syncing, check Enable Customer Export and the customer field mappings.
  
-[[File:20-customer-grid-actions.png|frameless|900px|Figure 33 Bulk customer synchronization]] 
  
 {{:magento2:extensions:20-customer-grid-actions.png?400|}} {{:magento2:extensions:20-customer-grid-actions.png?400|}}
Line 600: Line 569:
 The screenshot shows the button while the page is loading. Check the logs to confirm whether the request finished. The screenshot shows the button while the page is loading. Check the logs to confirm whether the request finished.
  
-[[File:21-customer-edit-sync.png|frameless|900px|Figure 34 Synchronize a single customer]] 
  
 {{:magento2:extensions:21-customer-edit-sync.png?400|}} {{:magento2:extensions:21-customer-edit-sync.png?400|}}
Line 616: Line 584:
 Check the admin message and logs for errors, then confirm the invoice in QuickBooks. Check the admin message and logs for errors, then confirm the invoice in QuickBooks.
  
-[[File:22-order-grid-actions.png|frameless|900px|Figure 35 Bulk invoice synchronization from orders]] 
  
 {{:magento2:extensions:22-order-grid-actions.png?400|}} {{:magento2:extensions:22-order-grid-actions.png?400|}}
Line 632: Line 599:
 The screenshot shows a Pending order. Check the response to see whether it is eligible to sync. Magento’s Invoice button creates a Magento invoice; Sync Invoice to QuickBooks requests a transfer to QuickBooks. The screenshot shows a Pending order. Check the response to see whether it is eligible to sync. Magento’s Invoice button creates a Magento invoice; Sync Invoice to QuickBooks requests a transfer to QuickBooks.
  
-[[File:23-order-view-sync.png|frameless|900px|Figure 36 Invoice synchronization from an order]] 
  
 {{:magento2:extensions:23-order-view-sync.png?400|}} {{:magento2:extensions:23-order-view-sync.png?400|}}
magento2/extensions/magento-2-quickbooks-online-connector.1791476116.txt.gz · Last modified: by swatwik