Skip to main content

Configure Sovos sandbox environment


Configure Sovos sandbox environment

You need to collaborate with Sovos to set up your Sovos sandbox (UAT) environment, and depending on the country, Sovos provisions a simulator or a sandbox environment for you.

To configure the Sovos sandbox environment, complete the following tasks:

  1. Create Sovos developer accounts at the Sovos Developer Hub, generate the API key and secret in Sovos, and request a valid TLS certificate from Sovos. The valid TLS certificate allows Zuora to access the Sovos sandbox environment. For more information, see the Getting Started section of the Sovos developer guide. You will use the API key, secret, and TLS certificate when configuring Sovos as a service provider in Zuora. For more information, see Configure e-invoicing service providers.
  2. Configure e-invoicing in Sovos for a specific country. You must meet the country-specific prerequisites before starting to configure the Sovos sandbox environment and complete country-specific configurations. For more information, see the Country Prerequisites and Country Configurations sections of the Sovos developer guide. 

    • For some countries, you may need to register with the country's tax authority and get the necessary credentials. You need to configure these credentials in Sovos, and Sovos will use the credentials to submit data to the country's tax authority. 
    • After obtaining credentials from Sovos and retrieving your organization ID from Sovos, you can call a dedicated configuration endpoint to create a company and assign a product.
  3. Contact Sovos to get country-specific SCI (Sovos Canonical Invoice) samples of the up-to-date versions. You can refer to the e-Invoicing Compliance section of the Sovos developer guide to see what an SCI sample looks like.

  4. Get the SenderSystemId for the Sovos sandbox environment from Sovos. The SenderSystemId identifies the system where the transactions are sent. You will use this information for configuring e-invoice file template. For more information, see Create and test e-invoice file templates.

You will perform the same tasks above in the Sovos production environment. You can perform each task in Sovos production environment immediately after performing the same in Sovos sandbox environment without completing all Sovos sandbox environment configurations. For more information, see Launch on production environment.