The VAT Compliance interface can be used to automatically create the necessary organisational structure in the RetailForce Portal.
To do this, the source system must include the information required to create the relevant entities in the document payload.
Prerequisits
For the automatic creation of the structure to work, the following prerequisites must be met.
- Organisation created,
- server configuration created,
- configuration created,
- licenses assigned,
- configuration assigned to organisation.
Organisation
The organisation must already exist in the RetailForce Cloud Portal, as the payload from the upstream system must refer to an existing "OrganisationId" when creating a new structure.
Note: it is not possible to create Companies via this mechanism.
Server Configuration
A server configuration must be created which uses the correct 'Connection type'.
Configuration
A configuration must be created, which:
- is linked to the Server Configuration,
- has assigned licenses,
- is assigned to the resp. organisation.
Payload from Upstream system
Via the payload from the upstream system a new store as well as as new terminal can be created. Therefor the payload must contain the following information:
- "OrganisationId",
- Store information,
- Terminal information.
OrganisationId
The "OrganisationId" bust refer to the Organisation created in the RetailForce Cloud Portal. It is also called "LicenseConsumerId" and can be found in the Portal in the Organisation's properties.
"OrganisationId": 7417eb48-3cca-4882-88b9-df44241908d6,
Store information
Possible properties for creating a new store.
"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"
},Information in the "Type" column:
- M ... required ("mandatory")
- M* ... required in certain countries, or under certain conditions
- R ... recommended ("recommended")
- O ... optional
| Element | Type | Description | |
| Store |
| Store information | |
| StoreId | M | If a new store should be created, use "00000000-0000-0000-0000-000000000000" in the first AND in all following payloads. | |
OrganisationId | M | ID of the Organisation, not necessary, as the "OrganisationId" property outside the store-object already refers to the resp. Organisation. Always use: "00000000-0000-0000-0000-000000000000" | |
CompanyId | O | not required, can be used if a Company was created below the Organisation. | |
StoreNumber | M | Number of the store / branch. | |
Caption | M | Designation of the store / branch. | |
FiscalRegion | M* | Only required in countries where fiscal regions exist (e.g. Spain). | |
Telephone | O | Contact information of the store: Phone number. | |
| Fax | O | Contact information of the store: Fax number. | |
O | Contact information of the store: email address. | ||
OpeningDate | M* | Only required in countries where a store-opening-date must be specified (e.g. Slovenia). | |
| ClosingDate | O | Should not be specified, as it represents the final closing date of a business premise (when the store was closed for good). | |
| HiddenDaten | O | Should not be specified, represents the date when the store was hidden in the Portal because all underlying terminals were decommissioned. | |
UpdatedByPrincipalId |
| Must not be specified. | |
OpeningHoursMonday | O | Opening hours Monday. | |
OpeningHoursTuesday | O | Opening hours Tuesday. | |
OpeningHoursWednesday | O | Opening hours Wednesday. | |
OpeningHoursThursday | O | Opening hours Thursday. | |
OpeningHoursFriday | O | Opening hours Friday. | |
OpeningHoursSaturday | O | Opening hours Saturday. | |
OpeningHoursSunday | O | Opening hours Sunday. | |
ClientConfigurationId | O | Id of the configuration, not required. | |
NewClientConfigurationId | O | Id of a new configuration, not required. | |
NewClientConfigurationValidFrom | O | Date as of which a new configuration becomes valid. | |
Street | M | Street name of store / branch. | |
StreetNumber | M | Street number of store / branch. | |
PostalCode | M | Postal code of store / branch. | |
City | M | City of store / branch. | |
CountryCode | M | Country Code (ISO 3166-1 Alpha-3). | |
StoreParameters
Optional store parameter can be set, in countries where this is possible, e.g. France, Slovenia, Croatia and others.
"StoreParameters": [
{
"ParameterName": "SIRET_STOREPARAMETER",
"ParameterValue": "123456789",
"ParameterEncrypted": false,
"ParameterOnlyServer": false
}
]Information in the "Type" column:
- M ... required ("mandatory")
- M* ... required in certain countries, or under certain conditions
- R ... recommended ("recommended")
- O ... optional
| Elements | Type | Description | |
| StoreParameters |
| ||
| ParameterName | O | Designation of the parameter. | |
| ParameterValue | O | Value of the parameter. | |
| ParameterEncrypted | O | Switch if parameter is encrypted. | |
| ParameterOnlyServer | O | Switch if parameter is only used in server configuration. | |
Terminal information
"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
},Information in the "Type" column:
- M ... required ("mandatory")
- M* ... required in certain countries, or under certain conditions
- R ... recommended ("recommended")
- O ... optional
| Elements | Type | Description | |
| Terminal |
| Terminal information | |
TerminalId | M | If a new terminal should be created, use "00000000-0000-0000-0000-000000000000" in the first AND in all following payloads. | |
StoreId | M | Always use "00000000-0000-0000-0000-000000000000". | |
TerminalNumber | M | Cash register number within the store. | |
FiscalCountry | O | not required. | |
Caption | R | Designation of the cash register. | |
PlatformType | M* | Only mandatory in certain countries (e.g. Germany). | |
IsTest | M |
| |
IsDisabledGetConfigurationLimit | O | Only possible for test-terminals ("IsTest": true). | |
ArchiveDate | O | Do not specify, indicates when terminal was decommissioned, and archived. | |
ClientConfigurationId | O | Id of the configuration, not required. | |
NewClientConfigurationId | O | Id of a new configuration, not required. | |
NewClientConfigurationValidFrom | O | Date as of which a new configuration becomes valid. | |
GlobalShortId |
| Global short ID of the terminal, cannot be set, is assigned by the RF-System. | |
PurchaseDate | M* | Only mandatory in certain countries (e.g. Germany) | |
TerminalType | M* | Only mandatory in certain countries (e.g. Germany) | |
UpdatedByPrincipalId |
| Must not be specified. | |
CashRegisterId | M* | Only mandatory in certain countries (e.g. Germany) | |
CashRegisterBrand | M* | Only mandatory in certain countries (e.g. Germany) | |
CashRegisterModelname | M* | Only mandatory in certain countries (e.g. Germany) | |
CashRegisterSerialNumber | M* | Only mandatory in certain countries (e.g. Germany) | |
CashRegisterSoftwareBrand | M* | Only mandatory in certain countries (e.g. Germany) | |
CashRegisterSoftwareVersion | M* | Only mandatory in certain countries (e.g. Germany) | |
CashRegisterSoftwareCompany | M* | Only mandatory in certain countries (e.g. Germany) | |
CommissioningDate |
| Must not be set! | |
Comments
0 comments
Please sign in to leave a comment.