Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Tax Integration

Tax integration automates the calculation and application of sales tax across commerce flows, ensuring compliance with tax regulations. By connecting to a tax engine like Avalara, the system calculates tax based on address, product details, prices, and tax categories, reducing manual errors and saving time.

Configuring Avalara Tax Integration Connectors

Administrators can configure the Avalara tax integration during Conga customer onboarding to enable accurate sales tax calculation for quotes and orders. The configuration securely stores required tax credentials and makes them available for tax calculation based on shipping address, product details, and tax categories across commerce flows.
Note: The Integration Connectors UI is not available yet. As a temporary workaround, you need to use the Secret Management API to store the required secrets.

Prerequisites

Access to:
  • Avalara sandbox account
  • Avalara Company Code, Account ID, and License Key
  1. Navigate to Secret Management API and locate Secret Store.
  2. Execute POST /api/secret-management/v1/secret to create a new secret.
  3. Use the following sample payload:
    {
      "SecretName": "AvalaraSettings",
      "SecretValue": "{\"Environment\":\"Sandbox\",\"CompanyCode\":\"{{CompanyCode}}\",\"AccountId\":\"{{AccountId}}\",\"LicenseKey\":\"{{LicenseKey}}\",\"AppName\":\"AvaTax\",\"AppVersion\":\"1.0\"}",
      "Description": "Avalara Tax Settings",
      "Category": "External"
    }
    
  4. Replace following Placeholder Values:
    • {{CompanyCode}} – Retrieves the Company Code from your Avalara sandbox account

    • {{AccountId}} – Retrieves the tenant-specific Account ID from the Avalara sandbox account

    • {{LicenseKey}} – Retrieves the tenant-specific License Key from the Avalara sandbox account

The Avalara tax configuration is securely stored in Conga using the Secret Management API and is available for tax calculation during checkout, quote, and order processing

Configuring Avalara Tax Integration Using the Endpoint Configuration API

You can configure the Avalara tax integration using the endpoint configuration APIs. After completing these steps, the Avalara integration is available from Admin UI > Integrations > Others.

Prerequisites
  • Access to the endpoint configuration APIs
  • Permission to create external credentials and update provider configuration
  • Valid Avalara account values for the applicable environment
  1. Retrieve the Avalara provider configuration using GET /api/endpointconfiguration/v1/providers/{integrationType}/{providerName}.
    • integrationType: Tax
    • providerName: Avalara
  2. Review the metadata field in the response and decode it to JSON for checking the x-field-type value to determine whether each field is a credentials field or a secret field.
  3. For each credentials field, create an external credential using POST /api/endpointconfiguration/v1/external/credentials.
    Payload example for licenseKey:
    
    {
      "Name": "Avalara_license_key",
      "Description": "Avalara license key",
      "AuthType": "APIKey",
      "APIKeySecrets": {
        "APIKey": "<your-avalara-license-key>"
      }
    }

    Complete this step for every Avalara field marked as credentials in the metadata.

  4. Update the Avalara provider configuration using PUT /api/endpointconfiguration/v1/providers/{integrationType}/{providerName}.
    • integrationType: Tax
    • providerName: Avalara
    Payload Example:
    
    {
      "Data": {
        "environment": "Sandbox",
        "companyCode": "<your-company-code>",
        "accountId": "<your-account-id>",
        "appName": "AvaTax",
        "appVersion": "25.12.0",
        "licenseKey": "Avalara_license_key"
      }
    }
    Note:

    For credentials fields, provide the reference name of the external credential created in the previous step. For secret fields, provide the actual secret value directly in the payload.

Viewing and Managing Avalara in the Admin UI

After configuring the Avalara integration using either the Secret Management API (at the beginning) and the Endpoint Configuration API, the configuration is automatically reflected in the Admin UI. Administrators can navigate to Platform AdministrationIntegrationsOthers to view, edit, and manage the Avalara integration without returning to the API.

The Others tab serves as the central listing page for all external integration providers configured in the system. It gives administrators a quick view of the current state of each integration, including when it was last updated and by whom.
  • Avalara Setup Page: Allows administrators to view and edit the Avalara integration configuration that was initially stored via the API. It also provides access to the Secrets dialog for managing the sensitive license key credential.

  • Managing Avalara Secrets: The Secrets dialog provides a secure interface for administrators to view and update the sensitive licenseKey credential for Avalara. The license key is always stored in masked form and is never displayed in plain text, protecting it from accidental exposure in the UI.

  1. Navigate to Admin UI > Integrations > Others tab.
  2. Click Edit to open the Avalara configuration.
  3. Click Manage Secrets.
    The Secrets dialog opens, showing the licenseKey field in masked state.
  4. Click Update next to the licenseKey field. The masked field expands to show an Enter new value... input field with a show/hide toggle icon.
  5. Type the new license key value in the input field and use the show/hide toggle to verify the value if needed.
  6. Click Save to apply the new value. The field returns to masked display. To discard the change, click Cancel instead.
  7. Click Close to dismiss the Secrets dialog and return to the Avalara Setup page.