Elementos da base de dados

Por cada elemento é definido:

  • o código;
  • o tipo de elemento; que pode ser, por exemplo: um texto, um número, uma quantidade; tem influência na criação do campo na base de dados;
  • o comprimento; define a dimensão máxima na base de dados;
  • o número de decimais; quando é uma quantidade ou um campo numérico, é possível definir as posições decimais;
  • o tipo de coluna; influência o modo de visualização do campo nos ecrãs do EVE e nos mapas;
  • o tipo de lista; esta informação é utilizada para decidir o que apresentar, quando é precisa uma lista de valores;
  • lista longa sim ou não; influência o modo de apresentar a lista ao utilizador;
  • elemento de ajuda; quando o sistema tem que apresentar a ajuda do primeiro nível de um outro campo; útil quando, de facto, trata-se de uma instâncias do outro campo, criada por razões técnicas;
  • elemento referência; existem casos de campos que, de facto, são instâncias da mesma informação mas que é conveniente ter um nome diferente: por exemplo o “Prenota interlocutor” é uma instância do “Interlocutore” na tabela das reservas;
  • elemento parametrizável; para quando a dimensão máxima prevista na base de dados ultrapassa as necessidades: por exemplo o campo “articolo” no EVE permite um tamanho de 20, mas numa instalação o máximo pretendido poderia ser 10.

Sendo o EVE um sistema multi-línguas é preciso definir, por cada código, língua e tipo de utilização uma descrição.

Nos elementos, é obrigatório preencher sempre, os seguintes tipos de descrição:

  • ajuda de primeiro nível; apresentada quando o utilizador pede mais detalhe sobre a informação que está a ver;
  • descrição normal; apresentada por defeito;
  • descrição breve; utilizada como descrição das colunas nos ecrãs.

Comunicação dos Elementos das Faturas Emitidas por WebService

Objectivos e Âmbito:

Com a entrada em vigor do Decreto-Lei 198/2012 de 24 de Agosto, todas as entidades que emitam documentos valorizados a partir do Wpms são obrigadas a comunicar à Autoridade Tributária e Aduaneira(AT), por transmissão eletrónica de dados, os elementos dos documentos emitidos nos termos do Código de IVA.

O presente manual detalha os processos de parametrização em WPMS e procedimentos ao nível dos sistemas operativo dos servidores aplicacionais, para uma das vias postas à disposição dos contribuintes – a transmissão eletrónica, em tempo real, via web service. Pressupõe que o técnico responsável pela parametrização é alguém devidamente familiarizado com o WPMS e com administração de sistemas operativos.

Criação do utilizador responsável pela invocação do web service

A comunicação dos elementos da fatura via web service é efetuada por utilizadores devidamente qualificados para esse efeito. A respetiva habilitação é efetuada no Portal das Finanças e consiste na criação de um subutilizador de perfíl WFA-Comunicação de dados de faturas do NIF da entidade emitente do documento valorizado a comunicar.

Dado que a invocação do web service é efetuada com recurso às credenciais de autênticação no Portal da Finanças dos subutilizadores WFA anteriormente descritos é necessário guardar em Wpms essa informação. A forma adequada de o fazer consiste na criação de um utilizador especifico por cada entidade emitente e consumidora do serviço de comunicação de faturas existente na instalação do Wpms.

No sentido de concretizar o que anteriormente foi dito admita-se, por hipótese, a existência, numa instalação do WPMS, da entidade “XPTO, SA”, com NIF “100100100” e com subutilizador WFA “777” devidamente criado no Portal da Finanças. Para que o Wpms possa evocar o subutilizador “777” na respetiva invocação do web service será necessário criar em Wpms, o utilizador “100100100777”, o qual deverá ter a mesma password que subutilizador WFA da entidade “XPTO, SA” no Portal da Finanças.

Fica claro que a regra da construção em Wpms do utilizador que invoca o webservice resume-se à concatenação do NIF da entidade com o respetivo código do utilizador WFA parametrizado no Portal da Finanças. Em termos teóricos assim é, mas na prática a volta é necessário mascarar as credenciais de autenticação no Portal das Finanças.

Os écrans seguintes exemplificam a correta criação do utilizador “web service”.

O primeiro passo consistem em criar para a entidade um contacto do tipo “Comunicação Faturas”. Esta trigger permite que os processos batch ou interativos de interface do Wpms saibam que a entidade “XPTO, S.A” é uma emitente de faturas, permite também ligar o subutilizador WFA do NIF da entidade “XPTO, SA” ao código WPMS da mesma entidade organizacional.

Global → Aplicação → Elementos Básicos → Unidades → Organizacionais → Empresas [AG001]

Ao acesso ao écran dos “Contactos” é efetuado no menu “Opções” → “Contactos”, a partir do qual será possível criar, o novo tipo de contacto “Comunicação Faturas”. O valor da sequência deve coincidir com o código do subutilizador WFA no Portal das Finanças.

Por confirmação do écran, cria-se o tipo de contacto “Comunicação Faturas”. O resultado é o seguinte:

Se o primeiro passo consistiu em ligar em Wpms a empresa “XPTO, SA” ao subutilizador WFA do respetivo NIF, o segunda passo, que a seguir se exemplifica, consiste em criar o id do utilizador que invocará o web service.

Global → Instalação → Segurança → Utilizadores [IS001]

A criação do utilizador é feita no écran principal desta transaçã. O acesso ao écran de criação de utilizadores é efetuado no menu “Lista” → “Criar”. Recordamos que o id do nosso utilizador deverá ser o código “100100100777”. Não é necessário indicar nada para além do código sui generis deste utilizador e de uma descrição sucinta condizente com o o fim deste utilizador.

Por confirmação do écran é criado o utilizador.

Fica apenas faltar definir a password especifica para este utilizador, a qual deve ser igual ao do subutilizador WFA no Portal da Finanças. O acesso à criação da password é efetuado em “Opções” “→ Modificar Password”.

Confirmado o écran, o utilizador “100100100777” fica apto a ser utilizado para invocação do web service pelos os processos batch ou interativos de interface do Wpms aquando emissão dos documentos valorizados.

Parametrização do Sistema Externo “AT- Comunicação de Faturas”

Do ponto de vista de interface, os dados do documento comercial emitido são enviados por mensagens do tipo “DOC”. Por isso, o sistema externo a criar exclusivamente para efeito da comunicação da fatura por web service de conter a mensagem tipo “DOC” na respetiva definição. Exemplifica-se a criação de um sistema esterno para evocação do script de interface de invocação do web service de comunicação de faturas.

Global → Instalação → Interface → Sistemas Externos [IG004]

O path indicado serve apenas para indicar a localização do script de saida, no qual evoca-se o web service. O script de saída é da responsabilidade técnica da IsRetail e só deve utilizado quando as mensagens do “DOC” possuem dados de documentos comercial . De seguida deve-se definir, para a mensagem do tipo “DOC”, o endpoint e o serviço invocado na comunicação das faturas. Para esse efeito, deve-se aceder écran “Informações Adicionais” acedível a partir do menu “Opções”.

O valor da ação remota deve ter sempre o valor “RegisterInvoice”. No que toca ao endereço do sistema remoto este pode ter um dos dois seguintes valores:

  1. Ambiente Produção: https://servicos.portaldasfinancas.gov.pt:400/fews/faturas
  2. Ambiente Qualidade: https://servicos.portaldasfinancas.gov.pt:700/fews/faturas

Os endpoints enumerados são os válidos á data. Para evitar constragimentos posteriores diz o bom senso que se deve proceder à respetiva confirmação.

Notas finais

Este manual deve ser complementado com a leitura de toda a documentação disponibilizada no Portal das Finanças sobre esta temática.

Caso após a leitura deste manual ainda subsistam dúvidas contacte o serviço técnico da IsRetail via tel: 211509901 ou por e-mail: tech@isretail.eu

Equipamentos