### Example libffi Installation Output Source: https://docs.efsta.eu/efr/CZ Illustrates the expected output when checking for the 'libffi' library installation on a Linux system. This confirms the library is present and provides its version details. ```text ii libffi8:arm64 3.4.4-1 arm64 Foreign Function Interface library runtime ``` -------------------------------- ### Example Location Name Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of location name for configuration. ```json "Nam": "My Location" ``` -------------------------------- ### Example Company Name Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of a company name for configuration. ```json "Nam": "My Company" ``` -------------------------------- ### Example Terminal POS Software Name Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of POS software name. ```json "SW": "My POS Software" ``` -------------------------------- ### Example Location State/Region Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of State/Region for location configuration. ```json "State": "XXX" ``` -------------------------------- ### Example Company City Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of a company city for configuration. ```json "City": "City" ``` -------------------------------- ### Example Location City Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of city for location configuration. ```json "City": "Metropolis" ``` -------------------------------- ### Install EFR on Linux with Systemd Service Source: https://docs.efsta.eu/efr/CZ Automates the setup of EFR as a systemd service on Linux. Ensure you have the necessary user privileges for the service. ```bash install.sh --service --service-user=USER ``` -------------------------------- ### Example Terminal Hardware Brand Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of Hardware brand for terminal configuration. ```json "HW": "POS Brand" ``` -------------------------------- ### EFR State Response with EnvSettings Source: https://docs.efsta.eu/efr/imports/setup-steps/preconfiguration Example response from the GET /state endpoint, highlighting the EnvSettings section which lists configurations applied via environment variables. ```json { "uptime": 162815, "name": "EFR", "version": "2.6.1.1", "Country": "ZZ AT BE DK ES FR HR HU IT LT NO PL PT SE SI SK", "Online": false, "Recorder": "inactive", "RN": "def $001_456 001_1 001_2", ... "EnvSettings": { "def": { "RN_TT": true }, "001_1": { "Sign_require": "FP_T88FVA", "Foo": "Bar", "Sign_Cfg": "COM7:115200" }, "001_2": { "Sign_require": "FP_T88FVA", "Sign_Cfg": "COM5:115200" }, "$001_456": { "Sign_Cfg": "COM5:115200" } } } ``` -------------------------------- ### Example Company Address Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of a company address for configuration. ```json "Adr": "Street" ``` -------------------------------- ### Example E-Invoicing Payment Terms Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of Terms of the payment for e-invoicing. ```json "PaymentTerms": "30 days net" ``` -------------------------------- ### Example Location Address Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of store address for location configuration. ```json "Adr": "Long Road" ``` -------------------------------- ### DEP Export Request Example Source: https://docs.efsta.eu/efr/AT/export Example URL for downloading the Datenerfassungsprotokoll (DEP 7). ```http http://localhost:5618/control/export?from=2017-01-01 ``` -------------------------------- ### Example Company Country Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of a company country (ISO-3166) for configuration. ```json "Ctry": "XY" ``` -------------------------------- ### Example Company Legal Form Configuration (FR) Source: https://docs.efsta.eu/efr/api/rule-set Example of Legal Form in France. ```json "FR_TYPE": "XXX" ``` -------------------------------- ### Example Input Device ID Configuration (DE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Input Device Identification for Germany. ```json "Id": "1" ``` -------------------------------- ### FileWatch Path Example Source: https://docs.efsta.eu/efr/api/additional-functions Example of setting the FileWatch_path attribute to a network path for a watched folder. ```plaintext FileWatch_path=\\share\EFR ``` -------------------------------- ### Real-time Logging Response Example Source: https://docs.efsta.eu/efr/api/additional-functions Example of the JSON response format for real-time log requests. ```json { "Lines":["16:14:37.083 Checkin {\"log\":{\"TY\":\"START_EFR\",… } ``` -------------------------------- ### EFR API GET State Endpoint Source: https://docs.efsta.eu/efr/api This endpoint retrieves the current state information of a running EFR installation. It is a simple GET request to the /state path. ```http GET /state ``` -------------------------------- ### EncryptKey Information Display Example Source: https://docs.efsta.eu/efr/AT/export Example output showing information required for registering a cash register with 'Finanz Online', including user key and checksum. ```text FINANZONLINE.AT - Registrierung einer Registrierkasse UID-Nummer: ATUxxxxxxxx Kassenidentifikationsnummer: 001/1 efsta Datenerfassungsprotokoll: xxxxxxxxxxx Benutzerschlüssel AES-256: 76bn5DeqRkLBg0TCwYKVc6ircRv8V7QiAKFUUZPiKRA= Prüfwert für Benutzerschlüssel: jk16 abgerufen durch: hugo am: 2017-01-10 17:43:21 ``` -------------------------------- ### Get Report State (Germany) Source: https://docs.efsta.eu/management-api/automation-guide Retrieves the current state of a fiscal report identified by its GUID. ```APIDOC ## GET /Fiscal/DE/Reporting/State/{guid} ### Description Retrieves the current processing state of a fiscal report in Germany, identified by its GUID. ### Method GET ### Endpoint /Fiscal/DE/Reporting/State/{guid} #### Path Parameters - **guid** (string) - Required - The globally unique identifier for the report. ### Request Example ``` GET /Fiscal/DE/Reporting/State/GUID12345 api_key: your-api-key-here ``` ``` -------------------------------- ### Get Reporting Data (Germany) Source: https://docs.efsta.eu/management-api/automation-guide Retrieves fiscal reporting data for a specific report identified by its GUID. ```APIDOC ## GET /Fiscal/DE/Reporting/Data/{guid} ### Description Retrieves the data associated with a specific fiscal report in Germany, identified by its GUID. ### Method GET ### Endpoint /Fiscal/DE/Reporting/Data/{guid} #### Path Parameters - **guid** (string) - Required - The globally unique identifier for the report. ### Request Example ``` GET /Fiscal/DE/Reporting/Data/GUID12345 api_key: your-api-key-here ``` ``` -------------------------------- ### Accessing Configuration Data Source: https://docs.efsta.eu/bill/Management/DynamicContent Access configuration data using curly brackets. For example, to get the company label, use {Cfg.Cmp.Label}. ```formula ={Cfg.Cmp.Label} ``` -------------------------------- ### Example Input Device Software Version Configuration (DE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Input Device Software version for Germany. ```json "SWVersion": "1.5.7" ``` -------------------------------- ### Reprint Count Request Example Source: https://docs.efsta.eu/efr/api/additional-functions Requests the reprint count for a transaction identified by TL, TT, and TN. Can be used to GET or POST (increment) the count. ```http http://localhost:5618/jou/reprintcnt?tl=001&tt=1&tn=4711 ``` -------------------------------- ### Example Input Device Hardware Model Configuration (DE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Input Device Hardware model for Germany. ```json "HWModel": "Dev Model" ``` -------------------------------- ### EFR State Endpoint Request Source: https://docs.efsta.eu/efr/CZ Example of a GET request to the /state endpoint. Ensure the Authorization header includes a valid Bearer access token. ```http GET /state [Headers] Authorization: Bearer [ACCESS_TOKEN] ``` -------------------------------- ### Example Input Device Software Name Configuration (DE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Input Device Software name for Germany. ```json "SW": "My Dev Software" ``` -------------------------------- ### SLICE Function Example Source: https://docs.efsta.eu/bill/Management/DynamicContent Extract a portion of a text or list using the SLICE function. Specify the start index and an optional end index (exclusive). ```formula =SLICE('abcde',1,3) ``` -------------------------------- ### Example Terminal POS Software Version Configuration (BE, DE, FR, SE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Cash Register Software Version for Belgium, Germany, France, and Sweden. ```json "SWVersion": "3.2.7" ``` -------------------------------- ### Get Report State (Germany) Source: https://docs.efsta.eu/management-api/automation-guide Check the current status or state of a fiscal report using its GUID. This helps in monitoring the progress of report processing. ```HTTP GET /Fiscal/DE/Reporting/State/{guid} api_key: your-api-key-here ``` -------------------------------- ### Example Terminal Hardware Model Configuration (DE, SE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Hardware model for terminal configuration in Germany and Sweden. ```json "HWModel": "POS Model" ``` -------------------------------- ### Get Reporting Data (Germany) Source: https://docs.efsta.eu/management-api/automation-guide Fetch specific reporting data for a given GUID. This endpoint is used to retrieve the details of a report generated or processed. ```HTTP GET /Fiscal/DE/Reporting/Data/{guid} api_key: your-api-key-here ``` -------------------------------- ### Broken Report Request Example Source: https://docs.efsta.eu/efr/AT/export Example URL for downloading 'Sammelbelege' created after a signature failure. ```http http://localhost:5618/control/broken ``` -------------------------------- ### GET /retrieve – Retrieve Journal Records Source: https://docs.efsta.eu/efr/api/additional-functions Retrieves journal records for backup or closure/balance reporting. It allows specifying a journal, a starting sequence number, and an end sequence number. ```APIDOC ## GET /retrieve – Retrieve Journal Records ### Description This request is intended to do periodical retrieval of records for backup or closure/balance reporting. Retrieval is started with SQ _behind_ the last query parameter, for contiguous processing send the last SQ recently processed. ### Method GET ### Endpoint `/retrieve` ### Query Parameters - **rn** (string) - Optional - Journal to use, default: 'def'. - **last** (integer) - Required - SQ to start reading behind. `last=0` from beginning. - **endSQ** (integer) - Optional - End point sequence number. - **target** (string) - Optional - Folder to store retrieved #######.json files. ### Further Filter Options See 5.4.4 GET /find – Find Journal Record. ### Request Example ``` http://localhost:5618/retrieve?rn=210&_=Tra ``` ### Authentication Local operation only (localhost) or Profile.Password authorization. ### Response Body - XML or JSON data stream. ``` -------------------------------- ### Tax Group Assignment Method 1 Example Source: https://docs.efsta.eu/efr/api/rule-set Assigns tax groups using the 'PosA/Pos/@TaxG' field according to EFR Country Guide definitions. The TaxA array is omitted as tax rates are computed automatically. ```xml ``` -------------------------------- ### Promotion JSON Structure Example Source: https://docs.efsta.eu/bill/Management/SmartBill/Imports This JSON object demonstrates the structure and properties for importing a promotion. Ensure either 'text' or 'imageURL' has valid content for the promotion to be displayed. ```json { "promotionId": "d89ad8b5-9795-475a-a470-61cfc70eb395", "validFrom": "2023-12-01T00:00:00", "validTill": "2024-03-31T00:00:00", "imageURL": "https://efstabill.blob.core.windows.net/assets/TestAssets/promotion_demo_1.png", "text": "Try our new burger and fast food offers with free delivery now. Every Friday 20% discount on your entire order!", "targetURL": "https://www.efsta.eu/produkte/digitaler-beleg/" } ``` -------------------------------- ### Example Location Postcode Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of postcode for location configuration. ```json "Zip": "12345" ``` -------------------------------- ### DEP Export Proof Request Example Source: https://docs.efsta.eu/efr/AT/export Example URL for proving a downloaded DEP Export file, optionally with an EncryptKey. ```http http://localhost:5618/control/proof?file=C:/temp/dep-export.json ``` -------------------------------- ### Company Search Request Example Source: https://docs.efsta.eu/management-api/management-api This example demonstrates how to construct a request body for searching companies. It includes various optional parameters for filtering, sorting, and pagination. ```json { "ParentEntityId": null, "createdAfter": null, "hasUserComment": null, "hasDeactivateAfterTimestamp": null, "searchText": null, "state": null, "countryCode": null, "orderByField": null, "orderDescending": false, "offset": 0, "limit": 100 } ``` -------------------------------- ### Example Input Device Hardware Brand Configuration (DE) Source: https://docs.efsta.eu/efr/api/rule-set Example of Input Device Hardware brand for Germany. ```json "HW": "Dev Brand" ``` -------------------------------- ### Example Company Postcode Configuration Source: https://docs.efsta.eu/efr/api/rule-set Example of a company postcode for configuration. ```json "Zip": "1000" ``` -------------------------------- ### Device Authorization Example Source: https://docs.efsta.eu/efr/api/additional-functions Example of setting the Device_Auth attribute for authorization with external devices using username and password. ```plaintext Device_Auth=username:password ```