Reading list Switch to dark mode

    Magento 2 QuickBooks Connector

    Updated 31 October 2023

    Using the Magento 2 ( Adobe Commerce) QuickBooks Connector you can create sales receipts for your store orders on the QuickBooks – Manually or Automatically.

    Therefore, all the information that is related to the orders such as customer name, email address, items ordered, billing address, etc gets synchronized with your QuickBooks account.

    Please Note:

    1. You need to create API credentials – Client ID and Client Secret.
    2. At the moment this extension supports one-way synchronization from Magento 2 to QuickBooks.
    3. Magento 2 QuickBooks is fully compatible with QuickBooks Online and Adobe Commerce Cloud.

    Features Of QuickBooks Connector

    • One can place Auto-Sync Orders from the Magento 2 Store to the QuickBooks.
    • The admin can manually synchronize the Magento 2 store – Orders.
    • Select when to create Sales Receipt in QuickBooks – Order Place, Invoice Create, or Order Complete.
    • Select which orders to sync with QuickBooks – Pending, Processing, or Complete.
    • The admin can set the QB product name & description to get export as per the name, SKU, short or long description respectively.
    • The QuickBooks sales receipt number is the same as Magento 2 order/invoice number.
    • Sync customer name, email, billing address, order date, product name, quantity, rate, amount.
    • The extension helps in Syncing the TAX details to QuickBooks with orders.
    • Sync the already placed orders within your store that were not synced with QuickBooks before as well.
    • Appealing Export orders in the process window with a detailed execution message with the number of orders to synchronize.
    • The sales receipt of the Magento 2 order is exported to QuickBooks with a payment method description.
    • The admin can also check the automatically or manually exported credit memos.
    • Downloadable products are created as Non-Inventory products in QuickBooks.
    • Sync Guest and Customer orders from Adobe Commerce to QuickBooks.

    Installation

    Firstly, customers get a zip folder. Then they have to extract the contents of this zip folder on their system. The extracted folder is having an src folder, inside the src folder you have the app folder.

    Further, you need to transfer this app folder into the Magento2 root directory on the server as shown below.INSTALLATION

    Searching for an experienced
    Magento 2 Company ?
    Find out More

    After that, you have to run these commands in the Magento2 root directory.

    First command – 

    composer require quickbooks/v3-php-sdk:5.0.5

    Second command – 

    php bin/magento setup:upgrade

    Third Command –  

    php bin/magento setup:di:compile

    Fourth Command – 

    php bin/magento setup:static-content:deploy

    Fifth Command – 

    php bin/magento indexer:reindex

    On completing the running commands, you have to flush the cache from the Adobe Commerce admin panel by navigating through System -> Cache management as shown below.INSTALLATION

    Multi-Lingual Configuration of Adobe Commerce

    For Multilingual support, please navigate to Store>Configuration>General >Locale Options. And select your desired language from the Locale option.change language-magento 2 locale

    Language Translation

    In order, to translate the module language, navigate through app/code/Webkul/QuickbooksConnect/i18n, and edit the en_US.csv file.

    Thereafter, rename the CSV as “en_SA.csv” and translate all right side content after the comma in the Arabic language. After editing the CSV, save it.

    Then upload it to the path app/code/Webkul/QuickbooksConnect/i18n where the Magento2 is installed on the server.

    The module gets translated into the Arabic Language. It supports both RTL and LTR languages.webkul-magento2-paytabs-sadad-payment-multilingual

    How to get QuickBooks API Credentials – OAuth2

    For OAuth2:

    1. In order, to get the Client Id and Client Secret for the OAuth2 authentication navigate to Intuit Developer Homepage.
    2. Now, create a new account even if you already have an account by clicking the SignUp buttonIntuit-Developer.
    3. Now, enter the details required for registration and then click the “Create Account” option on the registration page.
      Intuit-Accounts-Sign-Up-1
    4. Further, the user will receive the 6-digit verification code sent to the entered mobile number. Intuit-Accounts-Sign-Up-2
    5. On clicking the Continue button, your account gets created on QuickBooks. The user will land on the QuickBook Homepage as shown in the image below:Intuit-Developer-homepage
    6. After that, the user will navigate to Dashboard > Create an App as shown in the image below:My-Dashboard-1
    7. Further, the user will see a page that is having an option as QuickBooks Online and Payments, Click on it to process further.Create-App8. After clicking on the same, the user will get to see the following page. Here, the user will enter the Name of the application. Then select a Scope from the Accounting or Payments option. Create-App-2
      9. After that, go to the “Keys & OAuth” menu option to find your – Client ID and Client SecretKeys-110. Copy these keys from QuickBook Connector’s end and paste them into the Magento configuration while using the OAuth2.

    Note:
    1. You must set the redirect URL. To set the redirect URL click the Add URL link, enter the redirect URL, and click the save button after that.

    As shown below, example.com is your site URL.

    https:/example.com/quickbooksconnect/oauth/oauth2

    Keys-redirect-url

    2. If you are using the application in the sandbox mode then you can make use of Development keys.

    But if you are using the application in the Live mode then you can make use of the Production keys.

    Configuration

    Finally, after the successful installation of the Adobe Commerce 2 QuickBooks Connector, you can see the configuration panel under Store -> Configuration -> Webkul -> Magento QuickBooks Connect.

    Configuration-Settings-Stores-Magento-Admin-2

    General Settings:-

    • Enable: From here the admin can enable or disable the module.
    • Sales Receipt Create on Quickbooks: Select one of the options from – Order place, Invoice Create, or Order Complete to automatically generate the receipts in QuickBooks.
    • Initial Order Status for Sales Receipt: Select one of the options from – Pending, Processing, and Complete.

    To set the order statuses that should be synchronized with the QuickBooks when synchronizing manually to create the sales receipt on QuickBooks.

    • Is US Store: Select ” Yes” If you are using a USA QuickBooks account else ” No”
    • App Integration With Select the OAuth Authorization type as – OAuth 2.0 or OAuth 1.0
    • Select the Account Type as – Development or Production as required.
    • Enter the Client Id and Client Secret.

    After setting up the general settings the admin needs to save the configuration then tap on the option “Connect“.

    Set Up Extension To Connect With QuickBooks

    For instance, you can see a window pop up from where you select the company to set up with Magento 2 & then click on the Next button.

    Screenshot-from-2019-12-31-15-19-49

    On the next screen to authorize the Magento module with the QuickBooks app.

    Click on the Connect button to allow Magento 2 Connect to view and update your QuickBooks Online data

    Screenshot-from-2019-12-31-15-29-13

    Now after clicking on the connect button on the next screen, a pop-up appears with an account successfully authorize message & notification to refresh the window.

    Screenshot-from-2019-12-31-15-23-00

    Finally, you get redirected back to the admin configuration settings for the module.

    Afterward, refresh the page and you find that you are now connected and authorized as per the below screenshot.

    Also, after the authorization process, a disconnect button appears whose work is to disconnect the connection between the extension & QuickBooks if clicked.

    webkul-magento2-quickbook-connector-admin-configuration-general-settings

    Accounts For Inventory

    webkul-magento2-quickbook-connector-admin-configuration-inventory-settings

    Inventory Other Asset Account

    Now from here select the account for the products created in QuickBooks.

    The selection made here for the asset account gets to reflect on product information in QuickBooks.

    It’s an account to which a product belongs so that it allows for easy management at a later time.

    Income Account

    Select the account for the products created in QuickBooks. The selection made here for the income account gets to reflect on product information in QuickBooks.

    It’s an account to which a product belongs so that it allows for easy management at a later time.

    Expense Account

    Here, select the account for the products created in QuickBooks. The selection made here for the expense account gets to reflect on product information in QuickBooks.

    It’s an account to which a product belongs so that it allows for easy management at a later time.

    Export Product Field

    webkul-magento2-quickbook-connector-admin-configuration-export-product-field

    From here the admin can set:-

    • The QB Product Name which gets export to QuickBooks end as per the options available as Store Product SKU or Store Product Name.
    • QB Product Description which gets export to QuickBooks end as per the options available as Store Product Name, Store Product Description, or Store Product Short Description.

    Notification for Sync the Tax Rates

    webkul-magento2-quickbook-connector-admin-configuration-notiofications

    The admin needs to create the same tax rates on Quickbooks end to sync tax details with orders.

    You can add a different name of the tax rate but the tax rate must be the same on Quickbooks as well.

    How to Synchronize Orders Manually & automatically

    Sale Receipt Created Automatically

    In the case of automatic synchronization, it depends on what the admin has selected in the module configuration settings.

    If the admin selects the option of “Sales Receipt Create On QuickBooks” as “Order Place“, then all the orders when placed in your store get synchronized with the QuickBooks automatically.

    Similarly, if the admin selects – “Invoice Create” then when the admin creates the invoice for the orders, the orders get synchronized automatically.

    The same is the case if the admin selects -“Order Complete” the orders get synchronized with the QuickBooks when the status of the order turns to “Order Complete” i.e invoice and shipping have been generated.

    For Example:

    If the admin has selected the option “Sales Receipt Create On QuickBooks” as “Order Place“.

    Then whenever an order gets a place on your store, be it a guest or a registered user it will automatically get synchronized with your QuickBooks account.

    Sale Receipt Created Manually

    Using the manual sync, you can also sync the already placed orders within your store that were not synced with QuickBooks before as well.

    To add the orders in QuickBooks manually, the admin needs to navigate to the Sales -> Orders.

    On the Orders page, the admin finds the complete list in a grid view of Orders placed on the Website with different order statuses like pending, closed, etc.

    Screenshot-5

    Now to manually synchronize this data, the admin selects the desired order, tap on the Action option, and select the Export on QB option.

    At this time all the orders that are selected get synchronized with QuickBooks.

    Orders-Operations-Sales-Magento-Admin-1-1

    After clicking the “Export on QB option you see an execution message with the number of orders to synchronize.

    Screenshot-6

    The admin finds the Map Sales Receipt, MapCredit Memo, and Configuration, under the menu item QuickBooks Connect, under the admin panel as per the screenshot below.

    webkul-magento2-quickbook-connector-admin-connect-options

    By clicking on the “Configuration” menu option, the admin redirects to the same QuickBooks configuration page. Similarly as shown above.

    After clicking the menu option – “Map Sales Receipt“, you’ll see a complete list of synced/Map orders of your store with the QuickBooks as shown below in the snapshot.

    Map Sales Receipt

    webkul-magento2-quickbook-connector-admin-nap-sales-receipt

    Using the map sales receipt, you can sync the already placed orders within your store that were placed before installing the extension as well.

    The admin can also delete the Order Map Record if required.

    To check the order details for any particular order just click on the View Order link.

    Manual Synchronize Of Data

    Now to manually synchronize this data, you will tap on the option “Export Orders as Sales Receipt “.

    At this time all the orders that have the status (As selected during configuration) will get synchronized with the QuickBooks.

    Also, you can change the settings in the module back-end if you want to choose a different order status to be synchronized.

    You can select from three order statuses – PendingProcessing, and Complete.

    If you select pending status then all the orders with the status “Pending” will get synchronized. Similar is the case with the other two statuses.

    After clicking the “Export Orders As Sales Receipt” option you see an execution message with the number of orders to synchronize.

    How to Synchronize Orders Manually & automatically

    Check The Order Details:

    In order, to check the order details navigate to QuickBooks Connect-> Map Sales Receipt.

    Now, tap on the “View Order” link for the respective order for which you want to check the order details.

    Tap the “View Order” link, the order details will appear as shown below.

    sales_receipt_m_11

    sales_receipt_m_12

    sales_receipt_m_13

    Check the Synchronized Order Details on QuickBooks

    Go to your QuickBooks account and navigate to the Sales section and then tap the same order number.

    sales_transactions

    Tap on the Order Number, you can see the complete order details that are synchronized as shown below in the snapshot.

    sales_receipt_qb_1

    sales_receipt_qb2

    At Quickbooks online go to the products and services tab under the sales menu.

    products_and_services

    After clicking the Edit link for a product, you can see the various accounts that are related to this product under the product/service information section as per the snapshot below.

    products_and_services__edit

    How to add Tax rates in QuickBooks?

    First, you need to click on the Taxes option as shown below image –

    Sales-tax-1

    Further, click on the Sales Tax Settings option to check the details of the Tax Agencies.

    Sales-tax-1-1

    By clicking on the Add Agency button the user will be able to add the new agency. Also, they will provide the information shown in the image below:

    Sales-tax-2

    Moreover, click on the “Edit” button present under the Action grid for the respective agency to edit the details:sales_tax_agency_edit

    Further, the user can add new custom rates and edit/ deactivate already created tax rates. Click on Add rate for adding the new custom rate.

    Sales-tax-3

    After that, add the details for the new customs rate as shown in the image below:

    Sales-tax-4

    Moreover, click on the “Edit” button present under the Action grid for the respective custom rate to edit the details:

    edit_custom_rates

    1. How it works with the special prices?

    Special Price: For example, you have a product for $30, that has a special price applicable of $20.

    Now, when the order gets purchased and the sales receipt created at QuickBooks end the receipt has $20 visible on the receipt of the product.

    2. How it sync payment methods?

    The payment methods which is used at the store end for making the payment, that gets reflected.

    3. Does it creates sales receipts for bundle products?

    However, for the bundle product, all of the constituent products are created as individual products within the sales receipt.

    Map Credit Memo

    The Map Credit Memo lists down all the credit memos generated by the admin. The credit memo gets exported automatically as per the configuration.

    Below is the list available for all such credit memos.

    Map-Credit-Memo-Magento-Admin-1

    The admin can also view the memo and check the details as shown in the image below:

    magento-end-credit-memo-1

    magento-end-credit-memo-2

    Credit Memo at QuickBook’s End

    The same will be visible at QuickBook’s end and the type of that specific entry will be Credit Memo as shown in the image below:

    credit-memo

    Here also the user can view the credit memo with their specific ID. All the refund details will be visible here.

    Credit-Memo-1

    Credit-Memo-2

    Map Credit Memo Manually

    The admin can also export the Credit Memos manually under the credit memo section by navigating to Sales > Credit Memos.

    Further, under the Action dropdown, the admin will click on the Export Credit Memos on QB option for exporting the credit memos.

    Credit-Memos-Operations-Sales-Magento-Admin

    After that, the popup will be visible for confirmation as shown in the image below:

    Credit-Memos-Operations-Sales-Magento-Admin-1

    The process will take time for that the admin must wait and stay on the same page as shown in the image below:

    Exporting-Credit-Memos-are-in-Process-Magento-Admin-3-1

    After the completion, the credit memos will be visible under the map credit memo section by navigating to Connect > Map Credit Memo.

    Map-Credit-Memo-Magento-Admin-4

    In conclusion, that’s all for the Magento (Adobe Commerce) 2 QuickBooks Connector if you still have any issues feel free to add a ticket and let us know your views to make the module better at webkul.uvdesk.com.

    Current Product Version - 4.0.2

    Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x, 2.4.x

    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*


    2 comments

  • Andrew Huang
    • Archana Tiwari (Moderator)
  • Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content