Welcome to Zuora Product Documentation

Explore our rich library of product information

Set up Connect Tax Engines

Create and manage Connect Tax Engines to integrate a third-party tax app with Zuora Billing.

Before you begin, purchase the tax app you want from Marketplace and install it in your Zuora tenant.

See Configurable tax app for information about purchasing an app and installing it in Zuora Billing.

To set up a Connect Tax Engine:
  1. In your Zuora tenant, click your username at the top right and navigate to Settings > Billing.
  2. Click Setup Tax Engine and Tax Date.
  3. Select Connect Tax Engine from the list, and click setup new tax engine.
    Note: You can create at most 10 Connect Tax Engines.
  4. In the Basic Information area on the Setup Tax Engine page, specify the basic information for the new tax engine:
    • Name: Name the Connect Tax Engine you would like to use in Zuora. For example, Avalara Brazil, India Local Tax, Avalara Telco, etc.
    • Connect Token: Enter the unique 32-character API Token of the Tax app. To obtain your API Token:
      1. Access the app through Setup Tax Engine and Tax Date under Billing settings. Billing settings
      2. Navigate to the APP INFORMATION tab, the API token is listed near the top of the tab.
  5. In the Custom Fields sent to Open Tax Connector area, select all the custom fields that you want to use in the tax request for tax calculation. You can select both Legacy Custom Fields and Advanced Custom Fields.
    Failure to select them will result in that blank values are used in the corresponding Liquid objects. See Manage custom fields for more information. The maximum number of custom fields you can select varies depending on your Zuora edition or Zuora modules. For more information, see Zuora Editions and Zuora Modules.
  6. Click Save to save the configurations.
  7. In the Company Information area, add at least one Company Code to activate a tax code.
    After completing the previous steps, you can click back to Tax Engine list to view the Connect Tax Engine you just created. If you want to modify it, click Edit. If you want to remove it, click Delete.
    Note: If you want to remove an existing Connect Tax Engine referred by a tax code, you need to first remove the tax code before removing the Connect Tax Engine.

    You can also set up and configure Connect Tax Engines through the Settings API. The following operations are supported:

    OperationHTTP MethodHTTP URLNote
    Create a Connect Tax EnginePOSThttps://rest.zuora.com/settings/tax-engines/connectorYou can create at most 10 Connect Tax Engines for your Zuora tenant.
    Retrieve a Connect Tax EngineGEThttps://rest.zuora.com/settings/tax-engines/connector/{id }
    Update a Connect Tax EnginePUThttps://rest.zuora.com/settings/tax-engines/connector/{id}
    Delete a Connect Tax EngineDELETEhttps://rest.zuora.com/settings/tax-engines/connector/{id}

    See Connect Tax Engines Settings for request/response samples.