Interface IRhpBSSegurancaSocial

Classe utilizada para obter as regras de negócio de registos de Segurança Social.

Namespace: IRhpBS100

Assembly: IRhpBS100.dll

Syntax

[ComVisible(true)]
[Guid("F95F8EAC-AB2E-4C9D-9406-47E95E19C9B7")]
public interface IRhpBSSegurancaSocial

Methods

Actualiza(RhpBESegurancaSocial)

Actualiza a informação de uma segurança social.

Declaration

void Actualiza(RhpBESegurancaSocial objBESegurancaSocial)

Parameters

Type	Name	Description
RhpBESegurancaSocial	objBESegurancaSocial	Objecto contendo os valores actuais.

Actualiza(RhpBESegurancaSocial, ref String)

Actualiza a informação de uma segurança social.

Declaration

void Actualiza(RhpBESegurancaSocial objBESegurancaSocial, ref string strAviso)

Parameters

Type	Name	Description
RhpBESegurancaSocial	objBESegurancaSocial	Objecto contendo os valores actuais.
System.String	strAviso

ActualizaValorAtributo(String, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string SegurancaSocial, string Atributo, object Valor)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Novo valor do atributo indicado.

ActualizaValorAtributos(String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string SegurancaSocial, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
StdBECampos	Atributos	Objecto contendo os atributos a actualizar e respectivos valores.

CancelaPedido(String)

Cancela um pedido de consulta em curso à Plataforma Base da Segurança Social

Declaration

void CancelaPedido(string Chave)

Parameters

Type	Name	Description
System.String	Chave

ConsultarFicheiro(String, Int16, Byte, Byte, out Int32, out String)

Devolve o estado do ficheiro.

Declaration

RhpBECadastroSegSocialFicheiro ConsultarFicheiro(string PwdServico, short Ano, byte Mes, byte Sequencia, out int CodigoResultado, out string MensagemErro)

Parameters

Type	Name	Description
System.String	PwdServico	Password de acesso ao serviço
System.Int16	Ano	Ano a consultar
System.Byte	Mes	Mês a consultar
System.Byte	Sequencia	Sequência a consultar
System.Int32	CodigoResultado	Devolve informação de sucesso da operação: 0-OK, 2-Erro de comunicação, 3-erro de autenticação
System.String	MensagemErro	Devolve mensagem de erro quando ocorre erro na comunicação com o serviço

Returns

Type	Description
RhpBECadastroSegSocialFicheiro	Informação do estado do ficheiro

ConsultaVinculoTrabalhador(String, String, DateTime, DateTime, ref Int32, ref String, IStdBECallback)

Efetua uma consulta ao serviço de consulta da Plataforma Base da Segurança Social

Declaration

string ConsultaVinculoTrabalhador(string PwdServico, string NissFuncionario, DateTime DataDeInicio, DateTime DataDeFim, ref int Resultado, ref string mensagem, IStdBECallback CallBack)

Parameters

Type	Name	Description
System.String	PwdServico	Password do serviço da Plataforma Base da Segurança Social
System.String	NissFuncionario	NISS do funcionário
System.DateTime	DataDeInicio	Data de início do vínculo
System.DateTime	DataDeFim	Data de fim do vínculo
System.Int32	Resultado	Código do resultado do serviço
System.String	mensagem
StdBE100.IStdBECallback	CallBack	Objecto de retorno da notificação da chamada ao serviço

Returns

Type	Description
System.String

ConsultaVinculoTrabalhadores(String, DateTime, DateTime, ref Int32, ref String, IStdBECallback)

Executa a consulta de vinculo de trabalhadores

Declaration

string ConsultaVinculoTrabalhadores(string pwdServico, DateTime DataDeInicio, DateTime DataDeFim, ref int CodigoResultado, ref string mensagem, IStdBECallback CallBack)

Parameters

Type	Name	Description
System.String	pwdServico	Password de acesso ao serviço
System.DateTime	DataDeInicio
System.DateTime	DataDeFim
System.Int32	CodigoResultado
System.String	mensagem
StdBE100.IStdBECallback	CallBack

Returns

Type	Description
System.String

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaDescontos(String, out Double, out Double)

Devolve por referência, os Descontos de uma Segurança Social.

Declaration

bool DaDescontos(string SegurancaSocial, out double DescontoEmpresa, out double DescontoEmpregado)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da instituição de segurança social.
System.Double	DescontoEmpresa	Variável que será preenchida com o valor de desconto da entidade patronal.
System.Double	DescontoEmpregado	Variável que será preenchida com o valor de desconto do empregado.

Returns

Type	Description
System.Boolean

DaDescontosHistorico(String, DateTime, out Double, out Double)

Devolve por referência, os Descontos de uma Segurança Social em vigor numa determinada Data.

Declaration

bool DaDescontosHistorico(string SegurancaSocial, DateTime Data, out double DescontoEmpresa, out double DescontoEmpregado)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da instituição de segurança social.
System.DateTime	Data	a procurar o desconto. Pode ser uma data anterior, actual ou superior
System.Double	DescontoEmpresa	Variável que será preenchida com o valor de desconto da entidade patronal.
System.Double	DescontoEmpregado	Variável que será preenchida com o valor de desconto do empregado.

Returns

Type	Description
System.Boolean

DaEstadoSubmissao(Int16, Byte)

Devolve o estado actual da submissão da declaração de remunerações para o ano e mês especificados.

Declaration

RhpBECadastroSegSocialFicheiro DaEstadoSubmissao(short Ano, byte Mes)

Parameters

Type	Name	Description
System.Int16	Ano	Ano da declaração
System.Byte	Mes	Mês da declaração

Returns

Type	Description
RhpBECadastroSegSocialFicheiro	retorna null quando ainda não foi submetida a declaração no período.

DaUltimaDataAplicacao(String)

Devolve a data que vigora (última) uma Segurança Social .

Declaration

DateTime DaUltimaDataAplicacao(string SegurancaSocial)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da instituição de segurança social.

Returns

Type	Description
System.DateTime

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

object DaValorAtributo(string SegurancaSocial, string Atributo)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLock(String, String)

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

Declaration

object DaValorAtributoLock(string SegurancaSocial, string Atributo)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributos(String, String[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string SegurancaSocial, params string[] Atributos)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(String, String[])

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

Declaration

StdBECampos DaValorAtributosLock(string SegurancaSocial, params string[] Atributos)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
System.String[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

Edita(String)

Edita a informação de uma segurança social.

Declaration

RhpBESegurancaSocial Edita(string SegurancaSocial)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.

Returns

Type	Description
RhpBESegurancaSocial

ExecutaDiagnosticoCadastroSegSocial(IEnumerable<RhpBECadastroSegSocial>, List<RhpBEFuncionario>, Boolean, Boolean, Boolean, Boolean, Boolean)

ExecutaDiagnosticoCadastroSegSocial Executa um diagnóstico ao processamento da segurança social contra os resultados da resposta do Serviço

Declaration

RhpBEErrosSegSocial ExecutaDiagnosticoCadastroSegSocial(IEnumerable<RhpBECadastroSegSocial> LinhasCadastro, List<RhpBEFuncionario> ListaFuncionarios, bool ValDataNascimento = true, bool ValFaltaRegistoSS = true, bool ValFaltaProcessamento = true, bool ValTotalTaxa = true, bool ValEstabelecimento = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RhpBECadastroSegSocial>	LinhasCadastro
System.Collections.Generic.List<RhpBEFuncionario>	ListaFuncionarios
System.Boolean	ValDataNascimento
System.Boolean	ValFaltaRegistoSS
System.Boolean	ValFaltaProcessamento
System.Boolean	ValTotalTaxa
System.Boolean	ValEstabelecimento

Returns

Type	Description
RhpBEErrosSegSocial

Existe(String)

Verifica se existe o registo referente à informação passada nos parâmetros.

Declaration

bool Existe(string SegurancaSocial)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.

Returns

Type	Description
System.Boolean

GuardaHistoricoRegistoVinculoPltBaseSS(String, String, String, String, DateTime, DateTime, Int32, String)

GuardaHistoricoRegistoVinculoPltBaseSS Guarda o registo de histórico do registo de vínculo na Segurança Social

Declaration

bool GuardaHistoricoRegistoVinculoPltBaseSS(string Funcionario, string NissFuncionario, string ModalidadeContrato, string Estabelecimento, DateTime DataInicio, DateTime DataFim, int Resultado, string DescResultado)

Parameters

Type	Name	Description
System.String	Funcionario	Funcionário a efectuar o registo
System.String	NissFuncionario	NISS do funcionário
System.String	ModalidadeContrato	Modalidade do Contrato a utilizar
System.String	Estabelecimento	Estabelecimento a que o funcionário está afeto
System.DateTime	DataInicio
System.DateTime	DataFim
System.Int32	Resultado	Código do resultado do serviço
System.String	DescResultado

Returns

Type	Description
System.Boolean

ListaHistoricoSubmissoes(Int16, Byte)

Lista o histórico de submissão e substituição de declarações para a segurança social

Declaration

List<RhpBECadastroSegSocialFicheiro> ListaHistoricoSubmissoes(short Ano, byte Mes)

Parameters

Type	Name	Description
System.Int16	Ano	Ano a consultar
System.Byte	Mes	Mês a consultar

Returns

Type	Description
System.Collections.Generic.List<RhpBECadastroSegSocialFicheiro>

LstSegurancaSocial()

Devolve uma listagem de registos de segurança social.

Declaration

StdBELista LstSegurancaSocial()

Returns

Type	Description
StdBELista

RegistarVinculoRegimeGeral(String, String, String, DateTime, DateTime, String, String, ref Int32, ref String)

Regista um funcionário na Segurança Social

Declaration

bool RegistarVinculoRegimeGeral(string PwdServico, string Funcionario, string NissFuncionario, DateTime DataDeInicio, DateTime DataDeFim, string Estabelecimento, string ModalidadeContrato, ref int Resultado, ref string mensagem)

Parameters

Type	Name	Description
System.String	PwdServico	Password do serviço da Plataforma Base da Segurança Social
System.String	Funcionario	Funcionário a efectuar o registo
System.String	NissFuncionario	NISS do funcionário
System.DateTime	DataDeInicio	Data de início do vínculo
System.DateTime	DataDeFim	Data de fim do vínculo
System.String	Estabelecimento	Estabelecimento a que o funcionário está afeto
System.String	ModalidadeContrato	Modalidade do Contrato a utilizar
System.Int32	Resultado	Código do resultado do serviço
System.String	mensagem

Returns

Type	Description
System.Boolean

Remove(String)

Remove a informação de uma segurança social.

Declaration

void Remove(string SegurancaSocial)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.

SubmeterFicheiro(String, Int16, Byte, String, out Int32, out String)

Envia o ficheiro e retorna o Id atribuido

Declaration

RhpBECadastroSegSocialFicheiro SubmeterFicheiro(string PwdServico, short Ano, byte Mes, string Ficheiro, out int CodigoResultado, out string MensagemErro)

Parameters

Type	Name	Description
System.String	PwdServico	Password de acesso ao serviço da plataforma base
System.Int16	Ano	Ano da declaração
System.Byte	Mes	Mês da declaração
System.String	Ficheiro	Ficheiro a submeter
System.Int32	CodigoResultado	Devolve informação de sucesso da operação: 0-OK, 2-Erro de comunicação, 3-erro de autenticação
System.String	MensagemErro	Devolve mensagem de erro quando ocorre erro na comunicação com o serviço

Returns

Type	Description
RhpBECadastroSegSocialFicheiro	Registo da entrega quando efetuado com sucesso. Quando com erros é preenchida a coleção de erros

SubstituirFicheiro(String, Int16, Byte, String, out Int32, out String)

Substitui um ficheiro na Segurança Social

Declaration

RhpBECadastroSegSocialFicheiro SubstituirFicheiro(string PwdServico, short Ano, byte Mes, string Ficheiro, out int CodigoResultado, out string MensagemErro)

Parameters

Type	Name	Description
System.String	PwdServico	Password de acesso ao serviço
System.Int16	Ano	Ano a consultar
System.Byte	Mes	Mês a consultar
System.String	Ficheiro	Ficheiro a submeter
System.Int32	CodigoResultado	Devolve informação de sucesso da operação: 0-OK, 2-Erro de comunicação, 3-erro de autenticação
System.String	MensagemErro	Devolve mensagem de erro quando ocorre erro na comunicação com o serviço

Returns

Type	Description
RhpBECadastroSegSocialFicheiro	Informação do novo ficheiro.

ValidaActualizacao(RhpBESegurancaSocial, ref String, ref String)

Efectua a validação dos dados de registos de segurança social.

Declaration

bool ValidaActualizacao(RhpBESegurancaSocial ObjSegurancaSocial, ref string ErroValidacao, ref string AvisoValidacao)

Parameters

Type	Name	Description
RhpBESegurancaSocial	ObjSegurancaSocial	Objecto contendo os novos valores a actualizar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.
System.String	AvisoValidacao

Returns

Type	Description
System.Boolean

ValidaActualizacaoHistoricoDescontos(String, RhpBESegSocialDescontos, ref String, ref String)

Efectua a validação de um conjunto de informação de descontos de uma instituição.

Declaration

bool ValidaActualizacaoHistoricoDescontos(string strSegSocial, RhpBESegSocialDescontos objSegSocialDescontos, ref string strErro, ref string strAviso)

Parameters

Type	Name	Description
System.String	strSegSocial	Identificador da instituição de segurança social.
RhpBESegSocialDescontos	objSegSocialDescontos	Objecto contendo a colecção da informação que se pretende validar.
System.String	strErro	Recebe a descrição de eventuais erros detectados.
System.String	strAviso	Recebe a descrição de eventuais avisos.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, ref String)

Efectua a validação de um registo antes de ser efectuada a sua remoção.

Declaration

bool ValidaRemocao(string SegurancaSocial, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	SegurancaSocial	Identificador da segurança social.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean