Skip to content

How to set up and activate the Tax Guard Monitor

Overview

This tutorial explains how to configure, activate, and analyze results from a Tax Guard Monitor in CDQ. The Tax Guard Monitor asynchronously qualifies the Business Partners stored in a data mirror against official tax and business registers, checking whether the VAT identifier, name, and address of each partner are consistent with the reference data. This lets you continuously verify VAT compliance across your data instead of running manual, one-off checks.

Learning Goals

In this tutorial, you will learn how to:

  • activate the tax data sources used for qualification
  • create a Tax Guard qualification configuration
  • create and activate a Tax Guard Monitor
  • generate and interpret a qualification report

Prerequisites

To go through the tutorial, you have to log in to the CDQ Cloud Apps.

Click on Sign In and enter your username and password.

Warning

If you have no access to the CDQ Cloud App, ask your internal point of contact to create a CDQ dedicated account. Account details will be sent by email.

Qualification relies on official registers that must be activated for your organization before the monitor can use them. VIES is used by default for European Union Business Partners, while some sources, for example AT.FON, require additional credentials. You activate and configure these sources in Step 2.

What Tax Guard qualifies

Tax Guard qualifies the identifier, name, and address of a Business Partner. In the CDQ data model, the city is called locality and the street is called thoroughfare. Each address component (postcode, locality, and thoroughfare) provides its own decision. However, all components are combined into a single address decision.

Step 1: Activate the Tax Data Sources

CDQ is integrated with a range of official tax and business registers that act as reference data for qualification. Before these sources can be used by a Tax Guard Monitor, they must be explicitly activated. Activation is a one-time process for the entire organization, and once completed the activated data sources can be used across all workspaces.

  1. Navigate to Global Settings.
  2. Locate the data source you want to activate. You can filter the list by country of origin, name, and activation status.
  3. Open the Settings for the required data source and modify it:
    • provide the necessary credentials (if the source requires them),
    • activate the source using the activation toggle,
    • click Save credentials.

Figure 2. Activating a tax data source in Global Settings

Credentials and quotas

Some data sources require your own credentials and are subject to quotas. AT.FON, for example, must be activated with valid credentials and allows a limited number of checks per Business Partner per day. Activate only the sources you need for qualification or specify them in the Tax Guard Configuration (only those will be used but still need to be active).

CDQ currently provides qualification against 18 official registers. VIES covers (by default) the European Union, while additional registers extend coverage to countries outside the EU. Keep in mind that the European Union registers differ in their abilities to qualify EU Business Partners. For more guidelines please look carefully into the Understanding the Qualification Process article.

Expand for the full list of qualification data sources
Code Description
AR.NRCNational Registration Code for Argentina
AT.CRCommercial Register number for Austria
AT.FONFiscal Organization Number for Austria
AU.BRBusiness Registration number for Australia
BR.RFFederal Revenue number for Brazil
BZSTFederal Tax Office identifier for Germany
CA.CRCorporate Registry number for Canada
CH.UIDRUnified Business Identification Register for Switzerland
CZ.REERegister of Economic Entities for Czech Republic
DK.CRCentral Register of Companies for Denmark
EU.EORIEconomic Operators Registration and Identification for the EU
FR.RCRegistre du Commerce (Trade Register) for France
NO.RBERegister of Business Enterprises for Norway
PL.NOBRNational Official Business Register for Poland
SG.BRBusiness Registration number for Singapore
UK.EORIEconomic Operators Registration and Identification for the UK
UK.VATValue Added Tax registration number for the United Kingdom
VIESVAT Information Exchange System for the European Union

For the always up-to-date list, refer to the Data Sources catalog.

Step 2: Create a Tax Qualification Configuration

The Tax Guard Monitor is driven by a qualification configuration that selects a qualification profile. The profile determines which registers are queried and how the identifier, name, and address are checked.

  1. Select the Tax Guard Qualification Configurator cloud app.
  2. Click Create, provide a name for the configuration, and click Create again.
  3. In the configuration table, confirm that the new configuration has a unique number assigned, then select it for editing.
  4. In the details section, choose a Qualification Profile:
    • EU TAX QUALIFICATION, qualifies European Union Business Partners, using VIES by default (and AT.FON when required for German partners),
    • WORLDWIDE TAX QUALIFICATION, extends qualification to registers outside the European Union.
  5. If you want to change the usage of the selected profile you can select data sources that you want to employ (in this case only selected data sources will be used).
  6. Choose proper features on or off (if needed).
  7. Click Save Configuration.

Figure 3. Creating a Tax Guard configuration in the Tax Guard Qualification Configurator

Choosing data sources within a profile

Within a profile you can narrow down which registers are used through the dataSources option, for example "dataSources": ["VIES", "BZST"]. Results are always separated per data source, so each source produces its own qualification decisions.

Expand for qualification profiles and features

Profiles

  • EU TAX QUALIFICATION uses VIES as the default source for all EU countries. To fully qualify German Business Partners, AT.FON is the only option and must be activated with its credentials. VIES does not qualify name, thoroughfare, postcode, and city for German Business Partners (only an identifier can be qualified). Within this profile, dataSources accepts VIES, BZST, and AT.FON.
  • WORLDWIDE TAX QUALIFICATION behaves like EU TAX QUALIFICATION for VIES but additionally supports registers for countries outside the EU. Some sources need credentials configured in the workspace global settings.

Features

The following features can be enabled for a qualification run:

Feature Effect
FORCE EXTERNAL CALLForces a direct call to the reference data source whenever possible, useful for obtaining a VIES request confirmation.
SHOW LOOKUP RESULTSDisplays the lookup results and the Business Partner considered during qualification, per queried data source.
SHOW BUSINESS PARTNERReturns the Business Partner record that was sent for qualification.
SHOW DEBUG INFOAdds details about the qualification process (number of applied rules, external service responses, and more). Enabled by default; disable it with "featuresOff": ["SHOW_DEBUG_INFO"].

Step 3: Create the Tax Guard Monitor

The Tax Guard Monitor processes the Business Partners in a data mirror asynchronously and applies the qualification configuration created in the previous step.

  1. Go to the Data Clinic cloud app.
  2. Click Add New Data Monitor.
  3. Configure the new monitor:
    • select the Data Sources for which the monitor should be turned on,
    • choose Qualification for the Monitor Type,
    • choose the Tax Guard qualification configuration created in Step 3,
    • select a Validity span (optional).
  4. Click Create New Data Monitor to save.
  5. Wait until the job for the new monitor is finished.

Figure 4. Creating a Tax Guard Monitor in Data Clinic

Validity span

With a validity span configured, a Business Partner is refreshed if no reevaluation trigger occurs within the selected period, keeping the qualification results current.

Step 4: Generate a Qualification Report

Once the monitor has finished, generate a report to review the qualification decisions.

  1. In the Data Clinic app, open the Reports tab.
  2. Click Generate New Report and configure it:
    • provide a Report Title,
    • choose a report type, Tax Guard Qualification Report for a report,
    • select the same Data Sources used for the monitor,
    • limit the report to specific countries if needed,
    • choose a file format (optional).
  3. Click Generate to start the report job.
  4. Wait until the job is finished, then Download the report.

Figure 5. Generating a qualification report in Data Clinic

Report ready

After a few minutes, depending on the size of the monitor results, the report becomes available for download.

Step 5: Interpret the Qualification Results

Each qualified element (identifier, name, city, street, postcode) is evaluated by a distinct business rule that returns one decision. The report presents these decisions per Business Partner and per data source.

Decision Meaning
VALIDThe input value matches the reference value from the qualification data source.
INVALIDThe input value does not match the reference value from the qualification data source.
NOT_PROCESSEDNo applicable rule exists, a rule was deactivated, or the field could not be processed.
NO_INPUT_PROVIDEDNo input value was provided, so no comparison was possible.
NO_REFERENCE_AVAILABLEThe data source returned no reference value to compare against. Review these cases.
EXECUTION_ERRORThe rule did not execute correctly, for example due to an internal issue or an unavailable data source.

The overall decision for each Business Partner is derived from the individual decisions using this hierarchy, where the rightmost result wins: NOT_PROCESSED < NO_INPUT_PROVIDED < VALID < NO_REFERENCE_AVAILABLE < INVALID < EXECUTION_ERROR.

Data source limitations

Some registers can only confirm validity rather than return full reference data. For example, VIES for Spanish Business Partners reports only whether a value is valid, VIES for German Business Partners validates the identifier only, and AT.FON allows a limited number of checks per Business Partner per day, exceeding it yields EXECUTION_ERROR.

Summary

You have activated the tax data sources, created a Tax Guard qualification configuration, set up and activated a Tax Guard Monitor, and generated a qualification report. Your Business Partners are now qualified against official registers, and the report shows, per partner and per data source, whether the identifier, name, and address are consistent with the reference data.



Your opinion matters!

We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!