Skip to main content

DELETE /api/v1/management/germany/ {clientId}/tse/listTransactions

Harald Krondorfer
  • Updated

The

  • DELETE /api/v1/management/germany/{clientId}/tse/listTransactions

endpoint can be used to close open TSE transactions.

As a general rule, transactions should not be left open. We recommend that all open transactions be closed before a daily closing with either

Attention: please note that document cancellations are (must be) also recorded in the TSE. Therefore, it is also necessary to end each transaction started with PUT /api/v1/transactions/createDocument with "storeDocument" or "cancelDocument". In the case of frequent document cancellations, we cannot rule out the possibility that the tax authorities may ask questions about the reasons for the cancellations in the course of a cash register inspection.

Result

Open TSE transactions are closed collectively with POST /api/v1/transactions/cancelDocument, without the need to close them individually.

Usage

We recommend using this endpoint with caution and only in the event of an error.

The call first generates a query to the TSE as to which transactions are open. The different TSE types (Cloud TSE, Hardware TSE) do not return a complete list of open transactions, but only "packet by packet":

  • swissbit Hardware TSE: 8 transactions each,
  • fiskal Cloud TSE: 100 transactions each

After the TSE has returned the package of open transactions, the contained transactions are closed via an empty document, with the following information:

  • DocumentId: Guid generated by the service
  • DocumentNr: Guid generated by the service
  • DocumentGuid: Guid generated by the service
  • DocumentType: Receipt
  • DocumentTypeCaption: CancelTransaction

If more than the above transactions are open, the endpoint must be called more than once.

All closed transactions are also stored accordingly in the DSFinV-K data.

Prerequisites

  • There are open (started), i.e. not closed, transactions on the TSE.

If a certain number of open transactions is reached, no more transactions can be started on the TSE and the TSE reports an error. You can find more information on this in the article Tse connection error.

You can retrieve the number of open transactions via the endpoint:

Example:

TSE returns the number of started transactions in the field "startedTransactions".

{
   ...
   "startedTransactions": 512,
   "maxStartedTransactions": 512,
   ...
}
Note: only works for hardware TSEs. The limit of simultaneously open transactions of the fiskaly Cloud TSE is 2.000.

Form fields

The following information must be transmitted:

Designation Description Example
clientId

The uniqueClientId of the cash register (from RetailForce system).

 c1062c55-57c4-4ed2-9c53-aff1762326a4

Responses

Possible responses:

Code Description Example
200

fiscalResponse - the open transactions have been successfully closed (cancelDocument)

 -
400

"Tse not connected" - No TSE is connected to the system or assigned to the corresponding client.

Troubleshooting:

  • Checking whether TSE is connected to the system
    e.g.: with GET /api/v1/management/germany/tse
 -
404

"Client was not found" - no configuration exists on this system under the specified clientId

Troubleshooting:

  • Checking the specified clientId
  • Check whether the specified clientId is configured in the middleware (in file fiscalService.config.json under C:\Program Files\RetailForce\Fiscal Webservice\Config)
 -
422

"clientId was set to Guid.Empty"

Troubleshooting: 

  •  
 -
500

"Internal server error" - Other error.

Troubleshooting: 

  • repeat the call,
  • restart the service if necessary,
  • execute cloudConnect.
 -

 

Attention: Regardless of how the error was resolved, we recommend that you carefully analyse the reason why TSE transactions remain open. In the regular checkout process, all open transactions should be closed before a daily closing.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk