PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface ICblBSDocumentos

    Classe que contém todas as obrigações associadas à entidade Documentos.

    Namespace: ICblBS100
    Assembly: ICblBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("7A46BBD7-C06F-4F6C-A522-2F41B1C29A29")]
    public interface ICblBSDocumentos

    Methods

    Actualiza(CblBEDocumento)

    Actualiza a informação do Documento.

    Declaration
    bool Actualiza(CblBEDocumento ObjBeDocumento)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    Returns
    Type Description
    System.Boolean

    Actualiza(CblBEDocumento, ref String)

    Actualiza a informação do Documento.

    Declaration
    bool Actualiza(CblBEDocumento ObjBeDocumento, ref string Avisos)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String Avisos

    Notificação devolvida pelo processo de actualização.

    Returns
    Type Description
    System.Boolean

    Actualiza(CblBEDocumento, ref String, Boolean)

    Declaration
    bool Actualiza(CblBEDocumento ObjBeDocumento, ref string Avisos, bool IgnoraApuramentos = false)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String Avisos
    System.Boolean IgnoraApuramentos
    Returns
    Type Description
    System.Boolean

    Actualiza(CblBEDocumento, ref String, Boolean, Boolean)

    Declaration
    bool Actualiza(CblBEDocumento ObjBeDocumento, ref string Avisos, bool IgnoraApuramentos = false, bool CorrecaoNumeradoresSVAT = false)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String Avisos
    System.Boolean IgnoraApuramentos
    System.Boolean CorrecaoNumeradoresSVAT
    Returns
    Type Description
    System.Boolean

    ActualizaDEIL(String, String, Int32, String, String, ref String)

    Actualiza o DEIL

    Declaration
    bool ActualizaDEIL(string ID, string DE_IL, int TipoDE_IL, string Terceiro, string TipoTerceiro, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.String ID

    Identificador do documento

    System.String DE_IL

    Identificador de DE_IL

    System.Int32 TipoDE_IL

    Identificador de tipo de DE_IL

    System.String Terceiro

    Identificador do Terceiro

    System.String TipoTerceiro

    Identificador do Tipo de Terceiro

    System.String ErroValidacao

    Recebe a descrição de eventuais erros de validação.

    Returns
    Type Description
    System.Boolean

    ActualizaTabelasRascunhos()

    Actualiza a estrutura das tabelas dos rascunhos.

    Declaration
    void ActualizaTabelasRascunhos()

    ActualizaUltimoIndice(String, Int32)

    Actualiza o último índice existente nos documentos.

    Declaration
    void ActualizaUltimoIndice(string TipoLancamento, int Ano)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Ano do Tipo de Lançamento

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

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int Ano, string Diario, int NumDiario, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

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

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(int Ano, string Diario, int NumDiario, string Atributo, dynamic Valor, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    ActualizaValorAtributoRascunho(String, Int32, String, Int32, String, Object)

    Actualiza o valor de um atributo de um rascunho.

    Declaration
    void ActualizaValorAtributoRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributos(Int32, String, Int32, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int Ano, string Diario, int NumDiario, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

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

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(int Ano, string Diario, int NumDiario, StdBECampos Atributos, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    ActualizaValorAtributosRascunho(String, Int32, String, Int32, StdBECampos)

    Actualiza o valor de um atributo de um rascunho.

    Declaration
    void ActualizaValorAtributosRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    ActualizaValorAtributosRascunhoID(String, StdBECampos)

    Actualiza o valor de um atributo de um rascunho.

    Declaration
    void ActualizaValorAtributosRascunhoID(string ID, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String ID

    Identificador do Documento.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    AlterarConta(String, String, String, ref String)

    Declaration
    void AlterarConta(string IdDoc, string ContaAtual, string Conta, ref string IdLinha)
    Parameters
    Type Name Description
    System.String IdDoc
    System.String ContaAtual
    System.String Conta
    System.String IdLinha

    AlterarConta(String, String, String, ref String, ref String)

    Declaration
    void AlterarConta(string IdDoc, string ContaAtual, string Conta, ref string IdLinha, ref string Avisos)
    Parameters
    Type Name Description
    System.String IdDoc
    System.String ContaAtual
    System.String Conta
    System.String IdLinha
    System.String Avisos

    BalanceiaDiferencasArredondamento(CblBEDocumento)

    Método que permite Balancear as Diferenças de arredondamento.

    Declaration
    void BalanceiaDiferencasArredondamento(CblBEDocumento objDoc)
    Parameters
    Type Name Description
    CblBEDocumento objDoc

    Documento de Contabilidade

    CancelaRascunho(String, Int32, String, Int32, String, String, String)

    Cancela o Rascunho.

    Declaration
    bool CancelaRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, string DescrSufixo, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String DescrSufixo
    System.String MotivoAnulacao
    System.String ObsAnulacao
    Returns
    Type Description
    System.Boolean

    CancelaRascunho(String, Int32, String, Int32, String, ref String, String, String)

    Cancela o Rascunho.

    Declaration
    bool CancelaRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, string DescrSufixo, ref string NovaDescr, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String DescrSufixo
    System.String NovaDescr
    System.String MotivoAnulacao
    System.String ObsAnulacao
    Returns
    Type Description
    System.Boolean

    CancelaRascunho(String, Int32, String, Int32, String, ref String, String, String, Boolean)

    Cancela o Rascunho.

    Declaration
    bool CancelaRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, string DescrSufixo, ref string NovaDescr, string MotivoAnulacao = null, string ObsAnulacao = null, bool CorrecaoSVAT = false)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String DescrSufixo
    System.String NovaDescr
    System.String MotivoAnulacao
    System.String ObsAnulacao
    System.Boolean CorrecaoSVAT
    Returns
    Type Description
    System.Boolean

    CopiaDocumento(Int32, String, Int32, ref String, Int32, Int32, Int32, Boolean)

    Copia um Documento.

    Declaration
    CblBEDocumento CopiaDocumento(int Ano, string Diario, int NumDiario, ref string TipoLancamento, int AnoLanc, int MesLanc, int DiaLanc, bool ComValores)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 AnoLanc
    System.Int32 MesLanc
    System.Int32 DiaLanc
    System.Boolean ComValores

    Flag que indica se a cópia é para ser feita com valores ou sem valores.

    Returns
    Type Description
    CblBEDocumento

    DaCambiosMoeda(String, DateTime, ref Double, ref Double, ref Double)

    Devolve os câmbios duma determinada Moeda

    Declaration
    void DaCambiosMoeda(string Moeda, DateTime Data, ref double CambioOrigem, ref double CambioBase, ref double CambioAlt)
    Parameters
    Type Name Description
    System.String Moeda

    Identificador da Moeda a cambiar

    System.DateTime Data

    Data do Câmbio

    System.Double CambioOrigem

    Câmbio Origem para a Moeda

    System.Double CambioBase

    Câmbio Base para a Moeda

    System.Double CambioAlt

    Câmbio Alternativo para a Moeda

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaDefCamposUtilLinhas()

    Devolve as definições dos campos do utilizador das linhas do movimento.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtilLinhas()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaUltimoIndice(String, Int32)

    Devolve o último índice existente nos documentos.

    Declaration
    int DaUltimoIndice(string TipoLancamento, int Ano)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Ano do Tipo de Lançamento.

    Returns
    Type Description
    System.Int32

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

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoComum(ref String, Int32, String, Int32, String)

    Devolve o valor de um atributo de um rascunho ou documento.

    Declaration
    dynamic DaValorAtributoComum(ref string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoComumLock(ref String, Int32, String, Int32, String)

    Devolve o valor de um atributo de um rascunho ou documento, respeitando os locks da base de dados.

    Declaration
    dynamic DaValorAtributoComumLock(ref string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoLinhaID(String, String)

    Devolve o valor de um atributo de uma linha.

    Declaration
    dynamic DaValorAtributoLinhaID(string ID, string Atributo)
    Parameters
    Type Name Description
    System.String ID
    System.String Atributo

    Nome do atributo a devolver.

    Returns
    Type Description
    System.Object

    DaValorAtributoLinhaIDLock(String, String)

    Devolve o valor de um atributo de uma linha, respeitando os locks da base de dados.

    Declaration
    dynamic DaValorAtributoLinhaIDLock(string ID, string Atributo)
    Parameters
    Type Name Description
    System.String ID
    System.String Atributo

    Nome do atributo a devolver.

    Returns
    Type Description
    System.Object

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

    Devolve o valor de um atributo, respeitando os locks da base de dados.

    Declaration
    dynamic DaValorAtributoLock(string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoRascunho(String, Int32, String, Int32, String)

    Devolve o valor de um atributo de um rascunho.

    Declaration
    dynamic DaValorAtributoRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoRascunhoLock(String, Int32, String, Int32, String)

    Devolve o valor de um atributo de um rascunho, respeitando os locks da base de dados.

    Declaration
    dynamic DaValorAtributoRascunhoLock(string TipoLancamento, int Ano, string Diario, int NumDiario, string Atributo)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

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

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(string TipoLancamento, int Ano, string Diario, int NumDiario, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaID(String, Object[])

    Devolve um conjunto de valores de atributos de uma linha.

    Declaration
    StdBECampos DaValorAtributosLinhaID(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos

    Conjunto de atributos a devolver.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaIDComum(String, Object[])

    Devolve um conjunto de valores de atributos de uma linha de um documento ou rascunho.

    Declaration
    StdBECampos DaValorAtributosLinhaIDComum(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos

    Conjunto de atributos a devolver.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaIDComumLock(String, Object[])

    Devolve um conjunto de valores de atributos de uma linha de um documento ou rascunho, respeitando os locks da base de dados.

    Declaration
    StdBECampos DaValorAtributosLinhaIDComumLock(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos

    Conjunto de atributos a devolver.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaIDLock(String, Object[])

    Devolve um conjunto de valores de atributos de uma linha, respeitando os locks da base de dados.

    Declaration
    StdBECampos DaValorAtributosLinhaIDLock(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos

    Conjunto de atributos a devolver.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaRascunhoID(String, Object[])

    Devolve um conjunto de valores de atributos de uma linha de um rascunho.

    Declaration
    StdBECampos DaValorAtributosLinhaRascunhoID(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos

    Conjunto de atributos a devolver.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaRascunhoIDLock(String, Object[])

    Devolve um conjunto de valores de atributos de uma linha de um rascunho, respeitando os locks da base de dados.

    Declaration
    StdBECampos DaValorAtributosLinhaRascunhoIDLock(string ID, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String ID
    System.Object[] Atributos

    Conjunto de atributos a devolver.

    Returns
    Type Description
    StdBECampos

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

    Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.

    Declaration
    StdBECampos DaValorAtributosLock(string TipoLancamento, int Ano, string Diario, int NumDiario, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosRascunho(String, Int32, String, Int32, Object[])

    Devolve o valor de um conjunto de atributos de um rascunho.

    Declaration
    StdBECampos DaValorAtributosRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosRascunhoLock(String, Int32, String, Int32, Object[])

    Devolve o valor de um conjunto de atributos de um rascunho, respeitando os locks da base de dados.

    Declaration
    StdBECampos DaValorAtributosRascunhoLock(string TipoLancamento, int Ano, string Diario, int NumDiario, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    Edita(Int32, String, Int32)

    Edita a informação do Documento.

    Declaration
    CblBEDocumento Edita(int Ano, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    Returns
    Type Description
    CblBEDocumento

    Edita(Int32, String, Int32, ref String)

    Edita a informação do Documento.

    Declaration
    CblBEDocumento Edita(int Ano, string Diario, int NumDiario, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    CblBEDocumento

    EditaComum(Int32, String, Int32)

    Declaration
    CblBEDocumento EditaComum(int Ano, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Diario
    System.Int32 NumDiario
    Returns
    Type Description
    CblBEDocumento

    EditaComum(Int32, String, Int32, ref String)

    Declaration
    CblBEDocumento EditaComum(int Ano, string Diario, int NumDiario, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Diario
    System.Int32 NumDiario
    System.String TipoLancamento
    Returns
    Type Description
    CblBEDocumento

    EditaRascunho(Int32, String, Int32, String)

    Edita a informação do Rascunho.

    Declaration
    CblBEDocumento EditaRascunho(int Ano, string Diario, int NumDiario, string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    CblBEDocumento

    EstornaDocumento(Int32, String, Int32, String, DateTime, Int32, Int32, Int32, String, String, String, String, Boolean, Int32, String, String, String)

    Estorna um Documento pela chave lógica.

    Declaration
    CblBEDocumento EstornaDocumento(int Ano, string Diario, int NumDiario, string TipoLancamento, DateTime DataDoc, int AnoLanc, int MesLanc, int DiaLanc, string Documento, string DiarioDoc, string NumDocExterno, string Descricao, bool NaturezaInversa = true, int NumDoc = -1, string ModuloOrigem = "L", string IdDocOrigem = "", string MotivoEstorno = "")
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.DateTime DataDoc

    Identificador da Data do Documento de Estorno.

    System.Int32 AnoLanc

    Identificador do Ano do Lançamento.

    System.Int32 MesLanc
    System.Int32 DiaLanc
    System.String Documento

    Identificador do Documento.

    System.String DiarioDoc

    Identificador do Diário.

    System.String NumDocExterno

    Identificador do Número do Documento Externo.

    System.String Descricao

    Descrição para o Documento de Estorno.

    System.Boolean NaturezaInversa

    TRUE o estorno é de natureza inversa; FALSE o estorno é de valores inversos.

    System.Int32 NumDoc

    Número de Documento.

    System.String ModuloOrigem

    Modulo que está a invocar o método.

    System.String IdDocOrigem

    Identificador do Documento Origem.

    System.String MotivoEstorno

    Motivo de Estorno.

    Returns
    Type Description
    CblBEDocumento

    EstornaDocumentoID(String, DateTime, Int32, Int32, Int32, String, String, String, String, Boolean, Int32, String, String, String, String)

    Estorna um Documento pelo ID.

    Declaration
    CblBEDocumento EstornaDocumentoID(string ID, DateTime DataDoc, int AnoLanc, int MesLanc, int DiaLanc, string Documento, string DiarioDoc, string NumDocExterno, string Descricao, bool NaturezaInversa = true, int NumDoc = -1, string ModuloOrigem = "L", string IdDocOrigem = "", string MotivoEstorno = "", string SerieEstorno = "")
    Parameters
    Type Name Description
    System.String ID

    Identificador do Documento.

    System.DateTime DataDoc

    Identificador da Data do Documento de Estorno.

    System.Int32 AnoLanc

    Identificador do Ano do Lançamento.

    System.Int32 MesLanc
    System.Int32 DiaLanc
    System.String Documento

    Identificador do Documento.

    System.String DiarioDoc

    Identificador do Diário.

    System.String NumDocExterno

    Identificador do Número do Documento Externo.

    System.String Descricao

    Descrição para o Documento de Estorno.

    System.Boolean NaturezaInversa

    Se TRUE o estorno é de natureza inversa, FALSE o estorno é de valores inversos.

    System.Int32 NumDoc

    Número de Documento.

    System.String ModuloOrigem

    Modulo que está a invocar o método.

    System.String IdDocOrigem

    Identificador do Documento Origem.

    System.String MotivoEstorno

    Motivo de Estorno.

    System.String SerieEstorno
    Returns
    Type Description
    CblBEDocumento

    Existe(Int32, String, Int32)

    Verifica se existe o Documento.

    Declaration
    bool Existe(int Ano, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    Returns
    Type Description
    System.Boolean

    Existe(Int32, String, Int32, ref String)

    Verifica se existe o Documento.

    Declaration
    bool Existe(int Ano, string Diario, int NumDiario, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    System.Boolean

    ExisteAnoDiarioDocumentoNumDoc(Int32, String, String, Int32)

    Verifica se existe o Documento.

    Declaration
    bool ExisteAnoDiarioDocumentoNumDoc(int Ano, string Diario, string Documento, int NumDocumento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do documento.

    System.String Diario

    Identificador do Diário.

    System.String Documento

    Identificador do Documento.

    System.Int32 NumDocumento

    Número do documento.

    Returns
    Type Description
    System.Boolean

    ExisteAnoDiarioDocumentoNumDoc(Int32, String, String, Int32, ref String)

    Verifica se existe o Documento.

    Declaration
    bool ExisteAnoDiarioDocumentoNumDoc(int Ano, string Diario, string Documento, int NumDocumento, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do documento.

    System.String Diario

    Identificador do Diário.

    System.String Documento

    Identificador do Documento.

    System.Int32 NumDocumento

    Número do documento.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    System.Boolean

    ExisteComum(Int32, String, Int32)

    VErifica se existe um documento ou um rascunho com a chave logica

    Declaration
    bool ExisteComum(int Ano, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    Returns
    Type Description
    System.Boolean

    ExisteComum(Int32, String, Int32, ref String)

    VErifica se existe um documento ou um rascunho com a chave logica

    Declaration
    bool ExisteComum(int Ano, string Diario, int NumDiario, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    System.Boolean

    ExisteDocumentoApuramento(Int32, CblBEDocumento.TipoTrancacao, Boolean)

    Declaration
    bool ExisteDocumentoApuramento(int Ano, CblBEDocumento.TipoTrancacao TipoTransacao, bool IncluiAnulados = false)
    Parameters
    Type Name Description
    System.Int32 Ano
    CblBEDocumento.TipoTrancacao TipoTransacao
    System.Boolean IncluiAnulados
    Returns
    Type Description
    System.Boolean

    ExisteDocumentoExterno(String, String, String, String, String, String)

    Indica se um nº de documento externo existe.

    Declaration
    bool ExisteDocumentoExterno(string Documento, string NumDocExterno, string Serie, string IdCabec = "", string TipoEntidade = "", string Entidade = "")
    Parameters
    Type Name Description
    System.String Documento
    System.String NumDocExterno

    Nº do documento externo a validar.

    System.String Serie
    System.String IdCabec

    Caso preenchido, exclui este documento da validação.

    System.String TipoEntidade

    Caso preenchido, indica o tipo de entidade a validar.

    System.String Entidade

    Caso preenchido, indica a entidade a validar.

    Returns
    Type Description
    System.Boolean

    ExistemMovimentosConferidosID(String, String, String)

    Verifica se existe movimentos com estado de conferência.

    Declaration
    bool ExistemMovimentosConferidosID(string ID, string strErro, string TipoEstado = "")
    Parameters
    Type Name Description
    System.String ID

    Identificador do Documento.

    System.String strErro

    Recebe a descrição de eventuais erros detectados.

    System.String TipoEstado
    Returns
    Type Description
    System.Boolean

    ExisteRascunho(Int32, String, Int32)

    Verifica se existe o Rascunho.

    Declaration
    bool ExisteRascunho(int Ano, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    Returns
    Type Description
    System.Boolean

    ExisteRascunho(Int32, String, Int32, String)

    Verifica se existe o Rascunho.

    Declaration
    bool ExisteRascunho(int Ano, string Diario, int NumDiario, string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    System.Boolean

    Insere(Int32)

    Função que cria um novo Documento.

    Declaration
    CblBEDocumento Insere(int Ano)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    Returns
    Type Description
    CblBEDocumento

    Insere(Int32, String)

    Função que cria um novo Documento.

    Declaration
    CblBEDocumento Insere(int Ano, string Documento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Documento

    Identificador do Documento.

    Returns
    Type Description
    CblBEDocumento

    Insere(Int32, String, ref String)

    Função que cria um novo Documento.

    Declaration
    CblBEDocumento Insere(int Ano, string Documento, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Documento

    Identificador do Documento.

    System.String TipoLancamento
    Returns
    Type Description
    CblBEDocumento

    Insere(Int32, String, ref String, Boolean)

    Função que cria um novo Documento.

    Declaration
    CblBEDocumento Insere(int Ano, string Documento, ref string TipoLancamento, bool ApenasAnoAtual)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Documento

    Identificador do Documento.

    System.String TipoLancamento
    System.Boolean ApenasAnoAtual

    Utilização em exercicios publicos para permitir o lançamentos de contas plurianuais.

    Returns
    Type Description
    CblBEDocumento

    InverteNaturezaValoresNegativos(CblBEDocumento)

    Para os casos de documentos com valores negativos, este método inverte o valor para positivo e respetiva natureza.

    Declaration
    void InverteNaturezaValoresNegativos(CblBEDocumento ObjBeDocumento)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento

    LstDocumentos()

    Devolve listagem de Documentos.

    Declaration
    StdBELista LstDocumentos()
    Returns
    Type Description
    StdBELista

    PreencheDadosDocumentoAnulado(Int32, String, Int32, String, String)

    Preenche anulação de um Documento pela chave lógica do origem.

    Declaration
    CblBEDocumento PreencheDadosDocumentoAnulado(int Ano, string Diario, int NumDiario, string TipoLancamento = "", string ModuloOrigem = "L")
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.String ModuloOrigem

    Identificador o módulo origem

    Returns
    Type Description
    CblBEDocumento

    PreencheDadosDocumentoAnuladoID(String, String)

    Preenche anulação de um Documento pelo ID do origem.

    Declaration
    CblBEDocumento PreencheDadosDocumentoAnuladoID(string ID, string ModuloOrigem = "L")
    Parameters
    Type Name Description
    System.String ID

    Identificador do Documento.

    System.String ModuloOrigem

    Identificador o módulo origem

    Returns
    Type Description
    CblBEDocumento

    PreencheDadosDocumentoEstorno(Int32, String, Int32, String, DateTime, Int32, Int32, Int32, String, String, String, String, Boolean, Int32, String, String)

    Preenche estorno de um Documento pela chave lógica do origem.

    Declaration
    CblBEDocumento PreencheDadosDocumentoEstorno(int Ano, string Diario, int NumDiario, string TipoLancamento = "", DateTime DataDoc = default(DateTime), int AnoLanc = -1, int MesLanc = -1, int DiaLanc = -1, string Documento = "", string DiarioDoc = "", string NumDocExterno = "", string Descricao = "", bool NaturezaInversa = true, int NumDoc = -1, string ModuloOrigem = "L", string IdDocOrigem = "")
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.DateTime DataDoc

    Identificador da Data do Documento de Estorno.

    System.Int32 AnoLanc

    Identificador do Ano do Lançamento.

    System.Int32 MesLanc
    System.Int32 DiaLanc
    System.String Documento

    Identificador do Documento.

    System.String DiarioDoc

    Identificador do Diário.

    System.String NumDocExterno

    Identificador do Número do Documento Externo.

    System.String Descricao

    Descrição para o Documento de Estorno.

    System.Boolean NaturezaInversa

    Se TRUE o estorno é de natureza inversa, FALSE o estorno é de valores inversos.

    System.Int32 NumDoc

    Identificador do número de documento.

    System.String ModuloOrigem

    Identificador o módulo origem

    System.String IdDocOrigem
    Returns
    Type Description
    CblBEDocumento

    PreencheDadosDocumentoEstornoID(String, DateTime, Int32, Int32, Int32, String, String, String, String, Boolean, Int32, String, String)

    Preenche um Documento de estorno pelo ID do origem.

    Declaration
    CblBEDocumento PreencheDadosDocumentoEstornoID(string ID, DateTime DataDoc = default(DateTime), int AnoLanc = -1, int MesLanc = -1, int DiaLanc = -1, string Documento = "", string DiarioDoc = "", string NumDocExterno = "", string Descricao = "", bool NaturezaInversa = true, int NumDoc = -1, string ModuloOrigem = "L", string IdDocOrigem = "")
    Parameters
    Type Name Description
    System.String ID

    Identificador do Documento.

    System.DateTime DataDoc

    Identificador da Data do Documento de Estorno.

    System.Int32 AnoLanc

    Identificador do Ano do Lançamento.

    System.Int32 MesLanc
    System.Int32 DiaLanc
    System.String Documento

    Identificador do Documento.

    System.String DiarioDoc

    Identificador do Diário.

    System.String NumDocExterno

    Identificador do Número do Documento Externo.

    System.String Descricao

    Descrição para o Documento de Estorno.

    System.Boolean NaturezaInversa

    Se TRUE o estorno é de natureza inversa, FALSE o estorno é de valores inversos.

    System.Int32 NumDoc

    Identificador do número de documento.

    System.String ModuloOrigem

    Identificador o módulo origem

    System.String IdDocOrigem
    Returns
    Type Description
    CblBEDocumento

    Remove(Int32, String, Int32, Boolean, String, String)

    Remove o Documento.

    Declaration
    bool Remove(int Ano, string Diario, int NumDiario, bool lAteracao, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Boolean lAteracao
    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    Remove(Int32, String, Int32, Boolean, ref String, Boolean, String, String)

    Remove o Documento.

    Declaration
    bool Remove(int Ano, string Diario, int NumDiario, bool lAteracao, ref string TipoLancamento, bool AlteraIntegracaoCBL, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Boolean lAteracao
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Boolean AlteraIntegracaoCBL
    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    Remove(Int32, String, Int32, Boolean, ref String, String, String)

    Remove o Documento.

    Declaration
    bool Remove(int Ano, string Diario, int NumDiario, bool lAteracao, ref string TipoLancamento, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Boolean lAteracao
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    Remove(Int32, String, Int32, String, String)

    Remove o Documento.

    Declaration
    bool Remove(int Ano, string Diario, int NumDiario, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    RemoveComum(Int32, String, Int32, Boolean, String, String)

    Remove um Documento ou um Rascunho.

    Declaration
    bool RemoveComum(int Ano, string Diario, int NumDiario, bool lAteracao, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Boolean lAteracao
    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    RemoveComum(Int32, String, Int32, Boolean, ref String, String, String)

    Remove um Documento ou um Rascunho.

    Declaration
    bool RemoveComum(int Ano, string Diario, int NumDiario, bool lAteracao, ref string TipoLancamento, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.Boolean lAteracao
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    RemoveComum(Int32, String, Int32, String, String)

    Remove um Documento ou um Rascunho.

    Declaration
    bool RemoveComum(int Ano, string Diario, int NumDiario, string MotivoAnulacao = null, string ObsAnulacao = null)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String MotivoAnulacao

    Código Motivo Anulação.

    System.String ObsAnulacao

    Observações da Anulação.

    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String)

    Efectua a validação da informação do Documento.

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String, ref String)

    Efectua a validação da informação do Documento.

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro, ref string Avisos)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String, ref String, Boolean)

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro, ref string Avisos, bool IgnoraApuramentos = false)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    System.Boolean IgnoraApuramentos
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String, ref String, Boolean, CblBEDocumento)

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro, ref string Avisos, bool IgnoraApuramentos = false, CblBEDocumento objDocumentoOriginal = null)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    System.Boolean IgnoraApuramentos
    CblBEDocumento objDocumentoOriginal
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String, ref String, Boolean, CblBEDocumento, Boolean)

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro, ref string Avisos, bool IgnoraApuramentos = false, CblBEDocumento objDocumentoOriginal = null, bool ValidaTotais = false)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    System.Boolean IgnoraApuramentos
    CblBEDocumento objDocumentoOriginal
    System.Boolean ValidaTotais
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String, ref String, Boolean, CblBEDocumento, Boolean, Boolean)

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro, ref string Avisos, bool IgnoraApuramentos = false, CblBEDocumento objDocumentoOriginal = null, bool ValidaTotais = false, bool validaNumEstado = false)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    System.Boolean IgnoraApuramentos
    CblBEDocumento objDocumentoOriginal
    System.Boolean ValidaTotais
    System.Boolean validaNumEstado
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEDocumento, ref String, ref String, Boolean, CblBEDocumento, Boolean, Boolean, Boolean)

    Declaration
    bool ValidaActualizacao(CblBEDocumento ObjBeDocumento, ref string strErro, ref string Avisos, bool IgnoraApuramentos = false, CblBEDocumento objDocumentoOriginal = null, bool ValidaTotais = false, bool validaNumEstado = false, bool blnPassagemSaldos = false)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    System.Boolean IgnoraApuramentos
    CblBEDocumento objDocumentoOriginal
    System.Boolean ValidaTotais
    System.Boolean validaNumEstado
    System.Boolean blnPassagemSaldos
    Returns
    Type Description
    System.Boolean

    ValidaActualizacaoRascunho(CblBEDocumento, ref String, String)

    Efectua a validação da informação do Rascunho.

    Declaration
    bool ValidaActualizacaoRascunho(CblBEDocumento ObjBeDocumento, ref string strErro, string Avisos = "")
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    System.String Avisos
    Returns
    Type Description
    System.Boolean

    ValidaCancelaRascunho(CblBEDocumento, ref String)

    Efectua as validações necessárias ao cancelamento do rascunho.

    Declaration
    bool ValidaCancelaRascunho(CblBEDocumento ObjBeDocumento, ref string ErroValidacao)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento

    Documento sobre o qual incide a validação.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaCancelaRascunho(String, Int32, String, Int32, ref String)

    Efectua as validações necessárias ao cancelamento do rascunho.

    Declaration
    bool ValidaCancelaRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaCopiaDocumento(CblBEDocumento, ref String)

    Efectua a validação da copia do Documento.

    Declaration
    bool ValidaCopiaDocumento(CblBEDocumento ObjBeDocumento, ref string strErro)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento
    System.String strErro
    Returns
    Type Description
    System.Boolean

    ValidaEstornoDocumento(CblBEDocumento, Int32, Int32, Int32, String, ref String)

    Valida Estorno do Documento.

    Declaration
    bool ValidaEstornoDocumento(CblBEDocumento ObjBeDocumento, int AnoLanc, int MesLanc, int DiaLanc, string ModuloOrigem, ref string strErro)
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento

    Documento a estornar.

    System.Int32 AnoLanc

    Ano do documento do estorno.

    System.Int32 MesLanc

    Mês do documento do estorno.

    System.Int32 DiaLanc

    Dia do documento do estorno.

    System.String ModuloOrigem

    Módulo Origem.

    System.String strErro

    Erro de descrição.

    Returns
    Type Description
    System.Boolean

    Pode estornar ou não o documento.

    ValidaEstornoDocumento(CblBEDocumento, ref String, String)

    Efectua a validação do estorno do Documento.

    Declaration
    bool ValidaEstornoDocumento(CblBEDocumento ObjBeDocumento, ref string strErro, string ModuloOrigem = "L")
    Parameters
    Type Name Description
    CblBEDocumento ObjBeDocumento

    Documento a validar.

    System.String strErro
    System.String ModuloOrigem

    Modulo que está a invocar o método.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, String, Int32, ref String)

    Efectua as validações necessárias à remoção do Documento.

    Declaration
    bool ValidaRemocao(int Ano, string Diario, int NumDiario, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, String, Int32, ref String, ref String)

    Efectua as validações necessárias à remoção do Documento.

    Declaration
    bool ValidaRemocao(int Ano, string Diario, int NumDiario, ref string ErroValidacao, ref string TipoLancamento)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, String, Int32, ref String, ref String, String)

    Efectua as validações necessárias à remoção do Documento.

    Declaration
    bool ValidaRemocao(int Ano, string Diario, int NumDiario, ref string ErroValidacao, ref string TipoLancamento, string MotivoAnulacao)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.String MotivoAnulacao

    Identificador do Motivo de Anulação.

    Returns
    Type Description
    System.Boolean

    ValidaRemocaoRascunho(String, Int32, String, Int32, ref String)

    Efectua as validações necessárias à remoção do rascunho.

    Declaration
    bool ValidaRemocaoRascunho(string TipoLancamento, int Ano, string Diario, int NumDiario, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.String TipoLancamento

    Identificador do Tipo de Lançamento.

    System.Int32 Ano

    Identificador do Ano.

    System.String Diario

    Identificador do Diário.

    System.Int32 NumDiario

    Número do Diário.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    VerificaDocumentoEstorno(String, String, ref String)

    Recebe o documento de origem e testa se este deu origem a estorno ou ele próprio foi estornado, retornando o documento.

    Declaration
    bool VerificaDocumentoEstorno(string ID, string IDEstorno, ref string strDocEstorno)
    Parameters
    Type Name Description
    System.String ID

    Identificador do Documento a testar.

    System.String IDEstorno

    Identificador do Documento de estorno a testar.

    System.String strDocEstorno

    String com documento de estorno ou estornado.

    Returns
    Type Description
    System.Boolean