PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IRhpBSProcessamentoSegSocial

    Classe utilizada para obter as regras de negócio do Processamento da Segurança Social.'Estrutura que vai facilitar o preenchimento da tabela auxiliar aos magnéticos'e ao mapa em Euros

    Namespace: IRhpBS100
    Assembly: IRhpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("15853A11-4503-4889-871E-09F5B193DD67")]
    public interface IRhpBSProcessamentoSegSocial

    Methods

    FormataNISS(String, Int32, Int32)

    Função que recebe um nº da Segurança Social, verifica-o e devolve-o no formato pedido.

    Declaration
    string FormataNISS(string sNISS, int TipoEntidade, int iFormato)
    Parameters
    Type Name Description
    System.String sNISS

    Número de Segurança Social a formatar

    System.Int32 TipoEntidade

    Tipo de entidade do número a formatar (1 - Pessoa singular; 2 - Pessoa Colectiva)

    System.Int32 iFormato

    1 ou 9 - 9 dígitos; 2 ou 11 - 11 dígitos

    Returns
    Type Description
    System.String

    GerarMagneticoAO(String, Int16, Byte, List<RhpBEErroAlertaSS>, String, String, Boolean)

    Função que trata da geração do magnético para a Segurança Social em Angola

    Declaration
    bool GerarMagneticoAO(string NomeFicheiro, short Ano, byte Mes, List<RhpBEErroAlertaSS> Erros, string NomeResponsavel, string EmailResponsavel, bool FolhaNormal)
    Parameters
    Type Name Description
    System.String NomeFicheiro

    Nome do ficheiro a ser gerado

    System.Int16 Ano

    Ano de referência do magnético

    System.Byte Mes

    Mês de referência do magnético

    System.Collections.Generic.List<RhpBEErroAlertaSS> Erros

    Colecção retornada com o detalhe das linhas problemáticas do magnético

    System.String NomeResponsavel

    Nome do responsável para emissão do ficheiro - Angola

    System.String EmailResponsavel

    Email do responsável pela emissão do ficheiro - Angola

    System.Boolean FolhaNormal

    Indicação se é uma folha normal - Angola

    Returns
    Type Description
    System.Boolean

    GerarMagneticoPT(String, Int16, Byte, List<RhpBEErroAlertaSS>)

    Função que trata da geração do magnético para a Segurança Social em Portugal

    Declaration
    bool GerarMagneticoPT(string NomeFicheiro, short Ano, byte Mes, List<RhpBEErroAlertaSS> Erros)
    Parameters
    Type Name Description
    System.String NomeFicheiro

    Nome do ficheiro a ser gerado

    System.Int16 Ano

    Ano de referência do magnético

    System.Byte Mes

    Mês de referência do magnético

    System.Collections.Generic.List<RhpBEErroAlertaSS> Erros

    Colecção retornada com o detalhe das linhas problemáticas do magnético

    Returns
    Type Description
    System.Boolean

    GerarMagneticoPT(String, Int16, Byte, List<RhpBEErroAlertaSS>, IEnumerable<String>, IEnumerable<String>)

    Função que trata da geração do magnético para a Segurança Social em Portugal

    Declaration
    bool GerarMagneticoPT(string NomeFicheiro, short Ano, byte Mes, List<RhpBEErroAlertaSS> Erros, IEnumerable<string> RestricaoInstSegSocial, IEnumerable<string> RestricaoEstabelecimentos)
    Parameters
    Type Name Description
    System.String NomeFicheiro

    Nome do ficheiro a ser gerado

    System.Int16 Ano

    Ano de referência do magnético

    System.Byte Mes

    Mês de referência do magnético

    System.Collections.Generic.List<RhpBEErroAlertaSS> Erros

    Colecção retornada com o detalhe das linhas problemáticas do magnético

    System.Collections.Generic.IEnumerable<System.String> RestricaoInstSegSocial

    Lista de códigos de instituições de segurança social para restrição

    System.Collections.Generic.IEnumerable<System.String> RestricaoEstabelecimentos

    Lista de códigos de estabelecimentos de segurança social para restrição

    Returns
    Type Description
    System.Boolean

    GerarMagneticoPT(String, Int16, Byte, List<RhpBEErroAlertaSS>, out Double, out Double, ref Int32, Boolean)

    Função que trata da geração do magnético para a Segurança Social em Portugal

    Declaration
    bool GerarMagneticoPT(string NomeFicheiro, short Ano, byte Mes, List<RhpBEErroAlertaSS> Erros, out double dblSomaRemuneracoes, out double dblSomaContribuicoes, ref int NumLinhaInicial, bool blnAcrescentarAoFicheiro)
    Parameters
    Type Name Description
    System.String NomeFicheiro

    Nome do ficheiro a ser gerado

    System.Int16 Ano

    Ano de referência do magnético

    System.Byte Mes

    Mês de referência do magnético

    System.Collections.Generic.List<RhpBEErroAlertaSS> Erros

    Colecção retornada com o detalhe das linhas problemáticas do magnético

    System.Double dblSomaRemuneracoes

    Soma das remunerações (usada nos Gabinetes)

    System.Double dblSomaContribuicoes

    Soma das contribuições (usada nos Gabinetes)

    System.Int32 NumLinhaInicial

    Número de linha do ficheiro quando está a ser acrescentado a ficheiro já existente

    System.Boolean blnAcrescentarAoFicheiro

    Indica se é para acrescentar ao ficheiro magnético ou para criar um novo (usada nos Gabinetes)

    Returns
    Type Description
    System.Boolean

    ProcessarAuto(RhpBEDadosSegSocial, out String, IProgress<Int32>, CancellationToken)

    Método que efectua o processamento completo dos dados para a declaração de remunerações para a segurança social.

    Declaration
    bool ProcessarAuto(RhpBEDadosSegSocial objDadosSS, out string msgErro, IProgress<int> CallBack = null, CancellationToken CancelToken = default(CancellationToken))
    Parameters
    Type Name Description
    RhpBEDadosSegSocial objDadosSS

    Classe com as definições para o processamento.

    System.String msgErro
    System.IProgress<System.Int32> CallBack

    Evento para notificações de progresso

    System.Threading.CancellationToken CancelToken

    Objecto para requerer o cancelamento do processamento

    Returns
    Type Description
    System.Boolean

    True se processa com sucesso, False em caso de erro.

    ProcessarFunc(RhpBESegurancaSocial, RhpBEFuncionario, RhpBEDadosSegSocial, String, String)

    Método que efectua o processamento dos dados para a declaração de remunerações para a segurança social do funcionário especificado.

    Declaration
    bool ProcessarFunc(RhpBESegurancaSocial objSegSocial, RhpBEFuncionario ObjFuncionario, RhpBEDadosSegSocial objDadosSS, string SegSocial, string Estabelecimento)
    Parameters
    Type Name Description
    RhpBESegurancaSocial objSegSocial

    Classe que encapsula a instituição de segurança social do funcionário a processar.

    RhpBEFuncionario ObjFuncionario
    RhpBEDadosSegSocial objDadosSS

    Classe com as definições para o processamento.

    System.String SegSocial

    Identificador da instituição de segurança social a processar.

    System.String Estabelecimento

    Identificador do estabelecimento a processar.

    Returns
    Type Description
    System.Boolean

    True se processa com sucesso, False em caso de erro.

    RefazNome(String)

    Formata um nome segundo as regras do magnético da segurança social. sem caracteres especiais nem acentuação.

    Declaration
    string RefazNome(string Nome)
    Parameters
    Type Name Description
    System.String Nome

    Nome a formatar.

    Returns
    Type Description
    System.String

    Nome já formatado.

    SugereValorAutonoma(RhpBECadastroSegSocial)

    Sugere o valor da autónoma para a linha

    Declaration
    void SugereValorAutonoma(RhpBECadastroSegSocial RegistoCadastro)
    Parameters
    Type Name Description
    RhpBECadastroSegSocial RegistoCadastro

    TraduzNumSSocial(String, String)

    Função que recebe um nº da Segurança Social no formato de 9 dígitos e devolve o correspondente no formato de 11 dígitos.

    Declaration
    string TraduzNumSSocial(string NumSSocial, string FirstDigit = "1")
    Parameters
    Type Name Description
    System.String NumSSocial

    Número no formato de 9 dígitos

    System.String FirstDigit
    Returns
    Type Description
    System.String

    ValidaLinhaMagnetico(String, out String, Boolean)

    Valida uma linha do magnético

    Declaration
    bool ValidaLinhaMagnetico(string Linha, out string Erro, bool blnMagSS)
    Parameters
    Type Name Description
    System.String Linha

    Linha a validar

    System.String Erro

    Devolve o erro se existir

    System.Boolean blnMagSS
    Returns
    Type Description
    System.Boolean

    VerificaFormatoNISSEntPatronal(RhpBEDadosSegSocial)

    Função que verifica o formato do número de segurança social da entidade patronal.

    Declaration
    bool VerificaFormatoNISSEntPatronal(RhpBEDadosSegSocial objDadosSS)
    Parameters
    Type Name Description
    RhpBEDadosSegSocial objDadosSS

    Objecto que encpsula os dados de segurança social.

    Returns
    Type Description
    System.Boolean

    VerificarCodigosDeclaracao(Int32, Int32, ref String, ref String)

    Função que valida, na declaração, o correcto preenchimento da informação referente ao código da taxa e do estabelecimento.

    Declaration
    bool VerificarCodigosDeclaracao(int intAno, int intMes, ref string strMsgErroCodEstabelecimento, ref string strMsgErroCodTaxa)
    Parameters
    Type Name Description
    System.Int32 intAno

    Ano de referência a considerar

    System.Int32 intMes

    Mês de referência a considerar

    System.String strMsgErroCodEstabelecimento

    Mensagem de erro retornada referente ao ódigo do estabelecimento

    System.String strMsgErroCodTaxa

    Mensagem de erro retornada referente ao codigo da taxa

    Returns
    Type Description
    System.Boolean