Skip to main content

Configure Tax App


Configure Tax App

After installing the Zuora Tax app, you need to take the following steps to set up the app in your Connect tenant:

  1. Configure Templates
  2. Configure Request Settings

Configure templates

The Dynamic Request Template is the body of the request where Zuora populates invoice information that can be configured based on your needs. Templates are dynamically rendered using the Liquid Template Language and are provided in the Text/XML or Application/JSON format.

Take the following steps to configure a dynamic request template:

  1. Launch the created Tax instance and click the Template Configuration tab. 
  2. Select the tax engine for which you want to configure templates from the Tax Engine dropdown list.
  3. Select the tab for the template (Standard or taxVoid) you want to configure.
    Zuora provides you with two templates called Standard template and taxVoid template, but only the Standard template is required to be completed. Tax systems have many configuration options. The template does not have to use all the options and must be configured based on the required information of the request. Templates can include more fields than the required set of fields in the request. Refer to your tax provider’s API documentation or contact their support to learn more about how their fields are formatted. 
  4. Add a new template or modify the default template in the text box.
    Note that the Vertex Tax Engine app now supports Vertex flexible fields using defined custom fields in your Zuora tenant.
    To view all available fields and corresponding values that can be used in the template:
    1. Click Show Liquid Examples.
    2. Select the desired field in the Example Field dropdown list, the corresponding value you can copy and paste in the template is displayed under Example Value. The fields in the following objects are available for selection:
      • Customer
      • Seller
      • Document
      • Document Item
  5. When you complete the configuration, click settings_tax_app_icon and then select Preview Template to preview the configured template. If you want to start over, you can click settings_tax_app_icon and select Revert Template to Default.
  6. Click Save Both Template below the text box to save the template configurations.

Configure engine settings

Take the following steps to configure engine settings:

  1. Click the Engine Settings tab.
  2. Click edit_icon for the tax engine that you want to configure. The tax engine details window opens.
  3. In the Headers tab, select the value forContent-Typein the Value dropdown list. You can click Add Header to add additional headers that will be added to the tax requests that are sent to your tax provider. 
  4. Click the System Configuration tab and complete the system configuration. 
    • Select an authentication type in the Authentication Type dropdown list. Consult your tax provider for further information regarding your specific authentication type and credentials. 
      • None - No authentication required.
      • Basic-Auth - Will require Username and Password to be entered.
      • BearedId - Will require Token to be entered.
      • HMAC-SovosTaxware - This option is only available if you selected the SovosTaxware run mode when installing the Tax app.
    • Select an option in the taxVoid Call Handling dropdown list:
      • Pass Through - Allows the call to process without any issue, but tax will not be processed.
      • Block - Does not allow the call to process and will generate an error message.
      • Enable - Allows the call to pass and will either process tax or generate an error message.
    • Optionally, you can select Skip Taxation on External Failure. When this option is selected, taxation will be skipped in the case of external failures such as network issues or error responses from the vendor side.
  5. Complete the information in the Seller Information tab. The information that is required to be completed varies depending on the selected tax engine requirements. Check with your tax engine provider for details. 
  6. Click Save Engine Settings to save the configuration.

What to do next 

After configuring the Tax app in your Connect tenant, you need to set up the tax engine and taxation code, and configure rate plans in your Zuora tenant. See Configure Rate Plans in Zuora for the next step.