Sovos Docs

Show Page Sections

Set up your account

Create the account hierarchy that represents your business structure organized around tax IDs.

Setup sequence:

  1. Create an organization and assign products.

  2. Add companies (one per tax ID).

  3. Add branches (optional - only if needed)

  4. Add users and assign user roles to them.

Account structure

Organizations contains one or more companies, each mapped to a tax ID. Companies use products to process documents.

Organization → Company → Product

Account elementRequiredDescription
OrganizationsYesTop-level account entity. Holds product subscriptions and contains companies. One contracting entity typically has one organization.
CompanyYesRepresents a legal entity with tax registration. Each company corresponds to one tax ID.
ProductYesElectronic invoicing solution for a specific country and operation. Examples: pl_Faktura__2.0, pl_Faktura_Polling_2.0.
BranchNoSub-division within a company when multiple physical locations share the same tax ID.

Add an organization

Add an organization to group related companies under a single administrative structure.

Organizations group related companies under a single administrative structure. Only workspace administrators can create organizations.

Set up in Compliance Network

You must have workspace administrator permissions to create an organization.
  1. Click Settings.
  2. Go to Organizations on the navigation menu.
  3. Click Create organization.
  4. Enter the organization name and a brief description.
  5. Click Save.

Set up using API

You need workspace administrator permissions to create an organization.

  1. Send a POST request to /v2/configurations/organizations.
  2. In the request body, include the name field with your organization name.

    Request body:

    {
      "name": "{organization-name}"
    }
  3. Important:

    name is a required field. It can't be empty. No character limit.

    Confirm the response returns a 200 status and an organization ID.

    Response body:

    {
      "id": "{organization-id}",
      "name": "{organization-name}",
      "createdAt": "{timestamp}",
      "createdBy": "{user-email}",
      "isDeleted": false
    }
  4. Save the id value from the response. You need this for all subsequent API calls.

Assign products to an organization

Assign products to your organization to define which countries and operations are available for document processing.

Products define which countries and operations (inbound or outbound) are available to your organization.

Set up in Compliance Network

  1. Click the Settings icon.
  2. Go to Organizations on the navigation menu.
  3. Click the organization name under the Name column.
  4. Go to Products.
  5. Click Add product.
  6. Under Search products, search and select one or more products from the list.
  7. Click Confirm.

Set up using API

Use the API to assign products to your organization and define which inbound and outbound operations are available.

You need workspace administrator permissions to create an organization.

Assign products at organization level to reduce administrative overhead. Companies inherit all products by default. If you need a subset of products for specific companies, you can override this with an API call per company.
  1. Send a PUT request to /v2/configurations/organizations/{organizationId}/products.
  2. In the request body, include the productId and set the allowedProcessTypes values for inbound and outbound processing.

    Request body:

    {
      "productId": "{product-id}",
      "allowedProcessTypes": {
        "inbound": false,
        "outbound": true
      }
    }
  3. Confirm the response returns a 200 status and a product ID.

Add companies to your organization

Add a company to your organization via Compliance Network web UI and Indirect Tax API.

Companies represent legal entities with tax registrations. Each company corresponds to one tax ID. Companies allow:

  • Granular configuration per tax ID.

  • Restricted user access per specific tax IDs.

  • Organized transactional data by legal entity.

You can add a company to your organization using the Compliance Network web UI (for manual setup) or using Indirect Tax API (for automated workflows)

Set up using Compliance Network

  1. Click Settings.
  2. Go to Settings.
  3. Go to Organizations on the navigation menu.
  4. Select an organization's name under the Name column.
  5. Go to Companies.
  6. Select New company.
  7. Enter the company details and company address, then Save.

Set up using API

Use the API to add a company to your organization by providing its tax registration details and assigned products.
  1. Send a POST request to /v2/configurations/organizations/{organizationId}/companies.
  2. In the request body, include the following required fields for your company:

    Request body:

    
                        
                    {
      "taxId": "{tax-id}",
      "legalName": "{legal-entity-name}",
      "dba": "{business-name}",
      "products": [
        {
          "productId": "{product-id}",
          "allowedProcessTypes": {
            "inbound": false,
            "outbound": true
          }
        }
      ]
    }

    Check the complete list of parameters:

    ParameterTypeRequiredDescription
    taxIdstringYesTax registration number of your company's tax ID. Validates for country-specific format
    legalNamestringYesOfficial legal entity name. It can't be empty
    dbastringYes"Doing Business As" registered name. It can't be empty
    productsarray of stringsYesArray of products with process types
    countrystringNoCountry code (ISO 3166-1 alpha-2, for example: "FR", "PL")
    Note:

    If the products list is left empty, the created company will acquire all the products assigned to the organization.

  3. Confirm the response returns a 200​ status.

    Response body:

    
                    {
      "id": "{company-id}",
      "taxId": "{tax-id}",
      "legalName": "{legal-entity-name}",
      "dba": "{business-name}",
      "country": "{country-code}",
      "products": [...],
      "createdAt": "{timestamp}",
      "isDeleted": false
    }
  4. Save the id (company ID) for future API calls.
After successfully adding a company, the Indirect Tax API returns a JSON object containing the company details and their assigned company ID.
Note:

Always save the company ID value from the response when creating a company. You will need the company ID value in future API calls. To find it, look for the ID value in the samples.

Edit a company

Edit a company to keep the information of your company up to date.

You can edit the information of your company and update the following information: legal name, DBA, and country after creation. You can't change the tax ID. If you need to update the tax ID of a company, you need to create a new company.

Set up using Compliance Network

  1. Click the Settings icon.
  2. Go to Companies on the navigation menu.
  3. Click the Settings icon from a company:
    How to edit a company
  4. Select Edit Company.
  5. After editing, click Save.

Set up using API

Use the API to update a company's legal name, DBA, and country.
  1. Send a PATCH request to /v2/configurations/organizations/{organizationId}/companies/{companyId}.
  2. In the request body, include the fields you want to update.
    Editable parametersTypeRequiredDescription
    legalNamestringYesOfficial legal entity name
    dbastringYes"Doing Business As" registered name
    countrystringNoCountry code (ISO 3166-1 alpha-2, for example: "FR", "PL")
    CAUTION:

    You can't change the tax ID. If you need to update the tax ID of a company, you need to create a new company.

  3. Confirm the response returns a 200​ status and the following response data structure with your updates:

    Response body:

    
                    {
      "id": "{company-id}",
      "taxId": "{tax-id}",
      "legalName": "{legal-entity-name}",
      "dba": "{business-name}",
      "country": "{country-code}",
      "products": [...],
      "updatedAt": "{timestamp}",
      "isDeleted": false
    }

Add branches

Add branches to manage multiple physical locations of your company that share the same tax ID as separate, independently configured entities.

Adding branches is an optional step in your setup account process. Branches represent multiple company physical locations or business sub-divisions sharing the same tax ID but needing independent configurations or document numbering. A branch in Sovos has the following capabilities:

  • Independent document numbering sequences

  • Branch-specific configurations (rendering, distribution, credentials)

  • Separate audit trails per branch

Important:

Branches add management complexity. Only add a branch when each location needs its own configuration.

Use cases

When to use branches
  • Your company has the same tax ID but different physical locations (retail stores, bank branches, regional offices).

  • Each location needs independent document numbering or separate configurations.

When not to use branches
  • Each company location has different tax IDs. Create separate companies instead.

  • Single location per tax ID. Branches not needed.

Set up using Compliance Network

Placeholder

Set up using API

Use the API to add a branch to your company.
  1. Send a POST request to /v2/configurations/organizations/{organizationId}/companies/{companyId}/branches.
  2. In the request body, include the required and optional fields for your branch.
    Sample request data:
    {
      "branch": "{branch-identifier}",
      "description": "{branch-description}"
    }
    ParametersRequiredTypeDescription
    branchYesstringBranch identifier. Must be unique within the parent company. It can't be empty
    descriptionNostringFree-text description
    metadataNoobjectFlexible JSON object for country-specific data
    Request parameters:
    Important:

    You can't edit the branch identifier after creating the branch. You can only edit the description and metadata fields.

  3. Confirm the response returns a ​200​​ and the following response data structure:
    {
      "id": "{branch-id}",
      "companyId": "{company-id}",
      "branch": "{branch-identifier}",
      "description": "{branch-description}",
      "isActivated": true,
      "createdAt": "{timestamp}"
    }
  4. Save the id (branch id) value from the response for future API calls.

Understand the configuration scope

Understand the configuration scope to manage which organizations, companies, branches, and operations a setting applies to.

After creating your organization and companies, you configure settings for your products (credentials, workflow options, notification preferences).

Scope levels
  • Organization level: Applies to all companies

  • Product level: Applies to all companies using this product

  • Company level (Tax ID-specific): Applies to one specific tax ID

  • Branch level: Applies to specific branch within company

  • Operation level: Applies to specific operation type (inbound/outbound)

Scope parameters in API settings
  • orgId - Organization

  • productId - Specific product

  • taxId - Specific tax ID

  • branch - Specific branch

  • operation - Operation type (Only available in select markets)

Scope precedence
Most granular configuration wins. Settings with more scope parameters specified take precedence over settings with fewer scope parameters.

Examples:

  • Setting A: orgId + productId (applies to all tax IDs using this product)

  • Setting B: orgId + productId + taxId (applies to one specific tax ID)

Result: Tax ID uses Setting B, all other tax IDs use Setting A.

Best practices

  • Configure at the highest level possible (Organization or Product) to minimize administrative overhead.

  • Only use granular scopes (Company, Branch, Operation) when business requirements justify separate configurations.

Add users to your organization

Users are defined by unique email addresses. Each user should only be associated with one email address. After a user sets up their account, they can switch between Sovos products and organizations without having to log in again.

You can manage users in Admin Settings or with the Organizations API endpoint.

When you add a user, you assign a role to the user. Learn more about available roles.

Add users through Compliance Network admin

Update the settings in the Compliance Network admin interface to add users and assign roles to them.
  1. Log in to Compliance Network as an administrator.
  2. Click the Settings icon.
  3. Go to Organizations on the navigation menu.
  4. Click the organization name.
  5. Go to Users.
  6. Click Invite user.
  7. Add the user's email, role, and the companies they need to access.
    Note: If you don't select any companies, the user will have access to all companies within the organization.
  8. Click Invite.

The invited user will receive an email invitation to join your organization in Compliance Network.

Note: You must invite users to Compliance Network, even if they already have access to other Sovos products. Users with access to other Sovos products won't receive an invitation email. Instead, they just need to log into Compliance Network with their existing username and password.

Add users through the API

Use the Organization User API endpoint to add users to your Compliance Network account.
  1. Provide the following required information in the API request body:
    • firstName
    • lastName

    • email

    • roleId

    For example:

    { 
       	"firstName": "Jane", 
        	"lastName": "Smith", 
       	"email": "myname@example.com", 
        	"roleId": "string", 
        	"customAttributes": { } 
    }
  2. Repeat for each user you want to add.

A 200 or 201 response confirms that the API request was successfully processed.

An invitation will be sent to the provided email address with instructions to set up a Sovos account or log in with an existing account.