Interface IInvBSTransferencias

Classe que implementa as regras de negócio sobre os documentos de transferência de stocks.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("A3D1D306-204C-4C17-AB35-F39553623704")]
public interface IInvBSTransferencias

Methods

Actualiza(InvBEDocumentoTransf, ref String)

Actualiza um documento.

Declaration

void Actualiza(InvBEDocumentoTransf Documento, ref string strErros)

Parameters

Type	Name	Description
InvBEDocumentoTransf	Documento	Objeto que identifica o documento.
System.String	strErros	Mensagens de erro devolvidas.

ActualizaDocumentoBensCirculacao(Object)

Actualiza o documento para acompanhar os bens em circulação.

Declaration

void ActualizaDocumentoBensCirculacao(dynamic Documento)

Parameters

Type	Name	Description
System.Object	Documento	Objeto que identifica o documento.

ActualizaDocumentoBensCirculacao(Object, ref String)

Actualiza o documento para acompanhar os bens em circulação.

Declaration

void ActualizaDocumentoBensCirculacao(dynamic Documento, ref string Avisos)

Parameters

Type	Name	Description
System.Object	Documento	Objeto que identifica o documento.
System.String	Avisos	Mensagens de aviso devolvidas.

ActualizaLinhaPai(InvBEDocumentoTransf, String, Double)

Atualiza a quantidade de uma linha pai

Declaration

void ActualizaLinhaPai(InvBEDocumentoTransf Documento, string strIdLinhaPai, double dblQuantidade = 0)

Parameters

Type	Name	Description
InvBEDocumentoTransf	Documento	Objeto do documento de Transferência
System.String	strIdLinhaPai	ID da linha pai
System.Double	dblQuantidade	Quantidade a adicionar/definir na linha pai

ActualizaValorAtributo(String, Int32, String, String, String, Object)

Actualiza o valor de um atributo do cabeçalho de um documento.

Declaration

void ActualizaValorAtributo(string Tipodoc, int NumDoc, string Filial, string Serie, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um atributo do cabeçalho de um documento.

Declaration

void ActualizaValorAtributoID(string Id, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(String, Int32, String, String, StdBECampos)

Atualiza os valores de um conjunto de atributos num cabeçalho de um documento.

Declaration

void ActualizaValorAtributos(string Tipodoc, int NumDoc, string Filial, string Serie, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

ActualizaValorAtributosID(String, StdBECampos)

Atualiza os valores de um conjunto de atributos num cabeçalho de um documento.

Declaration

void ActualizaValorAtributosID(string Id, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

AdicionaLinhaOrigem(InvBEDocumentoTransf, String, String, String, String, Double, String)

Adiciona a um documento uma linha de transferência: origem e respetivo destino.

Declaration

void AdicionaLinhaOrigem(InvBEDocumentoTransf Documento, string Artigo, string Armazem, string Localizacao, string Estado, double Quantidade, string Lote = "")

Parameters

Type	Name	Description
InvBEDocumentoTransf	Documento	Objeto que identifica o documento.
System.String	Artigo	Código do artigo (Artigo).
System.String	Armazem	Código do armazém (Armazem).
System.String	Localizacao	Código da localização de armazém (Localizacao).
System.String	Estado	Código do estado de inventário (INV_EstadoOrigem).
System.Double	Quantidade	Quantidade a transferir (Quantidade).
System.String	Lote	Código do lote (Lote).

AnulaDocumentosBensCirculacao(String, String)

Anula os documentos gerados pelo documento de transferência.

Declaration

void AnulaDocumentosBensCirculacao(string IdDocTransf, string Avisos = "")

Parameters

Type	Name	Description
System.String	IdDocTransf	Identificador do documento de transferência (ID).
System.String	Avisos	Mensagens de aviso devolvidas.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador do cabeçalho das transferências.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil	Coleção com as definições.

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas das transferências.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

Type	Description
StdBEDefCamposUtil	Coleção com as definições.

DaOrigensAnulacaoReservaTransferida(String, ref InvBEOrigens, Boolean)

Devolve uma coleção com as origens de uma transferência para cancelamento de uma reverva.

Declaration

bool DaOrigensAnulacaoReservaTransferida(string IdReserva, ref InvBEOrigens Origens, bool AnulaDoc = false)

Parameters

Type	Name	Description
System.String	IdReserva	Identificador da reserva (ID).
InvBEOrigens	Origens	Coleção com as origens a devolver.
System.Boolean	AnulaDoc	Indica se o documento está a ser anulado na totalidade.

Returns

Type	Description
System.Boolean	True - Com sucesso; False - Sem sucesso

DaOrigensReservaTransferida(InvBEOrigens, InvBELinhaReserva, Double)

Devolve uma coleção com as origens de uma transferência de reserva.

Declaration

bool DaOrigensReservaTransferida(InvBEOrigens Origens, InvBELinhaReserva LinhaReserva, double QuantidadeOriginalReserva)

Parameters

Type	Name	Description
InvBEOrigens	Origens	Coleção com as origens.
InvBELinhaReserva	LinhaReserva	Objeto que identifica a reserva.
System.Double	QuantidadeOriginalReserva	Quantidade original da reserva.

Returns

Type	Description
System.Boolean	True - Com sucesso; False - Sem sucesso

DaValorAtributo(String, Int32, String, String, String)

Devolve o valor de um atributo do cabeçalho de um documento.

Declaration

dynamic DaValorAtributo(string Tipodoc, int NumDoc, string Filial, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoID(String, ref String)

Devolve o valor de um atributo do cabeçalho de um documento.

Declaration

dynamic DaValorAtributoID(string Id, ref string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLinhaID(String, String)

Devolve o valor de um atributo de uma linha de um documento.

Declaration

dynamic DaValorAtributoLinhaID(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador da linha do documento (IdLinha).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLock(String, Int32, String, String, String)

Devolve o valor de um atributo do cabeçalho de um documento.

Declaration

dynamic DaValorAtributoLock(string Tipodoc, int NumDoc, string Filial, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DaValorAtributoLockID(String, ref String)

Devolve o valor de um atributo do cabeçalho de um documento.

Declaration

dynamic DaValorAtributoLockID(string Id, ref string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DaValorAtributos(String, Int32, String, String, String[])

Devolve um conjunto de valores do cabeçalho de um documento.

Declaration

StdBECampos DaValorAtributos(string Tipodoc, int NumDoc, string Filial, string Serie, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

DaValorAtributosID(String, String[])

Devolve um conjunto de valores do cabeçalho de um documento.

Declaration

StdBECampos DaValorAtributosID(string Id, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

DaValorAtributosIDLinha(String, String[])

Devolve um conjunto de valores de uma linha de um documento.

Declaration

StdBECampos DaValorAtributosIDLinha(string sID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador da linha do documento (IdLinha).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

DaValorAtributosIDLinhaLock(String, String[])

Devolve um conjunto de valores de uma linha de um documento.

Declaration

StdBECampos DaValorAtributosIDLinhaLock(string sID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador da linha do documento (IdLinha).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DaValorAtributosLock(String, Int32, String, String, String[])

Devolve um conjunto de valores do cabeçalho de um documento.

Declaration

StdBECampos DaValorAtributosLock(string Tipodoc, int NumDoc, string Filial, string Serie, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DaValorAtributosLockID(String, String[])

Devolve um conjunto de valores do cabeçalho de um documento.

Declaration

StdBECampos DaValorAtributosLockID(string Id, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

Edita(String, Int32, String, String)

Edita o Documento de Transferência

Declaration

InvBEDocumentoTransf Edita(string Tipodoc, int NumDoc, string Filial, string Serie)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).

Returns

Type	Description
InvBEDocumentoTransf

EditaID(String)

Edita um documento.

Declaration

InvBEDocumentoTransf EditaID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do documento (ID).

Returns

Type	Description
InvBEDocumentoTransf	Objeto que representa o documento.

Existe(String, Int32, String, String)

Indica se um documento existe.

Declaration

bool Existe(string Tipodoc, int NumDoc, string Filial, string Serie)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).

Returns

Type	Description
System.Boolean	True - Existe; False - Não existe

ExisteID(String)

Indica se um documento existe.

Declaration

bool ExisteID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do documento (ID).

Returns

Type	Description
System.Boolean	True - Existe; False - Não existe

GeraDocumentoBensCirculacao(InvBEDocumentoTransf, String, Int32)

Gera o documento de compras ou vendas para acompanhar os bens em circulação no respectivo módulo.

O módulo do documento a gerar é dado pela valor de TipoEntidade:

"F" - Fornecedores, gera documento de compra

"C" - Clientes, gera documento de venda

Declaration

dynamic GeraDocumentoBensCirculacao(InvBEDocumentoTransf DocTransf, string Tipodoc = "", int TipoPreco = -1)

Parameters

Type	Name	Description
InvBEDocumentoTransf	DocTransf	Objeto que identifica o documento.
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	TipoPreco	Tipo de preço a usar (opcional).

Returns

Type	Description
System.Object	Objeto que representa o documento (Compras ou Vendas).

Remarks

Quando o parâmetro TipoPreco não é indicado será usada a configuração em TipoPrecoBensCirculacao.

ImprimeDocumento(String, Int32, String, String, Int32, String, Boolean, String)

Imprime um documento para uma impressora ou para um ficheiro no formato PDF.

Declaration

bool ImprimeDocumento(string Tipodoc, int NumDoc, string Filial, string Serie, int Numvias = 0, string NomeReport = "", bool SegundaVia = false, string DestinoPDF = "")

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.Int32	Numvias	Número de vias a serem impressas.
System.String	NomeReport	Código do mapa a ser impresso (caso não seja definido, será utilizado o da definido na série).
System.Boolean	SegundaVia	Indica se é uma segunda via a ser impressa.
System.String	DestinoPDF	Define o nome do ficheiro PDF (caminho incluído) de destino. Quando indicado a impressão não é enviada para uma impressora.

Returns

Type	Description
System.Boolean	True - Sucesso na impressão; False - Sem sucesso na impressão

ListaDocumentosBensCirculacao(String, Boolean)

Devolve uma lista com os documentos gerados pelo documento de transferência.

Declaration

StdBELista ListaDocumentosBensCirculacao(string IdDocTransf, bool ApenasNaoAnulados = true)

Parameters

Type	Name	Description
System.String	IdDocTransf	Identificador do documento de transferência (ID).
System.Boolean	ApenasNaoAnulados	Indica se a lista devolve apenas os documentos não anulados.

Returns

Type	Description
StdBELista	Lista com os documentos.

PreencheDadosRelacionados(InvBEDocumentoTransf)

Preenche o cabeçalho de um documento com os valores sugeridos por omissão.

Declaration

InvBEDocumentoTransf PreencheDadosRelacionados(InvBEDocumentoTransf Documento)

Parameters

Type	Name	Description
InvBEDocumentoTransf	Documento	Objeto que identifica o documento.

Returns

Type	Description
InvBEDocumentoTransf	Objeto que representa o documento.

PreencheDadosRelacionados(InvBEDocumentoTransf, ref Int32)

Preenche o cabeçalho de um documento com os valores sugeridos por omissão.

Declaration

InvBEDocumentoTransf PreencheDadosRelacionados(InvBEDocumentoTransf Documento, ref int Preenche)

Parameters

Type	Name	Description
InvBEDocumentoTransf	Documento	Objeto que identifica o documento.
System.Int32	Preenche	Indica quais os valores relacionados que devem ser preenchidos segundo o enumerado BasBETiposGcp.PreencheRelacaoStk.

Returns

Type	Description
InvBEDocumentoTransf	Objeto que representa o documento.

ValidaActualizacao(InvBEDocumentoTransf, InvBETabTransferencia, ref String)

Valida a atualização de um documento.

Declaration

bool ValidaActualizacao(InvBEDocumentoTransf Documento, InvBETabTransferencia Tipodoc, ref string StrErro)

Parameters

Type	Name	Description
InvBEDocumentoTransf	Documento	Objeto que identifica o documento.
InvBETabTransferencia	Tipodoc	Objeto que identifica o tipo de documento da transferência.
System.String	StrErro	Mensagens de erro devolvidas.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação sem sucesso