Requirements
Tax Balance requires the Portal application at least for authentication purposes. See section Portal application for more details.
The configuration will refer to <your-portal-url>
with the URL that you host your Portal application on and <your-taxbalance-url>
with the URL that you host the Tax Balance Server on.
Activate Tax Balance license
Open the Portal Web Application located at <your-portal-url>
.
Select Administration → Activations from the main navigation
Enter Key that was provided by AMANA
Click Add activation
Register Tax Balance as a module
Open the Portal Web Application located at <your-portal-url>
.
Select Administration → Modules from the main navigation and click Create
Select Module name Tax Balance
Set Root URL to
<your-taxbalance-url>
Set Login URL to
<your-taxbalance-url>
Set Api URL to
<your-taxbalance-url>/api
Select Id token JWS algorithm RS265
Click Save and remember the Client ID and Secret for later configuration steps
Tax Balance configuration
Perform the following configuration instructions on the machine that hosts the Tax Balance Server.
Edit the appsettings.json
file in the physical directory of the Tax Balance Server application:
Set "Authentication" > "OAuth" > "AuthorizationEndpoint" to
<your-portal-url>
/loginSet "Authentication" > "OAuth" > "ClientId" to the Client ID from the previous registration process
Set "Authentication" > "OAuth" > "ClientSecret" to the Secret from the previous registration process
Set "Authentication" > "OAuth" > "TokenEndpoint" to
<your-portal-url>
/portal/api/auth/tokenSet "Authentication" > "JwtBearer" > "Authority" to
<your-portal-url>
Set "Authentication" > "JwtBearer" > "ClaimsIssuer" to
<your-portal-url>
Set "ConnectionsStrings" > "SmartTaxBalanceDatabase" to a valid connection string
e.g.Server=<your-database-server>;Database=taxbalance;Trusted_Connection=True;TrustServerCertificate=True;Encrypt=True
Trusted_Connection
,TrustServerCertificate
andEncrypt
must meet the requirements of the SQL Server. Be aware that settingTrusted_Connection
toTrue
will enforceIntegrated Security
toTrue
. Therefore, it is not possible to useUser Id
andPassword
in this case. See SQL Server Database for more details.Set "CORS" > "Origins" to
["<your-portal-url>", "<your-taxbalance-url>"]
Starting with Version 23.0.148: Set "GlobalTaxCenterSuite" > "ApiKeys" > “TaxDataHub” to a valid API Key provided by Tax Data Hub
Retrieve the API key from the Tax Data Hub log files. Tax Data Hub will generate an API key on first start and will output it only once.
Edit the wwwroot\assets\config\config.json
file in the physical directory of the Tax Balance Server application:
Starting with version 23.0.188 the following configuration steps are not necessary anymore.
Set "backendUrl" to
<your-taxbalance-url>
/apiSet "hubsUrl" to
<your-taxbalance-url>
/hubsSet "openIdIssuer" to
<your-portal-url>
Set "openIdClientId" to the Client ID from the previous registration process
Set "openIdDummyClientSecret" to the Secret from the previous registration process
XBRL taxonomy functionality
Tax Balance heavily relies on the so called XBRL taxonomies provided by "XBRL Deutschland e.V.".
If the application server blocks connections to remote ressources, e.g. https:\\de.xbrl.org
please perform the following steps:
XBRL cache folder is configured in
appsettings.json
(located in the application directory) by setting theXbrlFileCachePath
property. The default setting isC:\temp\
Extract this ZIP archive to the preceding location
You may want to change the location of the cache folder
Ensure that the IIS AppPool user, e.g. "IIS AppPool\<name of application pool>" has permission to read and write to the above mentioned xbrl file cache path.