Über die VAT-Compliance-Schnittstelle kann die erforderliche Organisationsstruktur im RetailForce Portal automatisch angelegt werden.
Dazu muss das Vorsystem die zur Erstellung der entsprechenden Entitäten erforderlichen Informationen im Document Payload bereitstellen.
Voraussetzungen
Damit die automatische Erstellung der Struktur funktioniert, müssen die folgenden Voraussetzungen erfüllt sein.
- Organisation angelegt,
- Serverkonfiguration angelegt,
- Konfiguration angelegt,
- Lizenzen zugewiesen,
- Konfiguration der Organisation zugewiesen.
Organisation
Die Organisation muss bereits im RetailForce Cloud Portal vorhanden sein, da sich die Payload-Daten aus dem Vorsystem beim Anlegen einer neuen Struktur auf eine vorhandene "OrganisationId" beziehen müssen.
Hinweis: Es ist nicht möglich, Companies über diesen Mechanismus anzulegen.
Serverkonfiguration
Es muss eine Serverkonfiguration angelegt sein, die den richtigen 'Connection type' verwendet.
Konfiguration
Es muss eine Konfiguration angelegt sein, die:
- mit der Serverkonfiguration verknüpft ist,
- über zugewiesene Lizenzen verfügt,
- der jeweiligen Organisation zugeordnet ist.
Payload aus dem vorgelagerten System
Über die Payload-Daten aus dem Vorsystem können sowohl ein neuer Speicherort als auch ein neues Terminal angelegt werden. Dazu müssen die Payload-Daten folgende Informationen enthalten:
- "OrganisationId",
- Store-Informationen,
- Terminal-Informationen.
OrganisationId
Die „OrganisationId“ muss sich auf die im RetailForce Cloud Portal angelegte Organisation beziehen. Sie wird auch als „LicenseConsumerId“ bezeichnet und ist im Portal in den Eigenschaften der Organisation zu finden.
"OrganisationId": 7417eb48-3cca-4882-88b9-df44241908d6,
Store Informationen
Mögliche Eigenschaften zum Anlegen eines neuen Stores.
"Store": {
"StoreId": "00000000-0000-0000-0000-000000000000"
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"CompanyId": null,
"StoreNumber": "003",
"Caption": "Teststore 003",
"FiscalRegion": null,
"Telephone": null,
"Fax": null,
"EMail": null,
"OpeningDate": null,
"ClosingDate": null,
"HiddenDate": null,
"UpdatedByPrincipalId": null,
"OpeningHoursMonday": null,
"OpeningHoursTuesday": null,
"OpeningHoursWednesday": null,
"OpeningHoursThursday": null,
"OpeningHoursFriday": null,
"OpeningHoursSaturday": null,
"OpeningHoursSunday": null,
"ClientConfigurationId": null,
"NewClientConfigurationId": null,
"NewClientConfigurationValidFrom": null,
"Street": "Av. Gustave Eiffel",
"StreetNumber": "-",
"PostalCode": "75007",
"City": "Paris",
"CountryCode": "FRA"
},Angaben in der Spalte „Typ“:
- M … erforderlich ("obligatorisch")
- M* … in bestimmten Ländern oder unter bestimmten Bedingungen erforderlich
- R … empfohlen
- O … optional
| Element | Typ | Beschreibung | |
| Store |
| Store-Daten | |
| StoreId | M | Sollte ein neuer Store angelegt werden, verwenden Sie "00000000-0000-0000-0000-000000000000" im ersten UND in allen folgenden payloads. | |
OrganisationId | M | ID der Organisation; nicht erforderlich, da die Eigenschaft "OrganisationId" außerhalb des Store-Objekts bereits auf die jeweilige Organisation verweist. Verwenden Sie stets: „00000000-0000-0000-0000-000000000000“ | |
CompanyId | O | nicht erforderlich; kann verwendet werden, wenn unterhalb der Organisation ein Unternehmen angelegt wurde. | |
StoreNumber | M | Nummer des Stores / der Filiale. | |
Caption | M | Bezeichnung ddes Stores / der Filiale. | |
FiscalRegion | M* | Nur erforderlich in Ländern, in denen unterschiedliche Fiskal Regionen existieren (z. B. Spanien). | |
Telephone | O | Kontaktdaten des Stores / der Filiale: Telefonnummer. | |
| Fax | O | Kontaktdaten des Stores / der Filiale: Faxnummer. | |
O | Kontaktdaten des Stores / der Filiale: E-Mail-Adresse. | ||
OpeningDate | M* | Nur in Ländern erforderlich, in denen ein Eröffnungsdatum angegeben werden muss (z. B. Slowenien). | |
| ClosingDate | O | Soll nicht angegeben werden, da es sich um das endgültige Schließungsdatum einer Geschäftsstelle handelt. | |
| HiddenDaten | O | Soll nicht angegeben werden; bezeichnet das Datum, an dem das Geschäft im Portal ausgeblendet wurde, da alle zugehörigen Terminals außer Betrieb genommen wurden. | |
UpdatedByPrincipalId |
| Darf nicht angegeben werden. | |
OpeningHoursMonday | O | Öffnungszeiten am Montag. | |
OpeningHoursTuesday | O | Öffnungszeiten am Dienstag. | |
OpeningHoursWednesday | O | Öffnungszeiten am Mittwoch. | |
OpeningHoursThursday | O | Öffnungszeiten am Donnerstag. | |
OpeningHoursFriday | O | Öffnungszeiten am Freitag. | |
OpeningHoursSaturday | O | Öffnungszeiten am Samstag. | |
OpeningHoursSunday | O | Öffnungszeiten am Sonntag. | |
ClientConfigurationId | O | ID der Konfiguration, optional. | |
NewClientConfigurationId | O | ID einer neuen Konfiguration, nicht erforderlich. | |
NewClientConfigurationValidFrom | O | Datum, ab dem eine neue Konfiguration gültig wird. | |
Street | M | Straßenname des Stores / der Filiale. | |
StreetNumber | M | Hausnummer des Stores / der Filiale. | |
PostalCode | M | Postleitzahl des Stores / der Filiale. | |
City | M | Ort des Stores / der Filiale. | |
CountryCode | M | Ländercode (ISO 3166-1 Alpha-3). | |
Store Parameter
In Ländern, in denen dies technisch möglich ist – z. B. in Frankreich, Slowenien, Kroatien und anderen – können optionale Store-Parameter konfiguriert werden.
"StoreParameters": [
{
"ParameterName": "SIRET_STOREPARAMETER",
"ParameterValue": "123456789",
"ParameterEncrypted": false,
"ParameterOnlyServer": false
}
]Angaben in der Spalte „Typ“:
- M … erforderlich ("obligatorisch")
- M* … in bestimmten Ländern oder unter bestimmten Bedingungen erforderlich
- R … empfohlen
- O … optional
| Elemente | Typ | Beschreibung | |
| StoreParameters |
| ||
| ParameterName | O | Bezeichnung des Parameters. | |
| ParameterValue | O | Wert des Parameters. | |
| ParameterEncrypted | O | Schalter, der angibt, ob der Parameter verschlüsselt ist. | |
| ParameterOnlyServer | O | Schalter, der angibt, ob der Parameter ausschließlich in der Serverkonfiguration verwendet wird. | |
Terminal Informationen
Mögliche Eigenschaften zum Anlegen eines neuen Terminals.
"Terminal": {
"TerminalId": "00000000-0000-0000-0000-000000000000",
"StoreId": "00000000-0000-0000-0000-000000000000",
"TerminalNumber": "009",
"FiscalCountry": null,
"Caption": "Testterminal 003/009",
"PlatformType": null,
"IsTest": true,
"IsDisabledGetConfigurationLimit": null,
"ArchiveDate": null,
"ClientConfigurationId": null,
"NewClientConfigurationId": null,
"NewClientConfigurationValidFrom": null,
"GlobalShortId": null,
"PurchaseDate": null,
"TerminalType": null,
"UpdatedByPrincipalId": null,
"CashRegisterId": null,
"CashRegisterBrand": null,
"CashRegisterModelname": null,
"CashRegisterSerialNumber": null,
"CashRegisterSoftwareBrand": null,
"CashRegisterSoftwareVersion": null,
"CashRegisterSoftwareCompany": null,
"CommissioningDate": null
},Angaben in der Spalte „Typ“:
- M … erforderlich ("obligatorisch")
- M* … in bestimmten Ländern oder unter bestimmten Bedingungen erforderlich
- R … empfohlen
- O … optional
| Elemente | Typ | Beschreibung | |
| Terminal |
| Terminal-Informationen | |
TerminalId | M | Soll ein neues Terminal angelegt werden, verwenden Sie „00000000-0000-0000-0000-000000000000“ im ersten UND in allen folgenden Payloads. | |
StoreId | M | Verwenden Sie stets „00000000-0000-0000-0000-000000000000“. | |
TerminalNumber | M | Kassennummer innerhalb der Filiale. | |
FiscalCountry | O | nicht erforderlich. | |
Caption | R | Bezeichnung der Registrierkasse. | |
PlatformType | M* | Nur in bestimmten Ländern (z. B. Deutschland) obligatorisch. | |
IsTest | M |
| |
IsDisabledGetConfigurationLimit | O | Nur für Test-Terminals möglich („IsTest“: true). | |
ArchiveDate | O | Nicht angeben; gibt an, wann das Terminal außer Betrieb genommen und archiviert wurde. | |
ClientConfigurationId | O | ID der Konfiguration, nicht erforderlich. | |
NewClientConfigurationId | O | ID einer neuen Konfiguration, nicht erforderlich. | |
NewClientConfigurationValidFrom | O | Datum, ab dem eine neue Konfiguration gültig wird. | |
GlobalShortId |
| Globale Kurz-ID des Terminals; kann nicht festgelegt werden, wird vom RF-System zugewiesen. | |
PurchaseDate | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
TerminalType | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
UpdatedByPrincipalId |
| Darf nicht angegeben werden. | |
CashRegisterId | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CashRegisterBrand | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CashRegisterModelname | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CashRegisterSerialNumber | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CashRegisterSoftwareBrand | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CashRegisterSoftwareVersion | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CashRegisterSoftwareCompany | M* | Nur in bestimmten Ländern obligatorisch (z. B. Deutschland) | |
CommissioningDate |
| Darf nicht festgelegt werden! | |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.