POST /api/v1/archive/de/{clientId} – RetailForce Software GmbH

The ARCHIVE area of the Middleware API (swagger) is used to transmit (and 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). Uploading of fiscal data to the Cloud archive is than handled automatically by the fiscal middleware.

The

POST /api/v1/archive/de/{clientId}

endpoint is used to transfer data to the RetailForce cloud archive.

Result

A successful call to the endpoint (200) transmitted the corresponding data to the Secure Archive.

Usage

Every time data is to be transmitted to the archive for backup.

Prerequisites

RetailForce (Fiscal) middleware installed and
Client initialised,

Request

Form fields

The following parameters must be submitted:

Designation	Description	Example
clientId	The uniqueClientId of the cash register (from RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Request body

Data to be transmitted to the archive must be specified accordingly. This is done via the payload described below in the request.

Example:

[
  {
    "type": 0,
    "container": "string",
    "entity": "string",
    "recursive": true
  }
]

Information in "Type" column:

M ... mandatory / requird
M* ... mandatory / requird in certain countries or under certain conditions
R ... recommended
O... optional

Elements	Type	Description
type	M	Definition of the type of data to be transferred to the archive. Types: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Backup data (miscellaneous) Hinweis: Die Dateigrößen sind wie folgt beschränkt: Typ 0: 200kB Typ 1: 200kB Typ 2: 10MB
container	M*	The name (designation) of the container (.zip file) Note: ONLY if Type = 2 ("type": 2,)
entity	M*	Data to be transferred to the archive (file or folder!).
recursive	M*	true if subfolders are also to be transmitted, otherwise false. Not applicable if the entity is NOT a folder! Note: ONLY if Type = 2 ("type": 2,)

Response

Possible responses:

Code	Description	Example
200	Data was successfully transmitted	-