Web service com.senior.g5.rh.fp.anuais.rais

Tipo de execução

Para cada tipo de execução, existem parâmetros específicos, alguns dos quais podem ser comuns a todas as portas de web service.

Autenticação

Quando for utilizada alguma forma de autenticação na integração de informações por meio de web services, é necessário informar o tipo correspondente no parâmetro <encryption>, conforme os valores possíveis.

WSDL

Portas

Calcular_4

Web service para geração da Rais.

**Necessita autenticação: **Sim

**Situação de versão: ** Atual

**Versão: **4

**Requisição: **

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”> <soapenv:Body> <ser:Calcular_4> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <anoBas>Integer</anoBas> <gruEmp>Integer</gruEmp> <numEmp>Integer</numEmp> <raiNeg>String</raiNeg> <codLot>Integer</codLot> <codCal>Integer</codCal> <cplSal>String</cplSal> <abrEmp>String</abrEmp> <calFil>String</calFil> <carCgc>String</carCgc> <abrTcl>String</abrTcl> <sobDig>String</sobDig> <abrCad>String</abrCad> <apeFil>String</apeFil> <abrFil>String</abrFil> <remPat>String</remPat> <abrLoc>String</abrLoc> <horTra>Integer</horTra> <abrTco>String</abrTco> <horExt>Integer</horExt> <abrVin>String</abrVin> <horMes>Integer</horMes> <diaMes>Integer</diaMes> <hrsCom>Integer</hrsCom> <hrsFer>Integer</hrsFer> <banHor>Integer</banHor> <banFix>String</banFix> <mesPer>Integer</mesPer> <iniVig>String</iniVig> <fimVig>String</fimVig> <calDis>String</calDis> <salPro>Integer</salPro> <horPro>Integer</horPro> <sisPon>Integer</sisPon> </parameters> </ser:Calcular_4> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

anoBas

Obrigatório

Integer

Ano base para o qual serão gerados os dados para a Rais.



  • Máscara: 9999

gruEmp

Opcional

Integer

Abrangência: Código de grupo de empresas.



  • Máscara: 999

numEmp

Opcional

Integer

Código da empresa que será utilizada no cálculo.



  • Máscara: 9999

raiNeg

Obrigatório

String

Incluir as filiais com Rais Negativa.



  • Máscara: U


Valores


“S” - Sim


“N” - Não

codLot

Opcional

Integer

Abrangência: Código de lote de colaboradores.



  • Máscara: 9999

codCal

Opcional

Integer

Código de cálculo que será usado no cálculo.



  • Máscara: 9999

cplSal

Obrigatório

String

Incluir o complemento de salário do histórico no valor do salário contratual.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrEmp

Opcional

String

Abrangência: Empresa (+).



  • Máscara: A[200]

calFil

Opcional

String

Efetuar o cálculo da filial ou não.



  • Máscara: U


Este parâmetro terá o valor padrão “S”. Ele existe para que a filial não seja calculada em todas as instâncias de um cálculo escalonado.



Valores:


“S” - Sim


“N” - Não

carCgc

Obrigatório

String

Juntar empresas que possuem o mesmo código de CNPJ Base em arquivo único.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrTcl

Opcional

String

Abrangência: Tipo de Colaborador (+).



  • Máscara: A[100]

sobDig

Obrigatório

String

Valores digitados ou alterados nas tabelas da rais (campo OriMov diferente de “C”) devem ser recalculados.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrCad

Opcional

String

Abrangência: Colaborador (+).



  • Máscara: A[200]

apeFil

Obrigatório

String

Gerar ou reprocessar somente informações da tabela R053RAI, sem alterar quaisquer dados da tabela R053COL.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrFil

Opcional

String

Abrangência: Filial (+).



  • Máscara: A[200]

remPat

Obrigatório

String

Como deverá ser encontrada a remuneração dos colaboradores para o PAT.



  • Máscara: U


Valores:


“M” - Fixo + Médias


“E” - Fixo + Evento Remuneração PAT

abrLoc

Opcional

String

Abrangência: Local (”+”).



  • Máscara: A[200]

horTra

Opcional

Integer

As horas trabalhadas devem ser geradas a partir da escala horária do colaborador ou de um totalizador indicado pelo usuário no momento da geração.



  • Máscara: 9


Este parâmetro só pode ser informado quando parâmetro AnoBas possuir o valor 2005.



Valores:


1 - Horas Mês Escala + Horas Extras


2 - Totalizador Horas Mês + Horas Extras


3 - Tot. H.Mês + H.Extras - H.Férias


4 - Regra por processo (423)

abrTco

Opcional

String

Abrangência: Tipo de Contrato (+).



  • Máscara: A[100]

horExt

Opcional

Integer

Código do totalizador de horas extras.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro HorTra for diferente de 1.

abrVin

Opcional

String

Abrangência: Vínculo (+).



  • Máscara: A[100]

horMes

Opcional

Integer

Código do totalizador de horas mês.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1 e 4.

diaMes

Opcional

Integer

Código do totalizador de dias mês.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1 e 4.

hrsCom

Opcional

Integer

Código do totalizador de horas comissões mês.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1 e 4.

hrsFer

Opcional

Integer

Código do totalizador de horas férias.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1, 3 e 4.

banHor

Opcional

Integer

Código do totalizador de banco horas.



  • Máscara: 9999

banFix

Opcional

String

Tratar o banco de horas pago no momento da rescisão para o colaborador:



  • Máscara: U


Este parâmetro só deve ser informado se o parâmetro BanHor for diferente de 0.



Valores:


“S” - Sim


“N” - Não

mesPer

Opcional

Integer

Quantidade de meses do período do banco de horas.



  • Máscara: 99


Este parâmetro só deve ser informado se o parâmetro BanHor for diferente de 0.

iniVig

Opcional

DateTime

Competência de Inicio da vigência do banco de horas.


se o parâmetro BanFix for igual a “S”.


  • Máscara: MM/YYYY


Este parâmetro só pode ser informado se o parâmetro BanHor for diferente de 0.

fimVig

Opcional

DateTime

Competência de Fim da vigência do banco de horas.



  • Máscara: MM/YYYY


Este parâmetro só pode ser informado se o parâmetro BanHor for diferente de 0.

calDis

Obrigatório

String

Como deverão ser considerados os cálculos tipo 14 na busca das remunerações



  • Máscara: U


Valores:


“P” - Competência de Pagamento


“H” - Competência de Homologação


“A” - Competência de Pagamento (Somente tipo 14)

salPro

Obrigatório

Integer

Defina como deve ser tratado o salário contratual dos professores demitidos



  • Máscara: 9


Valores:


“1” - Última remuneração do ano base


“2” - Média das remunerações do ano base

horPro

Obrigatório

Integer

Defina como deve ser tratado as horas semanais professor



  • Máscara: 9


Valores:


“1” - Soma das horas do ano base


“2” - Última competência do ano base

sisPon

Obrigatório

Integer

Defina como deve ser informado o tipo de sistema de controle de ponto



  • Máscara: 9


Valores:


“1” - Não adotou


“‘2” - Sistema manual


“‘3” - Sistema mecânico


“‘4” - Sistema de Registro Eletrônico de Ponto - SREP (Portaria 1510/2009)


“‘5” - Sistema não eletrônico alternativo (art. 1º Portaria 373/2011)


“‘6” - Sistema eletrônico alternativo previsto na Portaria 373/2011

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”> <soapenv:Body> <ser:Calcular_4Response> <result> <erroExecucao>String</erroExecucao> </result> </ser:Calcular_4Response> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

erroExecucao

Opcional

String

Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:


  • Vazio ou nulo, indicando que a execução foi feita com sucesso;

  • A mensagem do erro ocorrido no servidor.

Escalonar_4

Web service para geração da Rais Escalonado.

**Necessita autenticação: **Sim

**Situação de versão: ** Atual

**Versão: **4

**Requisição: **

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”> <soapenv:Body> <ser:Escalonar_4> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <anoBas>Integer</anoBas> <gruEmp>Integer</gruEmp> <numEmp>Integer</numEmp> <raiNeg>String</raiNeg> <codLot>Integer</codLot> <codCal>Integer</codCal> <cplSal>String</cplSal> <abrEmp>String</abrEmp> <calFil>String</calFil> <carCgc>String</carCgc> <abrTcl>String</abrTcl> <sobDig>String</sobDig> <abrCad>String</abrCad> <apeFil>String</apeFil> <abrFil>String</abrFil> <remPat>String</remPat> <abrLoc>String</abrLoc> <horTra>Integer</horTra> <abrTco>String</abrTco> <horExt>Integer</horExt> <abrVin>String</abrVin> <horMes>Integer</horMes> <diaMes>Integer</diaMes> <hrsCom>Integer</hrsCom> <hrsFer>Integer</hrsFer> <banHor>Integer</banHor> <banFix>String</banFix> <mesPer>Integer</mesPer> <iniVig>String</iniVig> <fimVig>String</fimVig> <calDis>String</calDis> <salPro>Integer</salPro> <horPro>Integer</horPro> <sisPon>Integer</sisPon> </parameters> </ser:Escalonar_4> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

anoBas

Obrigatório

Integer

Ano base para o qual serão gerados os dados para a Rais.



  • Máscara: 9999

gruEmp

Opcional

Integer

Abrangência: Código de grupo de empresas.



  • Máscara: 999

numEmp

Opcional

Integer

Código da empresa que será utilizada no cálculo.



  • Máscara: 9999

raiNeg

Obrigatório

String

Incluir as filiais com Rais Negativa.



  • Máscara: U


Valores


“S” - Sim


“N” - Não

codLot

Opcional

Integer

Abrangência: Código de lote de colaboradores.



  • Máscara: 9999

codCal

Opcional

Integer

Código de cálculo que será usado no cálculo.



  • Máscara: 9999

cplSal

Obrigatório

String

Incluir o complemento de salário do histórico no valor do salário contratual.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrEmp

Opcional

String

Abrangência: Empresa (+).



  • Máscara: A[200]

calFil

Opcional

String

Efetuar o cálculo da filial ou não.



  • Máscara: U


Este parâmetro terá o valor padrão “S”. Ele existe para que a filial não seja calculada em todas as instâncias de um cálculo escalonado.



Valores:


“S” - Sim


“N” - Não

carCgc

Obrigatório

String

Juntar empresas que possuem o mesmo código de CNPJ Base em arquivo único.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrTcl

Opcional

String

Abrangência: Tipo de Colaborador (+).



  • Máscara: A[100]

sobDig

Obrigatório

String

Valores digitados ou alterados nas tabelas da rais (campo OriMov diferente de “C”) devem ser recalculados.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrCad

Opcional

String

Abrangência: Colaborador (+).



  • Máscara: A[200]

apeFil

Obrigatório

String

Gerar ou reprocessar somente informações da tabela R053RAI, sem alterar quaisquer dados da tabela R053COL.



  • Máscara: U


Valores:


“S” - Sim


“N” - Não

abrFil

Opcional

String

Abrangência: Filial (+).



  • Máscara: A[200]

remPat

Obrigatório

String

Como deverá ser encontrada a remuneração dos colaboradores para o PAT.



  • Máscara: U


Valores:


“M” - Fixo + Médias


“E” - Fixo + Evento Remuneração PAT

abrLoc

Opcional

String

Abrangência: Local (”+”).



  • Máscara: A[200]

horTra

Opcional

Integer

As horas trabalhadas devem ser geradas a partir da escala horária do colaborador ou de um totalizador indicado pelo usuário no momento da geração.



  • Máscara: 9


Este parâmetro só pode ser informado quando parâmetro AnoBas possuir o valor 2005.



Valores:


1 - Horas Mês Escala + Horas Extras


2 - Totalizador Horas Mês + Horas Extras


3 - Tot. H.Mês + H.Extras - H.Férias


4 - Regra por processo (423)

abrTco

Opcional

String

Abrangência: Tipo de Contrato (+).



  • Máscara: A[100]

horExt

Opcional

Integer

Código do totalizador de horas extras.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro HorTra for diferente de 1.

abrVin

Opcional

String

Abrangência: Vínculo (+).



  • Máscara: A[100]

horMes

Opcional

Integer

Código do totalizador de horas mês.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1 e 4.

diaMes

Opcional

Integer

Código do totalizador de dias mês.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1 e 4.

hrsCom

Opcional

Integer

Código do totalizador de horas comissões mês.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1 e 4.

hrsFer

Opcional

Integer

Código do totalizador de horas férias.



  • Máscara: 9999


  • Este parâmetro só poderá ser informado se o valor do parâmetro AnoBas for diferente de 2005 e o valor do parâmetro HorTra for diferente de 1, 3 e 4.

banHor

Obrigatório

Integer

Código do totalizador de banco horas.



  • Máscara: 9999

banFix

Opcional

String

Tratar o banco de horas pago no momento da rescisão para o colaborador:



  • Máscara: U


Este parâmetro só deve ser informado se o parâmetro BanHor for diferente de 0.



Valores:


“S” - Sim


“N” - Não

mesPer

Opcional

Integer

Quantidade de meses do período do banco de horas.



  • Máscara: 99


Este parâmetro só deve ser informado se o parâmetro BanHor for diferente de 0.

iniVig

Opcional

DateTime

Competência de Inicio da vigência do banco de horas.


se o parâmetro BanFix for igual a “S”.


  • Máscara: MM/YYYY


Este parâmetro só pode ser informado se o parâmetro BanHor for diferente de 0.

fimVig

Opcional

DateTime

Competência de Fim da vigência do banco de horas.



  • Máscara: MM/YYYY


Este parâmetro só pode ser informado se o parâmetro BanHor for diferente de 0.

calDis

Obrigatório

String

Como deverão ser considerados os cálculos tipo 14 na busca das remunerações



  • Máscara: U


Valores:


“P” - Competência de Pagamento


“H” - Competência de Homologação


“A” - Competência de Pagamento (Somente tipo 14)

salPro

Obrigatório

Integer

Defina como deve ser tratado o salário contratual dos professores demitidos



  • Máscara: 9


Valores:


“1” - Última remuneração do ano base


“2” - Média das remunerações do ano base

horPro

Obrigatório

Integer

Defina como deve ser tratado as horas semanais professor



  • Máscara: 9


Valores:


“1” - Soma das horas do ano base


“2” - Última competência do ano base

sisPon

Obrigatório

Integer

Defina como deve ser informado o tipo de sistema de controle de ponto



  • Máscara: 9


Valores:


“1” - Não adotou


“‘2” - Sistema manual


“‘3” - Sistema mecânico


“‘4” - Sistema de Registro Eletrônico de Ponto - SREP (Portaria 1510/2009)


“‘5” - Sistema não eletrônico alternativo (art. 1º Portaria 373/2011)


“‘6” - Sistema eletrônico alternativo previsto na Portaria 373/2011

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”> <soapenv:Body> <ser:Escalonar_4Response> <result> <erroExecucao>String</erroExecucao> </result> </ser:Escalonar_4Response> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

erroExecucao

Opcional

String

Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:


  • Vazio ou nulo, indicando que a execução foi feita com sucesso;

  • A mensagem do erro ocorrido no servidor.

Este artigo ajudou você?