Get started with Sovos Tax Connector app

Configure templates

{
  "doc": "{{document["invoiceNumber"]}}",
  "cmmt": "{{document["preview_mode"]}}"
}

{
  "doc": "{{document["invoiceNumber"]}}",
  "cmmt": false
}

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.

Perform 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. 
   In the case of a failed payment where rollback of the Subscribe call and deleting the invoice is desired, a taxVoid template is necessary to send a request to the tax vendor to also void the invoice and subsequent tax records from their system. Because all tax vendor requirements for voiding tax calls vary, contact your tax vendor to determine what needs to be sent over in the call made to their endpoints to properly void out the invoice.
4. Add a new template or modify the default template in the text box.
   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  and then select Preview Template to preview the configured template. If you want to start over, you can click  and select Revert Template to Default.
6. Click Save Both Template below the text box to save the template configurations.

After configuring the template, perform the following steps to configure engine settings:

1. Click the Engine Settings tab.
   
2. Click the  icon for the tax engine that you want to configure. The tax engine details window is displayed.
    
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.
     • OAuth 2.0 - You can configure the Access Token URL, Client ID, Client Secret, and Scope.
   • Select an option from 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.

Set up the external tax engine

Perform the following steps to set up the external tax engine:

1. In your Zuora tenant, navigate to Settings > Billing > Setup External Tax Engine.
2. If no Connect tax engine is available on the list of tax engines, select Connect Tax Engine from the dropdown list and click setup new tax engine. If a Connect tax engine is available in the list, you cannot create a new Connect tax engine. You have to edit an existing Connect tax engine.
3. Complete the Tax Engine configurations. 
   • Name - Name the tax engine you would like to use in Zuora.
   • Connect Token - Enter the unique 32-character API Token of the Tax app. To obtain your API Token, go the Sovos App link from the left-hand navigation menu and navigate to the App Information tab where the API token is listed near the top of the page. 
   • Company Information - You must add at least one Company Code in this section to activate a Tax Code.
4. Set up custom fields that will be used in the request. see Manage custom fields for more information.
5. Select all the custom fields you want to use in the tax request. Failure to select them will result in that blank values are used in the corresponding Liquid objects. Up to 50 custom fields are allowed.
6. Click Save.

Note: If you modify any of the Tax Engine details after the initial configuration, the Zuora token must be entered again. 

Set up taxation codes

Activate configurable tax code in product rate plans