The
- POST /api/v1/management/clients/initialize
endpoint is used to
- initialise the fiscal unit (client),
- any required fiscal hardware (signature creation unit, technical security device, control unit, fiscal printer/box,...) and
- to register the electronic recording system (cash register) with the fiscal authorities. (e.g. registration process at FinanzOnline - Austria)
Result
In the event of successful processing (200),
- the corresponding Fiscal Client and
- any Fiscal hardware required are put into operation and configured and
- (if necessary / available in the respective country) the cash register is registered with the tax authority.
Usage
- One-time, as part of the commissioning of a fiscal client.
Prerequisites
- Fiscal Middleware installed,
- Fiscal Client created and configured, either via
- PUT /api/v1/management/clients or
- PUT /api/v1/management/clients/byCloud
- cloudConnect successfully executed (only for systems connected to the RetailForce Cloud).
- Start document was created; either via GET /api/v1/transactions/document/{clientId}/start or by the upstream system itself.
Form fields
A start document must be sent to the endpoint.
When GET /api/v1/transactions/document/{clientId}/start was called, a start document was returned to the host system as a response. This can now be sent to the POST /api/v1/management/clients/initialize endpoint.
Alternatively, the required start document can be created by the upstream system itself.
Responses
Possible responses:
Code | Description | Example |
200 |
The start document was transmitted successfully and without errors and saved in the documentStore. Furthermore, a fiscalResponse is returned to the upstream system. This should be stored in the upstream system's journal for reference purposes. |
fiscalResponse |
204 |
The start document was transmitted successfully and without errors and saved in the documentStore. In some countries, no fiscalResponse is transmitted upon successful commissioning. |
- |
422 |
The start document does not correspond to the requirements of the respective country or the ClientId is missing in the start document. Troubleshooting:
|
- |
500 |
Validation error in the start document or the clientId transmitted in the start document is not found in the ConfigStore. Troubleshooting:
|
- |
Comments
0 comments
Please sign in to leave a comment.