RetailForce Fiscal Service - API Description

Books the opening stock for a cash register closing statement. Books just a pay-in, does not resettle the cash stock.

Alternative: As an alternative the cash register can also book a document: documentType [11] = PayIn.

Books a cash difference to the fiscalisation system.

Alternative: As an alternative the cash register can also book a document with BusinessTransactionType [91] = CashDifference.

Books a money transfer from cash register system to bank (or any other destination).

Returns the actual stock of payments of a specific client. This is calculated on the basis of the documents transmitted (in addition to sales and returns receipts, deposits and withdrawals, etc.).

Checks the actual stock of the payments for this cash register and returns a list of payments with difference (or an empty list if there's no difference).

Closes the actual day with a closing statement.

Closing is done based on the documents sent to the client since the last closing. The cash register system does not receive closing statement in return!

Returns the end of day document for the actual day.

The returned document must be stored (storeDocument > documentType 99)

Returns date and time of the last closing of a specific client (terminal)

Returns information on whether or not a daily closing is to be made at a particular terminal. (Depending on RetailForce.Fiscalisation.Implementation.
IFiscalCountryProperties.
MaximumHourIntervalForClosing).

Creates a new client in the configuration store. Configuration object must be prepared by POS-System.

Configuration of a client is required for operation. Use either this endpoint, or:

• PUT /api/v1/management/clients, or
• PUT /api/v1/management/clients/
  byCloud/id.

Updates a client configuration created by the cash register system in the configuration store.

Returns all clients listed in the configuration store.

Can also be used when using cloud configuration.

Creates a new client with a configuration prepared in the cloud / or loads an existing client.

Configuration of a client is required for operation. Use either:

• this endpoint, or
• PUT /api/v1/management/clients, or
• PUT /api/v1/management/clients/
  byCloud/id.

Creates a client loading the configuration data from the cloud.

Alternative: alternative endpoint to PUT /api/v1/management/clients and PUT /api/v1/management/clients/byCloud.

Updates the client configuration by getting the client configuration from cloud.

Is used, when the configuration prepared in the cloud has been updated an should be downloaded anew by the fiscal client (update).

Creates a new client at the fiscal module management and adds this client to the cloud configuration.

Client is created in the local configuration store and configuration object is then uploaded to cloud system.

Note: The distributor must be set in the client data and the distributor must be allowed to create new clients.

Established cloud connection of the specific client and loads the trusted fiscal module into cache.

Required for systems using cloud functions.

Necessary after each restart of the POS-system.

Updates the current license key in fiscal client configuration (also on disk). Required, if licenses in cloud configuration have been changed.

Method to start or stop cloud queue processing (for all clients).

Stop command stops processing after finishing the actual upload.

Start starts queue processing immediately.

If cloud queue processing is stopped, you have to restart it unless the service is restarted (than cloud processing is activated again).

Returns the client configuration of a specific client.

Deletes a specific client

Attention: use with caution!

Returns the unique client id for the requested parameters.

Different parameters can be used to request the uniqueClientId.

Returns the license consumer id for the given company identification.

Only licenseConsumerId's which are already stored in the config store are returned.

Validates the given client information to fulfill necessary country-specific configuration.

Is used to validate a configuration created by the cash register system before using /api/v1/management/clients.

Validation of cloud configuration is provided in the cloud system.

Initializes fiscalisation unit (and possible hardware, and possible declaration to financial authorities).

Initialization is done via start receipt (initial receipt) which can be either queried using endpoint GET /api/v1/transactions/document/
{clientId}/start, or start document is created by the cash register system.

Migrates a client from different fiscalization provider.

Is used when switching form a different fiscal middleware provider to RetailForce

Please note supported systems.

Migrates a client from different fiscalization provider and performs a file import.

Please note supported systems!

Decommission of fiscal client (and possible hardware, and possible declaration to financial authorities).

Uploads a support package (log-files) to the cloud for the given client.

This endpoint is necessary in order to use “Upload support package” function in cloud system.

Backups a client to the given filename (zip-file backup).

If cloud upload is in use, cloud queue processing will be stopped and started (and cloud queue will be reinitialized).

Attention: Please note if the client is not removed that cloud queue process will resume after backup. If any files have not been before backup, they are part of the backup too and will be possibly uploaded twice in case the client is restored.

Restores a client (with all data) from the given backup zip-file.

Creates a new client with configuration from the cloud / or loads an existing client.

Creates a new client with configuration from the cloud / or loads an existing client.

Generates a new, or returns an existing, globally unique ID for the respective client. In addition, the issuing of the retailForceReceiptId is activated for the respective client.

Stores an external certificate to the fiscal module certificate store.

Required for systems NOT using RetailForce Cloud functions in fiscal countries where software certificates are used in the context of fiscalisation (Slovenia, Croatia, Spain,…)

Returns whether the requested client has the requested access license.

Returns whether the requested client has the requested license.

Creates an AES user key for this client and returns it. AES key will also be stored to client configuration.

Note: AES user key will be created automatically by fiscal client. Endpoint only necessary if AES key should be created manually.

Returns the aes key for the given client.

Exports all receipt lines of local Data Collection Log (DEP §7 RKSV) store data.

Required for offline systems (systems NOT using cloud archiving of fiscal data).

Exports all data requested for DEP131 (DEP §131 BAO) protocol out of local stored data.

Returns the start receipt for this client.

Cash register system needs to be able to provide initial receipt (start receipt) on request during a fiscal audit, if POS system did not store initial receipt, it can be requested using this endpoint.

Returns all month receipts in the requested date frame.

Cash register system needs to be able to provide monthly receipts on request during a fiscal audit, if POS system did not store these documents, they can be requested using this endpoint.

Returns all signature devices and if they are activated at FinanzOnline (FON) or not.

Registers the configured signature device at FON (if one is configured) or the signature device identified with certificateSerial.

Note: If RetailForce Cloud Services are use, certificates are automatically registered in FinanzOnline portal (FON) (à credentials for cash register webservice user necessary!); endpoint only necessary if registration should be done manually.

Unregister the configured signature device at fon (if one is configured) or the signature device identified with certificateSerial.

Attention: use with caution!

Validates the last signed document in dep at FinanzOnline (FON).

Validates the given dep document (qr code) at FON.

Returns whether the cash register of the actual client is activated at FON.

Required for offline systems.

Register of cash register system at FON for the actual client.

Required for offline systems.

Unregister cash register at fon for the actual client.

Required for offline systems.

Attention: use with caution!

Sends closing command (Z) to the fiscal printer.

Sends time synchronize command (L) to the fiscal printer.

This function can be used to generate a so-called KLEN report.

(from v1.8.3)

This function is used to print

• detailed and
• summarised period reports.

(from v1.8.3)

This function is used to print out a so-called BLOCK report.

(from v1.8.3)

Exports denmark SAF-T format to the given stream.

Returns all audit log entries requested by date.

Returns the local stored archives for closing.

Method to verify the french archive.

Returns an array of attached local tse devices and their status.

Runs a synchronous self test for the given cash register on the tse (cash register is optional).

Does a test connection to the given TSE.

Returns all clients listed on the tse of the given client.

Returns the status of the tse. If no fiscal module is found à status RetailForce.Fiscalisation.Implementation.
Germany.Tse.TseStatus.Critical is returned.

Updates the time on the tse to the actual computer time.

Exports the tar files from the primary tse.

Required for offline systems.

Exports taxonomy (DSFinV-K export) and returns it as a download file (zip file format).

Required for offline systems.

Returns all active (started) transactions on the tse.

Recommended to track open transactions (all started transactions need to be stored or cancelled).

Cancels active (started) transactions on the tse.

Returns the number of offline transactions (= transactions which have not been sent to TSE due to and offline TSE – broken unavailable).

Returns all open offline signatures stored for the actual TSE.

Process open offline signatures.

Replaces a current TSE for the given client with a new one (for instance if old TSE is damaged or certificate has expired).

Runs a synchronous self test for the given cash register on the TSE (cash register is optional).

Updates the firmware at the swissbit hardware TSE device.

Returns the stored ticketBai files (sent files, answer files, error files) as zip file.

Returns the stored ticketBai files for requested document number (sent files, answer files, error files) as zip file.

Uploads a digital receipt file to the cloud system.

Alternative: Use either this or the alternative endpoint within this section to send digital receipts data.

Uploads a digital file to the cloud system. Using metadata of fiscalisation.

Alternative: Use either this or the alternative endpoint within this section to send digital receipts data.

Creates a document at fiscalisation unit. This method does not create a document itself it just starts the process for instance on the TSE.

Stores a document to the fiscalisation unit.

Cancels a document on the fiscalisation unit.

Method to store reprint count of a document using the stored document (reference: documentGuid).

Alternative: alternatively use PUT /api/v1/transactions/reprintDocument

Method to store the reprint count of a document sending the document again. The user of the transferred document must be the reprinting user (not the user of the original document).

Alternative: alternatively use PUT /api/v1/transactions/reprintDocument/
{clientId}/{documentGuid}.

Reverts a document (turns all values negative).

Validates the document and returns all validation errors (and empty list if there's no validation error).

Send document json to service for document validation.

Returns a start document for the given client.

Start document is used to initialize the client as well as the fiscal unit (/api/v1/management/clients/initialize).

Display text on fiscal customer display.

Only supported in countries which uses fiscal customer display. In other countries this call does not do anything (but can be called).

Opens a drawer if drawer is attached to fiscal printer.

Returns qr code data as base 64 encoded string from data.

Adds an audit log to the fiscal client.

Returns all audit records queried by fromDate/tillDate.

Returns the requested document if stored in the internal storage.

Returns whether the requested document exists in the internal document store.

Returns the requested document if stored in the internal storage.

Returns whether the requested document exists in the internal document store.

Returns the last stored document from document store.

Returns the requested document if stored in the internal storage.

Returns the requested document response if stored in the internal storage.

Returns the requested document response if stored in the internal storage.

Returns the requested document if stored in the internal storage.