Installing Kintsugi Sales Tax Plugin for Magento

Updated 6 months ago

Get ready to simplify your sales tax calculations! This guide will walk you through installing the Kintsugi SalesTax plugin, which integrates directly with your Magento store for accurate, real-time tax calculations.

Since this involves adding code to your Magento setup, please follow these instructions carefully.

What You'll Need

Before you begin, make sure you have:

Command Line Access: The ability to access your Magento server via the command line.
Plugin Download: A valid copy of the Kintsugi SalesTax plugin downloaded from our Kintsugi Magento Plugins page.

Step-by-Step Installation

Step 1: Get the Plugin

Go to the Kintsugi Magento Plugins download page.
Download the latest version of the SalesTax plugin (it will be a ZIP file).

Step 2: Install the Plugin Files

Extract: Unzip the downloaded file to reveal its contents.
Upload: Transfer the extracted plugin files to your Magento installation:
```
src/app/code/Kintsugi/SalesTax
```
IMPORTANT:
- If the Kintsugi/SalesTax folder doesn't exist, simply create it!
- The path must be exactly src/app/code/Kintsugi/SalesTax. Servers are case-sensitive; any mismatch will prevent Magento from detecting the module.

Step 3: Enable and Configure the Plugin

Open your command line interface and navigate to your Magento root directory (this is where your Magento files are located):

cd /path/to/your/magento-root/

Now, run the following commands one by one, pressing Enter after each:

Enable the Module:

cd  /path/to/your/magento-root/  
bin/magento module:enable Kintsugi_SalesTax

Update Your Database:
```
bin/magento setup:upgrade
```
Recompile Dependencies:
```
bin/magento setup:di:compile
```
Clear Your Cache:
```
bin/magento cache:flush
```

Deploy Static Content:

bin/magento setup:static-content:deploy -f

How to Confirm It's Working

To verify that the Kintsugi SalesTax plugin is successfully installed:

Log in to your Magento Admin Panel.
Go to Stores → Configuration → Sales → Tax.
Look for the "Kintsugi Tax" option in the configuration settings.
1. Fill the API KEY and Test Connection.
2. To enable sales tax calculation, toggle plugin option to Yes.
3. Fill API endpoint from from description given.
4. Optional: Fill Fallback rate in case API errors
5. Optional: Fill cache maintenance timer in seconds. Holds cache of tax rates for specified period
6. Click "Save Config"

Need Help?

For further concerns, we're always here to help. If you can't find the answer you're looking for, please reach out to us using the chat bubble in the bottom right corner.