PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface ICblBSPlanoContas

    Namespace: ICblBS100
    Assembly: ICblBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("5694F3AB-5912-48DC-93A6-D46BED5E6326")]
    public interface ICblBSPlanoContas

    Methods

    ActividadeAssociadaConta(Int32, String)

    Devolve o código da Actividade associada à conta.

    Declaration
    string ActividadeAssociadaConta(int Ano, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador da Conta.

    Returns
    Type Description
    System.String

    ActividadeEmUso(Int32, String)

    Devolve se uma determinada actividade está em uso ou não.

    Declaration
    bool ActividadeEmUso(int Ano, string Actividade)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Actividade

    Identificador da Actividade.

    Returns
    Type Description
    System.Boolean

    ActividadeJaAssociada(Int32, String, String)

    Devolve se o código da Actividade já está a ser utilizado ou não.

    Declaration
    bool ActividadeJaAssociada(int Ano, string Actividade, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Actividade

    Identificador da Actividade.

    System.String Conta

    Identificador da Conta.

    Returns
    Type Description
    System.Boolean

    Actualiza(CblBEConta)

    Procedimento para actualização.

    Declaration
    void Actualiza(CblBEConta objBEConta)
    Parameters
    Type Name Description
    CblBEConta objBEConta

    Objecto contendo a informação actualizada da conta.

    Actualiza(CblBEConta, ref String)

    Procedimento para actualização.

    Declaration
    void Actualiza(CblBEConta objBEConta, ref string Avisos)
    Parameters
    Type Name Description
    CblBEConta objBEConta

    Objecto contendo a informação actualizada da conta.

    System.String Avisos

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

    ActualizaValorAtributo(Int32, String, String, Object)

    Actualiza o valor de um atributo.

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

    Identificador do Ano.

    System.String Conta

    Identificador da Conta.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributoLinha(Int32, String, Int32, String, Object)

    Actualiza o valor de um atributo de uma linha de do Plano de Contas.

    Declaration
    void ActualizaValorAtributoLinha(int Ano, string Conta, int Linha, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.Int32 Linha

    Número da linha.

    System.String Atributo
    System.Object Valor

    Identifica o valor a gravar no atributo seleccionado.

    ActualizaValorAtributos(Int32, String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

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

    Identificador do Ano.

    System.String Conta

    Identificador da Conta.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    ActualizaValorAtributosLinha(Int32, String, Int32, StdBECampos)

    Actualiza o valor de um conjunto de atributos dem uma linha do Plano de Contas.

    Declaration
    void ActualizaValorAtributosLinha(int Ano, string Conta, int Linha, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.Int32 Linha

    Número da linha.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    ContaAssociadaActividade(Int32, String)

    Devolve Conta associada à Actividade.

    Declaration
    string ContaAssociadaActividade(int Ano, string Actividade)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Actividade

    Identificador da Actividade.

    Returns
    Type Description
    System.String

    ContaInactiva(Int32, String)

    Devolve se uma determinada conta está incativa ou não.

    Declaration
    bool ContaInactiva(int Ano, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    Returns
    Type Description
    System.Boolean

    ContaTemRecapitulativos(String, String, Int32)

    Devolve se uma determinada conta o seu prefixo está sujeito a recapitulativos

    Declaration
    bool ContaTemRecapitulativos(string Conta, string Tipo, int intAno)
    Parameters
    Type Name Description
    System.String Conta

    Identificador de Conta.

    System.String Tipo

    Identificador do tipo de entidade da conta (0-Clientes; 5-Fornecedores; 10-Outros Terceiros; Outro Valor-Todos)

    System.Int32 intAno

    Identificador do Ano.

    Returns
    Type Description
    System.Boolean

    ContaTemRecapitulativos(String, String, Int32, ref String)

    Devolve se uma determinada conta o seu prefixo está sujeito a recapitulativos

    Declaration
    bool ContaTemRecapitulativos(string Conta, string Tipo, int intAno, ref string ContaCBL)
    Parameters
    Type Name Description
    System.String Conta

    Identificador de Conta.

    System.String Tipo

    Identificador do tipo de entidade da conta (0-Clientes; 5-Fornecedores; 10-Outros Terceiros; Outro Valor-Todos)

    System.Int32 intAno

    Identificador do Ano.

    System.String ContaCBL

    Sufixo da conta sujeita a recapitulativos

    Returns
    Type Description
    System.Boolean

    DaContaConsolidacao(Int32, String, String)

    Devolve a Conta de Consolidação

    Declaration
    string DaContaConsolidacao(int Ano, string Conta, string Natureza)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano do plano de contas.

    System.String Conta

    Identificador da Conta.

    System.String Natureza

    Indica a natureza pretendidade da conta de consolidação para o caso de desegregação por natureza de saldos.

    Returns
    Type Description
    System.String

    DaContaInferior(Int32, String)

    Devolve a conta inferior.

    Declaration
    string DaContaInferior(int Ano, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador da conta.

    Returns
    Type Description
    System.String

    DaContaLigacaoCBL(Int32, String, CblBETipos.ContaCBLPlanoLigacao)

    Devolve a Conta de Ligação à Contabilidade.

    Declaration
    string DaContaLigacaoCBL(int Ano, string Conta, CblBETipos.ContaCBLPlanoLigacao TipoConta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador da Conta de Imobilizado.

    CblBETipos.ContaCBLPlanoLigacao TipoConta

    Identificador do Tipo de Conta (Abates, Mais Valia, Menos Valia, etc).

    Returns
    Type Description
    System.String

    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 Plano de Contas.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtilLinhas()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaDescricao(Int32, String)

    Descrição associada à conta.

    Declaration
    string DaDescricao(int Ano, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    Returns
    Type Description
    System.String

    DaValorAtributo(Int32, String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(int Ano, string Conta, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoLinha(Int32, String, Int32, String)

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

    Declaration
    dynamic DaValorAtributoLinha(int Ano, string Conta, int Linha, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.Int32 Linha

    Número da linha.

    System.String Atributo

    Identifica o atributo para o qual se pretende devolver o valor.

    Returns
    Type Description
    System.Object

    DaValorAtributoLinhaLock(Int32, String, Int32, String)

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

    Declaration
    dynamic DaValorAtributoLinhaLock(int Ano, string Conta, int Linha, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.Int32 Linha

    Número da linha.

    System.String Atributo

    Identifica o atributo para o qual se pretende devolver o valor.

    Returns
    Type Description
    System.Object

    DaValorAtributoLock(Int32, String, String)

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

    Declaration
    dynamic DaValorAtributoLock(int Ano, string Conta, string Atributo)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(Int32, String, Object[])

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(int Ano, string Conta, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosArray(Int32, String, String[])

    Devolve o valor de um conjunto de atributos através de um array, utilizada na validação do documento.

    Declaration
    StdBECampos DaValorAtributosArray(int Ano, string Conta, string[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinha(Int32, String, Int32, String[])

    Devolve os valores de atributos de uma linha de uma Conta.

    Declaration
    StdBECampos DaValorAtributosLinha(int Ano, string Conta, int Linha, string[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.Int32 Linha

    Número da linha.

    System.String[] Atributos

    Identifica os atributos para os quais se pretende devolver os valores.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLinhaLock(Int32, String, Int32, String[])

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

    Declaration
    StdBECampos DaValorAtributosLinhaLock(int Ano, string Conta, int Linha, string[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.Int32 Linha

    Número da linha.

    System.String[] Atributos

    Identifica os atributos para os quais se pretende devolver os valores.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLock(Int32, String, Object[])

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

    Declaration
    StdBECampos DaValorAtributosLock(int Ano, string Conta, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador de Conta.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    DaValorUnitarioActividade(Int32, String, String, String, Int32, Int32)

    Devolve o valor unitário de uma linha da actividade

    Declaration
    decimal DaValorUnitarioActividade(int Ano, string Conta, string Projecto, string Origem, int PeriodoInicial, int PeriodoFinal)
    Parameters
    Type Name Description
    System.Int32 Ano

    Exercicio.

    System.String Conta

    Identificador da Conta.

    System.String Projecto

    Identificador do Projecto.

    System.String Origem
    System.Int32 PeriodoInicial

    Periodo Inicial.

    System.Int32 PeriodoFinal

    Periodo Final.

    Returns
    Type Description
    System.Decimal

    Edita(Int32, String)

    Edição de uma conta do POC.

    Declaration
    CblBEConta Edita(int Ano, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador da Conta.

    Returns
    Type Description
    CblBEConta

    EfetuaRecodificacaoContas(Int32, String, String, Boolean, String)

    Efetua a recodificação de contas.

    Declaration
    void EfetuaRecodificacaoContas(int Exercicio, string PrefixoContaAntiga, string PrefixoContaNova, bool EfetuarReconstrucaoAcumulados = true, string Avisos = "")
    Parameters
    Type Name Description
    System.Int32 Exercicio

    Exercicio económico.

    System.String PrefixoContaAntiga

    Prefixo da conta a ser recodificada.

    System.String PrefixoContaNova

    Prefixo da conta a recodificar.

    System.Boolean EfetuarReconstrucaoAcumulados

    Reconstrução de acumulados no final da operação.

    System.String Avisos

    Avisos.

    Existe(Int32, String)

    Verifica se existe a conta no Plano de Contas.

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

    Identificador do Ano.

    System.String Conta

    Identificador da Conta.

    Returns
    Type Description
    System.Boolean

    ExisteContaLancamento(Int32, String, ref String)

    Declaration
    bool ExisteContaLancamento(int Ano, string Conta, ref string TipoConta)
    Parameters
    Type Name Description
    System.Int32 Ano
    System.String Conta
    System.String TipoConta
    Returns
    Type Description
    System.Boolean

    GeraSqlWhereCategoriaSubQuery()

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery()
    Returns
    Type Description
    System.String

    GeraSqlWhereCategoriaSubQuery(ref String)

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal)
    Parameters
    Type Name Description
    System.String TabelaPrincipal

    Tabela principal da categoria.

    Returns
    Type Description
    System.String

    GeraSqlWhereCategoriaSubQuery(ref String, ref String)

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal)
    Parameters
    Type Name Description
    System.String TabelaPrincipal

    Tabela principal da categoria.

    System.String CampoPrincipal

    Campo principal da categoria.

    Returns
    Type Description
    System.String

    GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String)

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro)
    Parameters
    Type Name Description
    System.String TabelaPrincipal

    Tabela principal da categoria.

    System.String CampoPrincipal

    Campo principal da categoria.

    System.String TabelaFiltro

    Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.

    Returns
    Type Description
    System.String

    GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String, ref String)

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro, ref string CampoFiltro)
    Parameters
    Type Name Description
    System.String TabelaPrincipal

    Tabela principal da categoria.

    System.String CampoPrincipal

    Campo principal da categoria.

    System.String TabelaFiltro

    Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.

    System.String CampoFiltro

    Campo que irá filtrar os dados.

    Returns
    Type Description
    System.String

    GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String, ref String, String)

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de Contas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro, ref string CampoFiltro, string Utilizador)
    Parameters
    Type Name Description
    System.String TabelaPrincipal

    Tabela principal da categoria.

    System.String CampoPrincipal

    Campo principal da categoria.

    System.String TabelaFiltro

    Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.

    System.String CampoFiltro

    Campo que irá filtrar os dados.

    System.String Utilizador

    Utilizador aos quais estão associadados os filtros da categoria, quando diferente do utilizador de Contexto.

    Returns
    Type Description
    System.String

    IdentificaTipoConta(String, ref Int32, ref String, ref String, ref Int32)

    Função que permite identificar o tipo de conta.

    Declaration
    int IdentificaTipoConta(string Conta, ref int WCards, ref string LimI, ref string LimS, ref int UltP)
    Parameters
    Type Name Description
    System.String Conta

    Identificador da Conta.

    System.Int32 WCards
    System.String LimI

    Identificador do limite inferior.

    System.String LimS

    Identificador do limite superior.

    System.Int32 UltP

    Identificador da ultima posição.

    Returns
    Type Description
    System.Int32

    LstContas()

    Listagem de Contas do POC.

    Declaration
    StdBELista LstContas()
    Returns
    Type Description
    StdBELista

    LstTiposActividades()

    Listagem das actividades do Plano de Contas

    Declaration
    StdBELista LstTiposActividades()
    Returns
    Type Description
    StdBELista

    Remove(Int32, String)

    Procedimento para remoção de contas do POC. Parte do príncipio que as validações já foram efectuadas.

    Declaration
    void Remove(int Ano, string Conta)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador da conta a remover.

    TransferenciaContas(Int32, Int32, String, String, String, Int32, Int32, Boolean, String, Boolean, String, Boolean, Boolean, Boolean, Boolean)

    Transferência movimento de conta

    Declaration
    void TransferenciaContas(int tipoPlano, int Ano, string tipoLanc, string strOrigem, string strDestino, int mMesInicio = 0, int mMesFim = 15, bool blnDiario = false, string lstDiarios = "", bool blnNumDiario = false, string strNumDiario = "", bool blnEntidade = false, bool blnLimpaEntidade = false, bool blnAcumulados = true, bool blnSVAT = false)
    Parameters
    Type Name Description
    System.Int32 tipoPlano

    Identificador do Tipo de Plano.

    System.Int32 Ano

    Identificador do Ano.

    System.String tipoLanc

    Identificador do Tipo de Lançamento.

    System.String strOrigem

    Transferência Origem

    System.String strDestino

    Transferência Destino

    System.Int32 mMesInicio

    Mês Inicio

    System.Int32 mMesFim

    Mês Fim

    System.Boolean blnDiario

    Utiliza Diário como parâmetro

    System.String lstDiarios

    Diário

    System.Boolean blnNumDiario

    Utiliza Número Diário como parâmetro

    System.String strNumDiario

    Número Diário

    System.Boolean blnEntidade

    Substituir a entidade do movimento pela entidade da conta destino.

    System.Boolean blnLimpaEntidade

    Limpar os dados da entidade se a conta destino não tiver nenhuma entidade definida.

    System.Boolean blnAcumulados

    Reconstrução de Acumulados

    System.Boolean blnSVAT

    Indica se está a ser chamado pelo SVAT

    ValidaActualizacao(CblBEConta, ref String)

    Declaration
    bool ValidaActualizacao(CblBEConta BEConta, ref string StrErro)
    Parameters
    Type Name Description
    CblBEConta BEConta
    System.String StrErro
    Returns
    Type Description
    System.Boolean

    ValidaActualizacao(CblBEConta, ref String, ref String)

    Efectua a validação da informação da conta.

    Declaration
    bool ValidaActualizacao(CblBEConta BEConta, ref string StrErro, ref string Avisos)
    Parameters
    Type Name Description
    CblBEConta BEConta

    Objecto contendo a informação que se pretende validar.

    System.String StrErro
    System.String Avisos
    Returns
    Type Description
    System.Boolean

    ValidaOperacaoCategoria(Int32, String, ref String, Int32)

    Devolve se o utilizador actual tem acesso a uma determinada Conta do Plano de Contas, analisando os filtros da categoria.

    Declaration
    bool ValidaOperacaoCategoria(int Ano, string Conta, ref string MsgErro, int Linha = -1)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano.

    System.String Conta

    Conta.

    System.String MsgErro
    System.Int32 Linha

    Número da linha.

    Returns
    Type Description
    System.Boolean

    ValidaRecodificacaoContas(Int32, String, String, ref String, ref String)

    Declaration
    bool ValidaRecodificacaoContas(int Exercicio, string PrefixoContaAntiga, string PrefixoContaNova, ref string ErroValidacao, ref string Avisos)
    Parameters
    Type Name Description
    System.Int32 Exercicio
    System.String PrefixoContaAntiga
    System.String PrefixoContaNova
    System.String ErroValidacao
    System.String Avisos
    Returns
    Type Description
    System.Boolean

    ValidaRemocao(Int32, String, ref String)

    Efectua as validações necessárias à remoção da conta.

    Declaration
    bool ValidaRemocao(int Ano, string Conta, ref string StrErro)
    Parameters
    Type Name Description
    System.Int32 Ano

    Identificador do Ano.

    System.String Conta

    Identificador da conta.

    System.String StrErro
    Returns
    Type Description
    System.Boolean