Estrutura dos Ficheiros XML Padrão para EDI

Prev Next
  • PT

  • AO

  • MZ

  • CV

  • CS

  • Evolution

  • Web

  • Desktop


No XML Padrão, os elementos e campos relativos ao BO, Dossiers Internos, que estão mapeados encontram-se divididos em duas categorias:

  • Obrigatórios

  • Facultativos: detêm a propriedade minOccurs=0.

Se for utilizada uma aplicação própria para editar schemas XML e abrir o ficheiro xmlPadraoBO.xsd, a identificação dos campos obrigatórios e a diferenciação face aos campos facultativos ficará facilitada.

Elementos obrigatórios

Dentro de todos estes elementos, existem alguns cuja inclusão no XML é determinante para a importação do dossier interno. Se algum dos elementos obrigatórios não existir no XML, o documento não será importado pela aplicação.

Independentemente do tipo de dossier interno que se pretenda enviar em XML, o único elemento obrigatório será o Documento.

Ao criar um XML que contenha apenas este elemento, ao ser importado para o PHC será criado um dossier com informação de cabeçalho sem linhas.

Este elemento contém os respetivos campos obrigatórios, conforme o esquema do ficheiro xmlPadraoBO.xsd.

Restantes elementos

Os restantes elementos, não sendo obrigatórios, respeitarão no entanto a seguinte regra: quando forem incluídos no XML deverão conter todos os campos que lhes pertencem e que são obrigatórios.

Ou seja, se algum destes elementos for incluído no XML, os campos que os compõem terão obrigatoriamente de existir.

O esquema completo com os campos obrigatórios encontra-se definido no ficheiro xmlPadraoBO.xsd.

Campos facultativos

Os restantes campos do BO que estão mapeados mas são facultativos incluem:

  1. Total sem IVA e sem Descontos: se o documento tiver preços, deverá preencher o campo totalbase do cabeçalho e os campos precoliquido ou precototal das linhas.

  2. Ecovalor do documento: a utilizar se existir o módulo Ecovalor. Corresponde ao total do Ecovalor do documento.

  3. Preço unitário: corresponde ao bi.edebito mais o Desconto. Se o documento tiver preços, deverá preencher o campo totalbase do cabeçalho e os campos precoliquido ou precototal das linhas. Embora por defeito se considere que o valor do PrecoLiquido não tenha IVA incluído, caso seja utilizado um Documento XML com o campo bi.ivaincl configurado, ao calcular o valor do Preço Unitário a aplicação verificará se o valor deverá incluir o IVA.

  4. Preço total líquido: corresponde ao campo bi.ettdeb. Se o documento tiver preços, deverá preencher o campo totalbase do cabeçalho e os campos precoliquido ou precototal das linhas.

  5. Lote: a utilizar se existir o módulo Lotes. Guarda o lote da linha.

  6. Validade do lote: a utilizar se existir o módulo Lotes. Guarda a validade do lote da linha.

  7. Ecovalor da linha: a utilizar se existir o módulo Ecovalor. Corresponde ao Ecovalor da linha.