Using the endpoint
- GET /api/v1/transactions/document/{clientId}/start,
a so-called start document (initial document) is generated by the fiscal service and returned to the upstream system.
Start documents are country-specific documents that are used to initialise (put into operation) the fiscal unit.
Some countries require such a start document by law, as shown in the table below.
| Country | Designation | DocumentTyp |
| Austria | "Startbeleg" - initial receipt | [1000] = NullReceipt |
| Lithuania | initial report (Z) | [99] = EndOfDay |
GET /api/v1/transactions/document/{clientId}/start always generates the start document required in the respective country.
Important: In terms of the standardised interface, the initialisation of a fiscal client always takes place via the process described in the linked article. A start document must therefore be transmitted to the fiscal service in each country.
Note: alternatively to using the endpoint GET /api/v1/transactions/document/{clientId}/start, the respective start document can also be generated by the upstream system (electronic recording system) itself.
Result
If processing is successful (200), the respective fiscal client returns a start document to the previous system.
Usage
- One-time, as part of the commissioning of a Fiscal Client.
Prerequisites
- Fiscal Middleware installed,
- Fiscal Client created and configured, either viar
- PUT /api/v1/management/clients or
- PUT /api/v1/management/clients/byCloud
- cloudConnect successfully executed (only for systems connected to the RetailForce Cloud).
Form fields
The following information must be submitted:
| Designation | Description | Example |
| clientId |
The uniqueClientId of the cash register (from RetailForce system). |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
| bookDate |
Optional: the booking time of the start document |
2023-05-19T10:30:04.297Z |
Response
Possible responses:
| Code | Description | Example |
| 200 | Country-specific start document | - |
Comments
0 comments
Please sign in to leave a comment.