> ## Documentation Index
> Fetch the complete documentation index at: https://docs.numeral.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Odoo

> Install the Numeral addon on your Odoo.sh project for automated US sales tax calculation.

This guide explains how to install the Numeral addon on your Odoo.sh project.

***

## Prerequisites

* An active Odoo.sh project
* Admin access to your Odoo.sh project
* A Numeral account with API credentials ([numeralhq.com](https://numeralhq.com))

***

## Step 1: Deploy from the Odoo App Store

1. Visit the **Numeral** listing on the Odoo App Store for your Odoo version:

   | Odoo Version | App Store Link                                                                                                   |
   | ------------ | ---------------------------------------------------------------------------------------------------------------- |
   | Odoo 17      | [apps.odoo.com/apps/modules/17.0/numeral\_tax\_addon](https://apps.odoo.com/apps/modules/17.0/numeral_tax_addon) |
   | Odoo 18      | [apps.odoo.com/apps/modules/18.0/numeral\_tax\_addon](https://apps.odoo.com/apps/modules/18.0/numeral_tax_addon) |
   | Odoo 19      | [apps.odoo.com/apps/modules/19.0/numeral\_tax\_addon](https://apps.odoo.com/apps/modules/19.0/numeral_tax_addon) |

2. Click the **Deploy on Odoo.sh** button.

3. Select your existing Odoo.sh project from the list.

4. Wait for the build to complete — you can monitor progress in the build logs.

<Note>
  The deployment may take a few minutes.
</Note>

***

## Step 2: Install the Module

Once deployed:

1. Log in to your Odoo instance.
2. Go to **Apps**.
3. Click **Update Apps List** (in the menu).
4. Search for **"Numeral"**.
5. Click **Install**.

***

## Step 3: Configure Numeral API

After installation:

1. Go to **Settings → General Settings**.
2. Scroll to the **Numeral** section.
3. Enter your API credentials:
   * **API Token**: Your Numeral API key (starts with `sk_live_` or `sk_test_`)
4. Click **Test Connection** to verify.
5. Click **Save**.

***

## Multi-Company Setup

If you have multiple companies:

* Switch to each company using the company selector.
* Configure Numeral settings for each company separately.

**Branch companies** can check **Inherit from parent** to use the parent company's API credentials.

***

## Updating the Module

When a new version is released:

1. Visit the [Numeral listing](https://apps.odoo.com/apps/modules/19.0/numeral_tax_addon) on the Odoo App Store.
2. Click **Deploy on Odoo.sh** again to deploy the latest version.
3. Wait for the build to complete.
4. Go to **Apps** → find **Numeral** → click **Upgrade**.

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Module not appearing in Apps">
    * Verify the deployment completed successfully in the Odoo.sh build logs.
    * Try clicking **Update Apps List** again.
    * Ensure you deployed the correct version for your Odoo instance.
  </Accordion>

  <Accordion title="Connection test fails">
    * Verify your API token is correct.
    * Ensure there are no extra spaces in the token field.
    * Check if your Numeral account is active.
    * Try with a test token (`sk_test_...`) first.
  </Accordion>

  <Accordion title="Products not syncing">
    * Ensure products have the **Numeral** checkbox enabled.
    * Check that products have a valid category.
    * Review the sync status in **Settings → Numeral**.
  </Accordion>
</AccordionGroup>