PUT /api/v1/management/clients/ byCloud – RetailForce Software GmbH

Mit diesem Endpunkt wird ein neuer Mandant (Client) in der Fiskal Middleware erzeugt und mit einem in der "Terminal" in der RetailForce Cloud verknüpft. Es stellt den ersten Schritt bei der Inbetriebnahme einer neuen Kasse dar.

Ergebnis

Ein erfolgreicher Aufruf des Endpunktes (200)

erzeugt einen neuen Client in der Middleware und weist diesem die uniqueClientId des Terminals (Cloud) zu.
lädt das Konfigurationsobjekt aus dem Cloud-System herunter und konfiguriert den Client dementsprechend.

Verwendung

Einmalig, wenn eine neue Kasse in Betrieb genommen wird. Ein erneuter Aufruf des Endpunktes für den selben Client (clientId) führt zu einem Fehler!

ACHTUNG: wenn ein bestimmter Client bereits einmal mit dem in der Cloud angelegten Terminal verbunden wurde (Zuweisung uniqueClientId), führt ein erneuter Aufruf des Endpunktes zu einer Fehlermeldung: "409 - Client already exists"). Wenn ein Client erneut erzeugt werden muss (z.B. Festplattendefekt, etc.), muss der Endpunkt /api/v1/management/clients/recovery/restoreByCloud verwendet werden.

Voraussetzungen

Organisationsstruktur und Konfigurationsobjekt wurden in der RetailForce Cloud erstellt und entsprechend zugewiesen
Fiskal Middleware installiert

Formularfelder

Folgende Informationen müssen übermittelt werden:

Bezeichnung	Beschreibung	Beispiele
Type	Typ der Unternehmensidentifikation. Der Type muss auch in der RetailForce Cloud eingetragen worden und vorhanden sein. Folgende Typen stehen zur Verfügung: [0] = VatNumber, [1] = TaxNumber, [2] = GlnNumber, [3] = BusinessIdentificationNumber, [4] = Statistical classification, [5] = CommercialRegisterNumber, [6] = CommercialRegisterNumberOffice, [7] = TradeRegisterNumber Siehe auch: Unternehmensidentifikation Wir empfehlen Typ [0] = VatNumber als primäre ID in allen Ländern (EU) zu verwenden, auch wenn diese nicht als verpflichtendes Unternehmenskennzeichen im jeweiligen Land verwendet wird.	[0] = VatNumber
Identification	Das Unternehmenskennzeichen selbst. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen.	ATU57780814
storeNumber	Die Nummer der Filiale, in welcher sich die Kasse befindet. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen. ACHTUNG: in Frankreich ist hier die SIRET (Erweiterung der SIREN um die Filialnummer) anzugeben.	S001, 12345 etc.
terminalNumber	Kassennummer. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen.	0010
cloudApiKey	API Key um die Cloud-Kommunikation zu authentisieren	RFC_4a2abc...
cloudApiSecret	API Secret zur Authentisierung der Cloud-Kommunikation	ypts7u5OU...

Antwort

Mögliche Antworten:

Code	Beschreibung	Beispiel
200	Der Client wurde erfolgreich erzeugt und konfiguriert. Als Response-Objekt wird die uniqueClientId zurückgegeben. Die uniqueClientId muss vom Kassensystem gespeichert und für den gesamten weiteren Kommunikations-Prozess (den Client betreffend) vom Kassensystem verwendet werden.	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	In der RetailForce Cloud wurde keine Organisation zum angegebenen Unternehmenskennzeichen gefunden. Fehlerbehebung: Prüfung des Unternehmenskennzeichens in RetailForce Cloud und an der Kasse Anlage des Unternehmens (Organisation oder Company) in RetailForce Cloud	-
406	Aufgrund des angegebenen Typs (Unternehmenskennzeichen) ist kein eindeutige Zuordnung möglich (z.B. bei Angabe von [6] = CommercialRegisterNumberOffice) Fehlerbehebung: Verwendung eines anderen Kennzeichen-Typs (z.B. [0] = VatNumber)	-
409	Es existiert bereits ein Client mit der betreffenden uniqueClientId im Fiskal Service (Fiskal Middleware) Fehlerbehebung: Verwendung des bestehenden Clients	-