A interface de Conformidade com o Vat pode ser utilizada para criar automaticamente a estrutura organizacional necessária no RetailForce portal.
Para tal, o sistema de origem deve incluir as informações necessárias para criar as entidades relevantes no payload do documento.
Pré-requisitos
Para que a criação automática da estrutura funcione, é necessário que os seguintes pré-requisitos estejam preenchidos.
- Organização criada,
- configuração do servidor criada,
- configuração criada,
- licenças atribuídas,
- configuração atribuída à organização.
Organização
A organização já deve existir no RetailForce Cloud Portal, uma vez que os dados do sistema a montante devem referir-se a um «OrganisationId» existente ao criar uma nova estrutura.
Nota: não é possível criar empresas através deste mecanismo.
Configuração do servidor
Deve ser criada uma configuração de servidor que utilize o «Tipo de ligação» correto.
Configuração
Deve ser criada uma configuração que:
- esteja associada à configuração do servidor,
- tenha licenças atribuídas,
- esteja atribuída à respetiva organização.
Payload do sistema a montante
Através da payload do sistema a montante, é possível criar uma nova loja, bem como um novo terminal. Para tal, a payload deve conter as seguintes informações:
- "OrganisationId",
- Informações sobre a loja,
- Informações sobre o terminal.
OrganisationId
O «OrganisationId» deve referir-se à organização criada no RetailForce Cloud Portal. É também designado por «LicenseConsumerId» e pode ser encontrado no Portal, nas propriedades da organização.
"OrganisationId": 7417eb48-3cca-4882-88b9-df44241908d6,
Informações da loja
Propriedades possíveis para a criação de uma nova loja.
"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"
},Informações na coluna «Tipo»:
- M ... obrigatório («mandatório»)
- M* ... obrigatório em determinados países ou sob determinadas condições
- R ... recomendado («recomendado»)
- O ... opcional
| Elemento | Tipo |
Descrição | |
| Loja |
|
Informações da loja | |
| StoreId | M |
Caso seja necessário criar uma nova loja, utilize «00000000-0000-0000-0000-000000000000» na primeira E em todas as payloads seguintes. | |
OrganisationId |
M |
ID da Organização; não é necessário, uma vez que a propriedade «OrganisationId» fora do objeto «store» já se refere à respetiva Organização. Utilize sempre: «00000000-0000-0000-0000-000000000000» |
|
CompanyId |
O |
não é obrigatório; pode ser utilizado caso tenha sido criada uma empresa subordinada à organização. | |
StoreNumber |
M |
Número da loja/filial. | |
Caption |
M |
Designação da loja / filial. | |
RegiãoFiscal |
M* |
Obrigatório apenas em países onde existem regiões fiscais (por exemplo, Espanha). | |
Telefone |
O |
Informações de contacto da loja: número de telefone. | |
| Fax | O |
Dados de contacto da loja: Número de fax. | |
O |
Informações de contacto da loja: endereço de e-mail. | ||
Data de abertura |
M* |
Obrigatório apenas nos países em que é necessário indicar a data de abertura da loja (por exemplo, Eslovénia). | |
| ClosingDate | O |
Não deve ser especificada, uma vez que representa a data de encerramento definitivo de um estabelecimento comercial (quando a loja foi encerrada definitivamente). | |
| Dados Ocultos | O |
Não deve ser especificado; representa a data em que a loja foi ocultada no Portal, uma vez que todos os terminais subjacentes foram desativados. | |
UpdatedByPrincipalId |
|
Não deve ser especificado. | |
Horário de Abertura Segunda-feira |
O |
Horário de funcionamento à segunda-feira. | |
Horário de Abertura Terça-feira |
O |
Horário de funcionamento à terça-feira. | |
Horário de funcionamento na quarta-feira |
O |
Horário de funcionamento à quarta-feira. | |
Horário de funcionamento na quinta-feira |
O |
Horário de funcionamento na quinta-feira. | |
Horário de funcionamento na sexta-feira |
O |
Horário de funcionamento à sexta-feira. | |
Horário de funcionamento no sábado |
O |
Horário de funcionamento no sábado. | |
Horário de funcionamento ao domingo |
O |
Horário de funcionamento ao domingo. | |
ClientConfigurationId |
O |
ID da configuração, não obrigatório. | |
NewClientConfigurationId |
O |
ID de uma nova configuração, não obrigatório. | |
NewClientConfigurationValidFrom |
O |
Data a partir da qual uma nova configuração entra em vigor. | |
Rua |
M |
Nome da rua da loja/sucursal. | |
StreetNumber |
M |
Número da rua da loja/filial. | |
PostalCode |
M |
Código postal da loja/filial. | |
Cidade |
M |
Cidade da loja / filial. | |
CountryCode |
M |
Código do país (ISO 3166-1 Alpha-3). | |
Parâmetros da loja
É possível definir parâmetros opcionais da loja, nos países onde tal é possível, por exemplo, França, Eslovénia, Croácia e outros.
"StoreParameters": [
{
"ParameterName": "SIRET_STOREPARAMETER",
"ParameterValue": "123456789",
"ParameterEncrypted": false,
"ParameterOnlyServer": false
}
]Informações na coluna «Tipo»:
- M ... obrigatório («mandatório»)
- M* ... obrigatório em determinados países ou sob determinadas condições
- R ... recomendado («recomendado»)
- O ... opcional
| Elementos | Tipo |
Descrição | |
| StoreParameters |
|
||
| ParameterName | O |
Designação do parâmetro. | |
| ParameterValue | O |
Valor do parâmetro. | |
| ParâmetroCriptografado | O |
Indicador que indica se o parâmetro está encriptado. | |
| ParameterOnlyServer | O |
Opção que indica se o parâmetro é utilizado apenas na configuração do servidor. | |
Informações do terminal
"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
},Informações na coluna «Tipo»:
- M ... obrigatório («mandatório»)
- M* ... obrigatório em determinados países ou sob determinadas condições
- R ... recomendado («recomendado»)
- O ... opcional
| Elementos | Tipo |
Descrição | |
| Terminal |
|
Informações do terminal | |
terminalId |
M |
Caso seja necessário criar um novo terminal, utilize «00000000-0000-0000-0000-000000000000» na primeira payload E em todas as seguintes. | |
StoreId |
M |
Utilize sempre «00000000-0000-0000-0000-000000000000». | |
terminalNumber |
M |
Número da caixa registadora na loja. | |
fiscalCountry |
O |
não obrigatório. | |
Caption |
R |
Designação da caixa registadora. | |
Tipo de Plataforma |
M* |
Obrigatório apenas em determinados países (por exemplo, na Alemanha). | |
IsTest |
M |
|
|
IsDisabledGetConfigurationLimit |
O |
Apenas possível para terminais de teste («IsTest»: true). | |
ArchiveDate |
O |
Não especificar; indica quando o terminal foi desativado e arquivado. | |
ClientConfigurationId |
O |
ID da configuração, não obrigatório. | |
NewClientConfigurationId |
O |
ID de uma nova configuração, não obrigatório. | |
NewClientConfigurationValidFrom |
O |
Data a partir da qual uma nova configuração entra em vigor. | |
GlobalShortId |
|
ID curto global do terminal; não pode ser definido, é atribuído pelo sistema RF. | |
DataDeCompra |
M* |
Obrigatório apenas em determinados países (por exemplo, na Alemanha) | |
Tipo de Terminal |
M* |
Obrigatório apenas em determinados países (por exemplo, Alemanha) | |
UpdatedByPrincipalId |
|
Não deve ser especificado. | |
cashRegisterId |
M* |
Obrigatório apenas em determinados países (por exemplo, na Alemanha) | |
CashRegisterBrand |
M* |
Obrigatório apenas em determinados países (por exemplo, na Alemanha) | |
Nome do modelo da caixa registadora |
M* |
Obrigatório apenas em determinados países (por exemplo, na Alemanha) | |
Número de série da caixa registadora |
M* |
Obrigatório apenas em determinados países (por exemplo, Alemanha) | |
Marca do software da caixa registadora |
M* |
Obrigatório apenas em determinados países (por exemplo, na Alemanha) | |
Versão do software de caixa registadora |
M* |
Obrigatório apenas em determinados países (por exemplo, Alemanha) | |
Empresa do software de caixa registadora |
M* |
Obrigatório apenas em determinados países (por exemplo, Alemanha) | |
Data de Entrada em Funcionamento |
|
Não deve ser definido! | |
Este artigo foi traduzido automaticamente.
Comentários
0 comentários
iniciar sessão para comentar.