This endpoint is the first step in the transmission of transactions from the electronic recording system ("cash register") to the Fiscal Service. The process always consists of two steps. This two-step process of transaction transmission is based on the requirements of the Cash Register Anti Tampering Ordinance in Germany and must be carried out in all fiscal countries in the sense of a standardised interface. In Germany, when PUT /api/v1/transactions/createDocument is called, a transaction is registered in the so-called Technical Security Device (TSE/TSS).
Transaction registration
A transaction/document is registered in the fiscal unit:
- PUT /api/v1/transactions/createDocument and
- POST /api/v1/transactions/storeDocument
Transaction abort
This registers the termination of a transaction in the fiscal unit:
- PUT /api/v1/transactions/createDocument and
- POST /api/v1/transactions/cancelDocument
Note: all transactions started with PUT /api/v1/transactions/createDocument must be closed with either POST /api/v1/transactions/storeDocument or POST /api/v1/transactions/cancelDocument! Please note listTransactions (DELETE).
Result
A successful call to the endpoint (200)
- registers the start of a transaction in the fiscal unit and
- returns a fiscalResponse to the upstream system (electronic record system).
Usage
- each time a new transaction is to be sent to the fiscal unit, before POST /api/v1/transactions/storeDocument or POST /api/v1/transactions/cancelDocument.
Prerequisites
- Fiskal Client initialised
Form fields
The following information must be sent:
Designation | Description | Example |
clientId |
The uniqueClientId of the cash register (from RetailForce system). |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
documentType |
The type of document to be registered. Enum:
|
- |
Response
Possible responses:
Code | Description | Example |
200 |
The transaction has been started and a fiscalResponse is returned to the upstream system |
- |
Comments
0 comments
Please sign in to leave a comment.