fiskaltrust

https://docs.fiskaltrust.eu/
Admin
fiskaltrust provides a compliance middleware and cloud platform that enables POS systems to meet...
Tokens:154,265
Snippets:2,346
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Mono Service Utility

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/general/components/components-install-config

Command to install the required mono-service utility on Ubuntu systems.

```bash
sudo apt update && sudo apt install mono-4.0-service
```

--------------------------------

### Echo API Example

Source: https://docs.fiskaltrust.eu/docs/poscreators/possystem-api/migration-guide-v0-v2

Example request and response for the /v2/echo endpoint.

```http
POST /v2/echo  
{  
  "message": "test"  
}
```

```json
{
  "message": "test"
}
```

--------------------------------

### Configure Proxy Connection Strings

Source: https://docs.fiskaltrust.eu/docs/posdealers/technical-operations/middleware/network-requirements

Examples of semicolon-separated connection strings used with the -proxy parameter.

```text
address=192.168.0.1  
address=192.168.0.1;username=proxyuser;password=proxypw  
address=proxy.example.com;username=proxyuser  
address=192.168.0.1;bypass=192\.168\.10\.1  
address=192.168.0.1;bypass=192\.168\.10\.1;bypass=scu\d+\.example\.com  
```

--------------------------------

### Example Middleware Log Output

Source: https://docs.fiskaltrust.eu/docs/posdealers/technical-operations/middleware/logging

A sample log file excerpt showing startup information and a file system permission error.

```text
1970-01-01 00:00:00 [INF] fiskaltrust.Launcher-X.X.X  
1970-01-01 00:00:00 [INF] CashBoxId set to "00000000-0000-0000-0000-000000000000"  
1970-01-01 00:00:00 [INF] AccessToken set  
1970-01-01 00:00:00 [INF] Sandbox set to "True"  
1970-01-01 00:00:00 [ERR] Cannot set ACL to ServiceFolder  
System.UnauthorizedAccessException: Attempted to perform an unauthorized operation.  
   at System.Security.AccessControl.Win32.SetSecurityInfo(ResourceType type, String name, SafeHandle handle, SecurityInfos securityInformation, SecurityIdentifier owner, SecurityIdentifier group, GenericAcl sacl, GenericAcl dacl)  
   at System.Security.AccessControl.NativeObjectSecurity.Persist(String name, SafeHandle handle, AccessControlSections includeSections, Object exceptionContext)  
   at System.Security.AccessControl.NativeObjectSecurity.Persist(String name, AccessControlSections includeSections, Object exceptionContext)  
   at System.Security.AccessControl.FileSystemSecurity.Persist(String fullPath)  
   at fiskaltrust.service.launcher.Configuration.get_ServiceFolder()  
1970-01-01 00:00:02 [INF] Starting Middleware with configuration timestamp: 0 (SHA256: 0000000000000000000000000000000000000000000000000000000000000000)  
1970-01-01 00:00:02 [INF] Save configuration to C:\ProgramData\fiskaltrust\service\Configuration-00000000-0000-0000-0000-000000000000.json  
1970-01-01 00:00:02 [INF] Starting ft.Middleware at C:\ProgramData\fiskaltrust\service\00000000-0000-0000-0000-000000000000  
1970-01-01 00:00:02 [INF] fiskaltrust.Middleware started. Press a button to stop...
```

--------------------------------

### Retrieve Version Information

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/general/reference-tables/reference-tables-v1

Example output showing the assembly and version details returned when requesting version information.

```json
{
    "Assembly": "fiskaltrust.Middleware.Queue, Version=1.3.24.0, Culture=neutral, PublicKeyToken=null",
    "Version": {
        "Major": 1,
        "Minor": 3,
        "Build": 24,
        "Revision": 0,
        "MajorRevision": 0,
        "MinorRevision": 0
    }
}
```

--------------------------------

### SubItems Field Mapping Examples

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/germany/dsfinv-k

Examples of how to map specific fields into the SubItems array within the JSON payload.

```json
"SubItems":"[{ "ProductNumber":"10292", ... }, ... ]"
```

```json
"SubItems":"[{ "ProductNumber":"10292", "GTIN":"4231234266622", ... }, ... ]"
```

```json
"SubItems":"[{ "ProductNumber":"10292", "Description":"4231234266622", ... }, ... ]"
```

```json
"SubItems":"[{ ..., "ProductGroup":"{ \"ProductGroupId\":\"981981AA\", \"ProductGroupName\":\"Fleischwaren\" }", ... }, ... ]"
```

```json
"SubItems":"[{..., "Quantity":2.543, ... }, ... ]"
```

```json
"SubItems":"[{ ..., "UnitQuantity":1.0, ... }, ... ]"
```

```json
"SubItems":"[{ ..., "Unit":"kg", ... }, ... ]"
```

```json
"SubItems":"[{..., "ftSubChargeItemCase":"4919338167972134929", ... }, ... ]"
```

```json
"SubItems":"[{..., "Amount":22.50, ... }, ... ]"
```

--------------------------------

### Configure Directories and Permissions

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/general/components/components-install-config

Commands to create the configuration directory and set necessary file execution permissions.

```bash
sudo mkdir /etc/fiskaltrust
sudo chmod 777 /etc/fiskaltrust
sudo chmod +x /etc/init.d/fiskaltrust
sudo chmod +x /etc/fiskaltrust/fiskaltrust.exe
```

--------------------------------

### Verify Middleware Installation via Intent

Source: https://docs.fiskaltrust.eu/docs/poscreators/possystem-api/android-intent

Checks if the fiskaltrust middleware is installed on the device by resolving the specific intent action.

```kotlin
fun isMiddlewareInstalled(context: Context): Boolean {
    val intent = Intent("eu.fiskaltrust.androidlauncher.POSSYSTEMAPI")
    intent.addCategory(Intent.CATEGORY_DEFAULT)
    val resolveInfo = context.packageManager.resolveActivity(
        intent, 
        PackageManager.MATCH_DEFAULT_ONLY
    )
    return resolveInfo != null
}
```

--------------------------------

### ChargeItemCaseData JSON Example

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/france/data-structures

Example of the required JSON structure for the ftChargeItemCaseData field, specifically including the mandatory NetAmount for French law compliance.

```json
"ftChargeItemCaseData": "{\"NetAmount\": 54.93}"  
...  
```

--------------------------------

### Complete Intent Call Example in Java

Source: https://docs.fiskaltrust.eu/docs/poscreators/possystem-api/android-intent

Demonstrates how to encode request data, trigger the PosSystemAPI via Intent, and handle the asynchronous response in onActivityResult.

```java
import android.content.Intent;  
import android.util.Base64;  
import org.json.JSONObject;  
  
public void callPosSystemAPI(String method, String path, JSONObject headers, String body) {  
    try {  
        // Base64URL encode headers  
        String headersJson = headers.toString();  
        byte[] headerBytes = headersJson.getBytes("UTF-8");  
        String headerB64 = Base64.encodeToString(headerBytes,   
            Base64.URL_SAFE | Base64.NO_PADDING | Base64.NO_WRAP);  
          
        // Base64URL encode body  
        String bodyB64 = null;  
        if (body != null) {  
            byte[] bodyBytes = body.getBytes("UTF-8");  
            bodyB64 = Base64.encodeToString(bodyBytes,   
                Base64.URL_SAFE | Base64.NO_PADDING | Base64.NO_WRAP);  
        }  
          
        // Create intent  
        Intent intent = new Intent();  
        intent.setClassName("eu.fiskaltrust.androidlauncher",   
            "eu.fiskaltrust.androidlauncher.PosSystemAPI");  
        intent.putExtra("Method", method);  
        intent.putExtra("Path", path);  
        intent.putExtra("HeaderJsonObjectBase64Url", headerB64);  
        if (bodyB64 != null) {  
            intent.putExtra("BodyBase64Url", bodyB64);  
        }  
          
        startActivityForResult(intent, REQUEST_CODE);  
    } catch (Exception e) {  
        Log.e("PosSystemAPI", "Error creating intent", e);  
    }  
}  
  
@Override  
protected void onActivityResult(int requestCode, int resultCode, Intent data) {  
    super.onActivityResult(requestCode, resultCode, data);  
      
    if (requestCode == REQUEST_CODE && data != null) {  
        String statusCode = data.getStringExtra("StatusCode");  
        String contentB64 = data.getStringExtra("ContentBase64Url");  
        String contentTypeB64 = data.getStringExtra("ContentTypeBase64Url");  
          
        try {  
            // Decode Base64URL  
            byte[] contentBytes = Base64.decode(contentB64,   
                Base64.URL_SAFE | Base64.NO_PADDING | Base64.NO_WRAP);  
            String content = new String(contentBytes, "UTF-8");  
              
            byte[] typeBytes = Base64.decode(contentTypeB64,   
                Base64.URL_SAFE | Base64.NO_PADDING | Base64.NO_WRAP);  
            String contentType = new String(typeBytes, "UTF-8");  
              
            Log.i("PosSystemAPI", "Status: " + statusCode + ", Type: " + contentType);  
            Log.i("PosSystemAPI", "Response: " + content);  
        } catch (Exception e) {  
            Log.e("PosSystemAPI", "Error decoding response", e);  
        }  
    }  
}  
```

--------------------------------

### Complete PosSystemAPI Intent Implementation

Source: https://docs.fiskaltrust.eu/docs/poscreators/possystem-api/android-intent

A full implementation example including Base64URL encoding of headers and body, intent execution, and response handling via onActivityResult.

```kotlin
import android.content.Intent  
import android.util.Base64  
import org.json.JSONObject  
  
fun callPosSystemAPI(method: String, path: String, headers: Map<String, String>, body: String?) {  
    // Create headers JSON  
    val headersJson = JSONObject(headers).toString()  
      
    // Base64URL encode (no padding, replace + with -, / with _)  
    val headerB64 = headersJson.toByteArray(Charsets.UTF_8)  
        .let { Base64.encodeToString(it, Base64.URL_SAFE or Base64.NO_PADDING or Base64.NO_WRAP) }  
      
    val bodyB64 = body?.toByteArray(Charsets.UTF_8)  
        ?.let { Base64.encodeToString(it, Base64.URL_SAFE or Base64.NO_PADDING or Base64.NO_WRAP) }  
      
    // Create intent  
    val intent = Intent()  
    intent.setClassName("eu.fiskaltrust.androidlauncher", "eu.fiskaltrust.androidlauncher.PosSystemAPI")  
    intent.putExtra("Method", method)  
    intent.putExtra("Path", path)  
    intent.putExtra("HeaderJsonObjectBase64Url", headerB64)  
    if (bodyB64 != null) {  
        intent.putExtra("BodyBase64Url", bodyB64)  
    }  
      
    startActivityForResult(intent, REQUEST_CODE)  
}  
  
// Example: Echo call  
fun echoExample() {  
    val headers = mapOf(  
        "Accept" to "application/json",  
        "x-cashbox-id" to "de12c75f-5587-48b8-8ac5-64b7c81a05ec",  
        "x-cashbox-accesstoken" to "your-access-token",  
        "x-operation-id" to java.util.UUID.randomUUID().toString(),  
    )  
    val body = """{"Message": "Hello, World!"}"""  
      
    callPosSystemAPI("POST", "/echo", headers, body)  
}  
  
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {  
    super.onActivityResult(requestCode, resultCode, data)  
      
    if (requestCode == REQUEST_CODE && data != null) {  
        val statusCode = data.getStringExtra("StatusCode") ?: "500"  
        val contentB64 = data.getStringExtra("ContentBase64Url") ?: ""  
        val contentTypeB64 = data.getStringExtra("ContentTypeBase64Url") ?: ""  
          
        // Decode Base64URL  
        val content = Base64.decode(contentB64, Base64.URL_SAFE or Base64.NO_PADDING or Base64.NO_WRAP)  
            .toString(Charsets.UTF_8)  
        val contentType = Base64.decode(contentTypeB64, Base64.URL_SAFE or Base64.NO_PADDING or Base64.NO_WRAP)  
            .toString(Charsets.UTF_8)  
          
        Log.i("PosSystemAPI", "Status: $statusCode, Type: $contentType")  
        Log.i("PosSystemAPI", "Response: $content")  
    }  
}  

```

--------------------------------

### Saving a room number

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/france/data-structures

Example of serializing a room number into the cbArea field.

```json
"cbArea": "{\"room\" : \"W1101\"}"  
...  
```

--------------------------------

### Sending Requests via Command Line

Source: https://docs.fiskaltrust.eu/docs/posdealers/technical-operations/rollout-automation/api-templating

Examples for executing the configuration request using curl and PowerShell.

```bash
curl.exe -X POST -H "Content-Type: application/json" -H "accountid: ACCOUNT_ID" -H "accesstoken: ACCOUNT_ACCESS_TOKEN" -d 'ESCAPED_TEMPLATE' https://helipad.fiskaltrust.cloud/api/configuration
```

```powershell
$headers = @{ accountid = "ACCOUNT_ID"; accesstoken = "ACCOUNT_ACCESS_TOKEN" }  
Invoke-WebRequest -Uri https://helipad.fiskaltrust.cloud/api/configuration -Method Post -Headers $headers -Body "ESCAPED_TEMPLATE" -ContentType "application/json"
```

--------------------------------

### Saving a table number

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/france/data-structures

Example of serializing a table number into the cbArea field.

```json
"cbArea": "{\"table\" : \"101\"}"  
...  
```

--------------------------------

### Response Payload for /echo

Source: https://docs.fiskaltrust.eu/apis/pos-system-api

Example JSON response structure for the /echo endpoint.

```json
{
  "Message": "string"
}
```

--------------------------------

### Configure logging via command line

Source: https://docs.fiskaltrust.eu/docs/posdealers/technical-operations/middleware/logging

Override configuration settings by passing parameters directly to the Launcher executable.

```bash
C:\>fiskaltrust.exe -verbosity=debug -logfile="C:\log\fiskaltrust\middleware.log"
```

--------------------------------

### GET /v0/print/{ftQueueID}/{ftQueueItemID}

Source: https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/digital-receipt/implementation/digital-receipt-implementation

Obtain the current status of a digital receipt.

```APIDOC
## GET /v0/print/{ftQueueID}/{ftQueueItemID}

### Description
This method is used to obtain the result of the current digital receipt status.

### Method
GET

### Endpoint
https://receipts.fiskaltrust.cloud/v0/print/{ftQueueID}/{ftQueueItemID} (Production)
https://receipts-sandbox.fiskaltrust.cloud/v0/print/{ftQueueID}/{ftQueueItemID} (Sandbox)

### Parameters
#### Path Parameters
- **ftQueueID** (string) - Required
- **ftQueueItemID** (string) - Required

#### Header Parameters
- **cashboxid** (string) - Required
- **accesstoken** (string) - Required

### Response
#### Success Response (200)
- **state** (string) - The current state of the receipt (e.g., "Printed", "Submitted")
- **message** (string) - Status message

#### Response Example
{
    "state": "Printed",
    "message": "Receipt was delivered to ... at 10/24/2023 09:58:21"
}

#### Other Responses
- 400 - Bad request
- 401 - Unauthorized
```

--------------------------------

### GET /api/v0/iatsscd/certificate

Source: https://docs.fiskaltrust.eu/docs/poscreators/signing/austria/api

The certificate method is used to obtain the certificate of the RKSV.Sign service.

```APIDOC
## GET /api/v0/iatsscd/certificate

### Description
The certificate method is used to obtain the certificate of the RKSV.Sign service. The certificate is returned as a Base64-encoded JSON object in the response body.

### Method
GET

### Endpoint
/api/v0/iatsscd/certificate

### Response
#### Success Response (200)
- **certificateBase64** (string) - The service certificate as a Base64-encoded string.

#### Response Example
{
  "certificateBase64": "string"
}
```

--------------------------------

### Execute Firewall Script

Source: https://docs.fiskaltrust.eu/docs/posdealers/technical-operations/troubleshooting/network-troubleshooting

Example command to run the firewall script with a configuration CSV file and the resulting output format.

```powershell
PS C:\fw-script>.\CheckFirewall.ps1 FirewallTests-ft.csv  
CheckFirewall 2.0  
  
Machine name: COMPUTER-NAME  
OS version: 10.0.19044  
Windows name: Windows 10 Enterprise  
Overall connectivity: True  
Active Middleware instances: 0  
  
Name                             Version        Release  
----                             -------        -------  
v2.0.50727                       2.0.50727.4927  
v3.0                             3.0.30729.4926  
Windows Communication Foundation 3.0.4506.4926  
Windows Presentation Foundation  3.0.6920.4902  
v3.5                             3.5.30729.4926  
Client                           4.8.04084      528372  
Full                             4.8.04084      528372  
Client                           4.0.0.0  
  
We're all good!  
Status: (SUCCESS) -- Purpose: ft cashbox download & upload receipt data  
Status: (SUCCESS) -- Purpose: ft download packages  
Status: (SUCCESS) -- Purpose: ft error reporting  
Full Results below:  
  
Url                                        Purpose                                   Notes From  
---                                        -------                                   ----- ----  
https://helipad.fiskaltrust.cloud/version  ft cashbox download & upload receipt data okay  COMPUTER-NAME  
https://packages.fiskaltrust.cloud/version ft download packages                      okay  COMPUTER-NAME  
https://dc.services.visualstudio.com/      ft error reporting                        okay  COMPUTER-NAME  
```
Tokens:
Raw