This endpoint can be used to download data previously archived with POST /api/v1/archive/de/{clientId} from the RetailForce Secure Archive.
Generally, the ARCHIVE section of the middleware API (swagger) is used to submit (or download) data to the RetailForce Secure Archive without using fiscalisation.
The use of the functions / endpoints in this area is only necessary if fiscalisation is deactivated via the RetailForce Middleware, i.e. NOT used.
For data archiving within the scope of fiscalisation, only a corresponding licence is necessary (assignment via configuration).
Result
A successful call to the endpoint (200) downloads the corresponding data from the Secure Archive.
Usage
Each time data is to be downloaded from the archive.
Prerequisite
- RetailForce (Fiscal) Middleware installed,
- Client initialized,
- Prior data transfer to the Secure Archive via POST /api/v1/archive/en/{clientId.
Form fields
The following parameters must be transmitted:
Designation | Description | Example |
clientId |
The uniqueClientId of the cash register (from RetailForce system). |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
fromDate |
Selection of data for download: Data as of this date |
2022-01-17 |
tillDate |
Selection of data for download: Data up to this date |
2022-12-31 |
destinationFolder |
Destination folder in which the data is to be saved. Attention: folder must exist!
|
C:\temp |
Response
Possible respons:
Code | Description | Example |
200 |
Data was successfully downloaded |
- |
Comments
0 comments
Please sign in to leave a comment.