Web service com.senior.g5.rh.fp.calculoProvisao

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

Web service para realização do Cálculo da Provisão.

**Necessita autenticação: **Sim

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

**Versão: **1

**Requisição: **

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”> <soapenv:Body> <ser:Calcular> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipSer>String</tipSer> <gruEmp>Integer</gruEmp> <regAju>Integer</regAju> <abrTcl>String</abrTcl> <numEmp>Integer</numEmp> <abrCad>String</abrCad> <codCal>Integer</codCal> <abrFil>String</abrFil> <tipCal>Integer</tipCal> <abrLoc>String</abrLoc> <perCal>Integer</perCal> <abrCcu>String</abrCcu> <iteLot>Integer</iteLot> <abrSin>String</abrSin> <abrTco>String</abrTco> <abrTsa>String</abrTsa> <abrSit>String</abrSit> <abrEtb>String</abrEtb> <abrVin>String</abrVin> <abrCar>String</abrCar> <abrEst>String</abrEst> </parameters> </ser:Calcular> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

tipSer

Opcional

String

Tipo de provisão que será calculada.



  • Máscara: U


Valores:


“S” - 13º Salário


“F” - Férias


“T” - Todos

gruEmp

Opcional

Integer

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



  • Máscara: 999

regAju

Opcional

Integer

Código da regra especial que será chamada logo após o cálculo das bases da provisão de 13º Salário e/ou Férias.



  • Máscara: 999

abrTcl

Opcional

String

Abrangência: Tipo de Colaborador (+).



  • Máscara: A[100]

numEmp

Opcional

Integer

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



  • Chave

  • Máscara: 9999

abrCad

Opcional

String

Abrangência: Colaborador (+).



  • Máscara: A[200]

codCal

Opcional

Integer

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



  • Máscara: 9999


Este parâmetro será respeitado apenas se os parâmetros TipCal e PerCal não forem informados (ou estiverem com o valor 0).

abrFil

Opcional

String

Abrangência: Filial (+).



  • Máscara: A[200]

tipCal

Opcional

Integer

Tipo do cálculo que será utilizado.



  • Máscara: 99


Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.



Valores:


11 - Cálculo Mensal


12 - Folha Complementar


13 - Complementar de Dissídio


14 - Pagamento de Dissídio


15 - Complementar de Rescisão


21 - Primeira Semana


22 - Semana Intermediária


23 - Última Semana


31 - Adiantamento 13º Salário


32 - 13º Salário Integral


41 - Primeira Quinzena


42 - Segunda Quinzena


91 - Adiantamento Salarial


92 - Participação nos Lucros


93 - Especiais


94 - Reclamatória Trabalhista

abrLoc

Opcional

String

Abrangência: Local (”+”).



  • Máscara: A[200]

perCal

Opcional

Integer

Define o cálculo será realizado referente a data da execução.



  • Máscara: 9


Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.



Valores:


0 - Utiliza o Código de Cálculo



1 - Válido Na Data Agendada: Selecionará o Código de Calculo compatível com o Tipo de Cálculo informado


e cuja data de execução do processo esteja dentro do período deste cálculo.



2 - Imediatamente Anterior: Selecionará o Código de Calculo imediatamente anterior ao Válido na Data


Agendada e compatível com o Tipo de Cálculo informado.



3 - Imediatamente Posterior: Selecionará o Código de Calculo imediatamente posterior ao Válido na Data


Agendada e compatível com o Tipo de Cálculo informado.

abrCcu

Opcional

String

Abrangência: Centro de Custo (”+”).



  • Máscara: A[200]

iteLot

Opcional

Integer

Parâmetro de controle dos sistemas, não informar valor.

abrSin

Opcional

String

Abrangência: Sindicato (+).



  • Máscara: A[200]

abrTco

Opcional

String

Abrangência: Tipo de Contrato (+).



  • Máscara: A[100]

abrTsa

Opcional

String

Abrangência: Tipo de Salário (+).



  • Máscara: A[100]

abrSit

Opcional

String

Abrangência: Situação (+).



  • Máscara: A[200]

abrEtb

Opcional

String

Abrangência: Estabilidade (+).



  • Máscara: A[100]

abrVin

Opcional

String

Abrangência: Vínculo (+).



  • Máscara: A[100]

abrCar

Opcional

String

Abrangência: Cargo (”+”).



  • Máscara: A[200]

abrEst

Opcional

String

Abrangência: Estrutura Salarial (+).



  • Máscara: A[200]

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:CalcularResponse> <result> <erroExecucao>String</erroExecucao> </result> </ser:CalcularResponse> </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

Web service para realização do Cálculo Escalonado da Provisão.

**Necessita autenticação: **Sim

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

**Versão: **1

**Requisição: **

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”> <soapenv:Body> <ser:Escalonar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipSer>String</tipSer> <gruEmp>Integer</gruEmp> <regAju>Integer</regAju> <abrTcl>String</abrTcl> <numEmp>Integer</numEmp> <abrCad>String</abrCad> <codCal>Integer</codCal> <abrFil>String</abrFil> <tipCal>Integer</tipCal> <abrLoc>String</abrLoc> <perCal>Integer</perCal> <abrCcu>String</abrCcu> <iteLot>Integer</iteLot> <abrSin>String</abrSin> <abrTco>String</abrTco> <abrTsa>String</abrTsa> <abrSit>String</abrSit> <abrEtb>String</abrEtb> <abrVin>String</abrVin> <abrCar>String</abrCar> <abrEst>String</abrEst> </parameters> </ser:Escalonar> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

tipSer

Opcional

String

Tipo de provisão que será calculada.



  • Máscara: U


Valores:


“S” - 13º Salário


“F” - Férias


“T” - Todos

gruEmp

Opcional

Integer

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



  • Máscara: 999

regAju

Opcional

Integer

Código da regra especial que será chamada logo após o cálculo das bases da provisão de 13º Salário e/ou Férias.



  • Máscara: 999

abrTcl

Opcional

String

Abrangência: Tipo de Colaborador (+).



  • Máscara: A[100]

numEmp

Opcional

Integer

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



  • Chave

  • Máscara: 9999

abrCad

Opcional

String

Abrangência: Colaborador (+).



  • Máscara: A[200]

codCal

Opcional

Integer

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



  • Máscara: 9999


Este parâmetro será respeitado apenas se os parâmetros TipCal e PerCal não forem informados (ou estiverem com o valor 0).

abrFil

Opcional

String

Abrangência: Filial (+).



  • Máscara: A[200]

tipCal

Opcional

Integer

Tipo do cálculo que será utilizado.



  • Máscara: 99


Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.



Valores:


11 - Cálculo Mensal


12 - Folha Complementar


13 - Complementar de Dissídio


14 - Pagamento de Dissídio


15 - Complementar de Rescisão


21 - Primeira Semana


22 - Semana Intermediária


23 - Última Semana


31 - Adiantamento 13º Salário


32 - 13º Salário Integral


41 - Primeira Quinzena


42 - Segunda Quinzena


91 - Adiantamento Salarial


92 - Participação nos Lucros


93 - Especiais


94 - Reclamatória Trabalhista

abrLoc

Opcional

String

Abrangência: Local (”+”).



  • Máscara: A[200]

perCal

Opcional

Integer

Define o cálculo será realizado referente a data da execução.



  • Máscara: 9


Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CodCal possuir valor.



Valores:


0 - Utiliza o Código de Cálculo



1 - Válido Na Data Agendada: Selecionará o Código de Calculo compatível com o Tipo de Cálculo informado


e cuja data de execução do processo esteja dentro do período deste cálculo.



2 - Imediatamente Anterior: Selecionará o Código de Calculo imediatamente anterior ao Válido na Data


Agendada e compatível com o Tipo de Cálculo informado.



3 - Imediatamente Posterior: Selecionará o Código de Calculo imediatamente posterior ao Válido na Data


Agendada e compatível com o Tipo de Cálculo informado.

abrCcu

Opcional

String

Abrangência: Centro de Custo (”+”).



  • Máscara: A[200]

iteLot

Opcional

Integer

Parâmetro de controle dos sistemas, não informar valor.

abrSin

Opcional

String

Abrangência: Sindicato (+).



  • Máscara: A[200]

abrTco

Opcional

String

Abrangência: Tipo de Contrato (+).



  • Máscara: A[100]

abrTsa

Opcional

String

Abrangência: Tipo de Salário (+).



  • Máscara: A[100]

abrSit

Opcional

String

Abrangência: Situação (+).



  • Máscara: A[200]

abrEtb

Opcional

String

Abrangência: Estabilidade (+).



  • Máscara: A[100]

abrVin

Opcional

String

Abrangência: Vínculo (+).



  • Máscara: A[100]

abrCar

Opcional

String

Abrangência: Cargo (”+”).



  • Máscara: A[200]

abrEst

Opcional

String

Abrangência: Estrutura Salarial (+).



  • Máscara: A[200]

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:EscalonarResponse> <result> <erroExecucao>String</erroExecucao> </result> </ser:EscalonarResponse> </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ê?