Interface ITTEBSTransB2BXml
Classe utilizada para obter serviços e regras de negócio sobre transações electrónicas, definidas no componente associado a um dado formato.
Namespace: ITTEBS100
Assembly: ITTEBS100.dll
Syntax
[ComVisible(true)]
[Guid("85E9809E-9ACB-44CA-A94A-19544AF19EE3")]
public interface ITTEBSTransB2BXml
Properties
ErpBSO
Declaration
dynamic ErpBSO { set; }
Property Value
| Type | Description |
|---|---|
| System.Object |
Methods
DaDocumentoTesouraria(String, String, String, String, String, String, String)
Devolve um documento de tesouraria, com base na estrutura xml de um documento de Conta Corrente. Este método será invocado sempre que um documento de Contas Correntes, resultante de uma transacção electrónica, tenha ligação à Tesouraria.
Declaration
dynamic DaDocumentoTesouraria(string strB2BTipoDoc, string strXmlDoc, string strModulo, string strTipoDoc, string strSerieDoc, string strTipoEntidade, string strEntidade)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strModulo | Identifica a Módulo do Documento. |
| System.String | strTipoDoc | Identifica o Tipo do Documento. |
| System.String | strSerieDoc | Identifica a Série do Documento. |
| System.String | strTipoEntidade | Identifica o Tipo de Entidade do Documento. |
| System.String | strEntidade | Identifica a Entidade do Documento. |
Returns
| Type | Description |
|---|---|
| System.Object |
DaReferenciaDocumento(String, String)
Devolve a referência de um documento, com base na sua estrutura xml.
Declaration
string DaReferenciaDocumento(string strB2BTipoDoc, string strXmlDoc)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
Returns
| Type | Description |
|---|---|
| System.String |
DaSubTipoDocumento(String, ref String)
Para um dado documento xml, devolve o valor do atributo 'subType' a considerar para efeitos de pesquisa no ficheiro de mapeamentos.
Declaration
string DaSubTipoDocumento(string strB2BTipoDoc, ref string strXmlDoc)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
Returns
| Type | Description |
|---|---|
| System.String |
Doc2Xml(String, Object, String)
Efectua a conversão de um documento para uma estrutura xml associada ao formato.
Declaration
string Doc2Xml(string strModulo, dynamic objDoc, string strB2BTipoDoc)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strModulo | Identifica a Módulo do Documento. |
| System.Object | objDoc | Objecto com o conteúdo do documento. |
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
Returns
| Type | Description |
|---|---|
| System.String |
GeraXmlNotificacao(TTEBEB2BNotificacao, Byte)
Devolve a estrutura xml de uma notificação associada à recepção ou integração de uma transacção, de acordo com o respectivo formato.
Declaration
string GeraXmlNotificacao(TTEBEB2BNotificacao objNotificacao, byte RecepcaoIntegracao)
Parameters
| Type | Name | Description |
|---|---|---|
| TTEBEB2BNotificacao | objNotificacao | Objecto que indentifca o conteúdo da notificação. |
| System.Byte | RecepcaoIntegracao | Identifica o tipo de notificação a gerar (1 - Recepção, 2 - Integração). |
Returns
| Type | Description |
|---|---|
| System.String |
InicializaMotorFormato(String)
Inicializa o componente associado ao formato, criando uma instância do objecto responsável pelas operações dependentes do formato.
Declaration
void InicializaMotorFormato(string strIdFormato)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strIdFormato | Identifica o Id do formato. |
ObtemResumosIVA(String, String)
Devolve um objecto com um resumo do iva (taxas, incidências, valores), com base na estrutura xml de um documento.
Declaration
BasBEResumoIvas ObtemResumosIVA(string strB2BTipoDoc, string strXml)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXml | Identifica o XML com o conteúdo do Documento. |
Returns
| Type | Description |
|---|---|
| BasBEResumoIvas |
PreencheTimeStamp(String, ref String, String)
Preenche os dados relativos ao timestamp do documento, caso do preenchimento deste seja obrigatório.
Declaration
void PreencheTimeStamp(string strB2BTipoDoc, ref string strXmlDoc, string strTimeStamp)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strTimeStamp | Identifica o valor do timestamp. |
ValidaArtigosFornecedor(String, String, String, String, ref PrimaveraOrderedDictionary)
Devolve por parâmetro uma collection do object TTEBEArtigosXML caso haja artigos no xml que tenham definidos referencia fornecedor.
Declaration
bool ValidaArtigosFornecedor(string strB2BTipoDoc, string strXmlDoc, string strTipoEntidade, string strEntidade, ref PrimaveraOrderedDictionary colArtigosXML)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strTipoEntidade | Identifica o Tipo de Entidade do Documento. |
| System.String | strEntidade | Identifica a Entidade do Documento. |
| Primavera.Platform.Collections.PrimaveraOrderedDictionary | colArtigosXML | Indentifica a coleção de artigos. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
ValidaArtigosXML(String, String, String, String, ref PrimaveraOrderedDictionary)
Devolve por parâmetro uma collection do object TTEBEArtigosXML caso haja artigos no xml sem correspondência.
Declaration
bool ValidaArtigosXML(string strB2BTipoDoc, string strXmlDoc, string strTipoEntidade, string strEntidade, ref PrimaveraOrderedDictionary colArtigosXML)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strTipoEntidade | Identifica o Tipo de Entidade do Documento. |
| System.String | strEntidade | Identifica a Entidade do Documento. |
| Primavera.Platform.Collections.PrimaveraOrderedDictionary | colArtigosXML | Indentifica a coleção de artigos. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
ValidaDadosAdicionais(String, Object, String, ref String, ref String)
Efectua validações adicionais, de acordo com os critérios definidos para o formato.
Declaration
bool ValidaDadosAdicionais(string strB2BTipoDoc, dynamic objDoc, string strXmlDoc, ref string strAvisos, ref string strErros)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.Object | objDoc | Objecto com o conteúdo do documento. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strAvisos | Identifica eventuais avisos na validação. |
| System.String | strErros | Identifica eventuais erros na validação. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Xml2Doc(String, String, String, String, ref String, String, String, String)
Efectua a conversão de uma estrutura xml associada ao formato para um documento do ERP.
Declaration
dynamic Xml2Doc(string strB2BTipoDoc, string strXmlDoc, string strModulo, string strTipoDoc, ref string strSerieDoc, string strTipoEntidade, string strEntidade, string strFluxo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strModulo | Identifica a Módulo do Documento. |
| System.String | strTipoDoc | Identifica o Tipo do Documento. |
| System.String | strSerieDoc | Identifica a Série do Documento. |
| System.String | strTipoEntidade | Identifica o Tipo de Entidade do Documento. |
| System.String | strEntidade | Identifica a Entidade do Documento. |
| System.String | strFluxo | Identifica o Fluxo do Documento. |
Returns
| Type | Description |
|---|---|
| System.Object |
Xml2DocEx(String, String, String, String, ref String, String, String, String, StdBECampos)
Efectua a conversão de uma estrutura xml associada ao formato para um documento do ERP.
Declaration
dynamic Xml2DocEx(string strB2BTipoDoc, string strXmlDoc, string strModulo, string strTipoDoc, ref string strSerieDoc, string strTipoEntidade, string strEntidade, string strFluxo, StdBECampos objCampos = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strB2BTipoDoc | Identifica o tipo de transação. |
| System.String | strXmlDoc | Identifica o XML com o conteúdo do Documento. |
| System.String | strModulo | Identifica a Módulo do Documento. |
| System.String | strTipoDoc | Identifica o Tipo do Documento. |
| System.String | strSerieDoc | Identifica a Série do Documento. |
| System.String | strTipoEntidade | Identifica o Tipo de Entidade do Documento. |
| System.String | strEntidade | Identifica a Entidade do Documento. |
| System.String | strFluxo | Identifica o Fluxo do Documento. |
| StdBECampos | objCampos | Identifica os campos de artigos a associar pelo fornecedor. |
Returns
| Type | Description |
|---|---|
| System.Object |