Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Benefícios e Tarefeiros > Com.senior.g5.rh.bs.vales

Web service com.senior.g5.rh.bs.vales

Tipo de execução

Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.

Autenticação

Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.

WSDL

Síncrono: http://example.com/g5-senior-services/bs_Synccom_senior_g5_rh_bs_vales?wsdl
Assíncrono: http://example.com/g5-senior-services/bs_Asynccom_senior_g5_rh_bs_vales?wsdl
Agendado: http://example.com/g5-senior-services/bs_Scheduledcom_senior_g5_rh_bs_vales?wsdl

Assinalamentos

Web Service de Assinalamento de Vales Permanente.

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:Assinalamentos>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <tipOpe>String</tipOpe>
        <qtdUti>Double</qtdUti>
        <perVal>Double</perVal>
        <numEmp>Integer</numEmp>
        <qtdSab>Double</qtdSab>
        <qtdVal>Integer</qtdVal>
        <tipCol>Integer</tipCol>
        <qtdDom>Double</qtdDom>
        <vlrVal>Double</vlrVal>
        <numCad>Integer</numCad>
        <qtdFer>Double</qtdFer>
        <perSub>Double</perSub>
        <codVal>Integer</codVal>
      </parameters>
    </ser:Assinalamentos>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome	Preenchimento	Tipo	Descrição
tipOpe	Obrigatório	String	Tipo da operação a ser efetuada na integração. - Máscara: U Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "Alteração".
qtdUti	Opcional	Double	Quantidade de vales para dia útil. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
perVal	Opcional	Double	Percentual sobre o salário. - Máscara: ZZ9,99 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for diferente de "G" - Gerado e "F" - Valor Fixo.
numEmp	Obrigatório	Integer	Código da empresa que será utilizada na integração. - Chave - Máscara: 9999
qtdSab	Opcional	Double	Quantidade de vales para sábado. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
qtdVal	Opcional	Integer	Quantidade de vales que o colaborador receberá em dia útil, sábado, domingo e feriado. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for igual a "G" - Gerado ou "F" - Valor Fixo.
tipCol	Obrigatório	Integer	Tipo de colaborador. - Chave - Máscara: 9 Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
qtdDom	Opcional	Double	Quantidade de vales para domingo. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
vlrVal	Opcional	Double	Valor unitário do vale. - Máscara: ZZZZZZZZ9,99 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for igual a "G" - Gerado ou "F" - Valor Fixo.
numCad	Obrigatório	Integer	Código do Colaborador. - Chave - Máscara: 999999999
qtdFer	Opcional	Double	Quantidade de vales para feriado. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
perSub	Opcional	Double	Percentual subsidiado pela empresa. - Máscara: ZZ9,9999
codVal	Obrigatório	Integer	Código do tipo de vale que será assinalado. - Chave - Máscara: 9999

Resposta:

Nota

Envelope SOAP de resposta de requisições síncronas.

Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, 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:AssinalamentosResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:AssinalamentosResponse>
  </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.

Solicitacao_2

Web Service de Solicitação Avulsa de Vales.

Necessita autenticação: Sim

Situação de versão: Atual

Versão: 2

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:Solicitacao_2>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <tipOpe>String</tipOpe>
        <qtdUti>Double</qtdUti>
        <perVal>Double</perVal>
        <numEmp>Integer</numEmp>
        <qtdSab>Double</qtdSab>
        <qtdVal>Integer</qtdVal>
        <tipCol>Integer</tipCol>
        <qtdDom>Double</qtdDom>
        <vlrVal>Double</vlrVal>
        <numCad>Integer</numCad>
        <qtdFer>Double</qtdFer>
        <perSub>Double</perSub>
        <codVal>Integer</codVal>
        <datSoc>String</datSoc>
        <datVal>String</datVal>
      </parameters>
    </ser:Solicitacao_2>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome	Preenchimento	Tipo	Descrição
tipOpe	Obrigatório	String	Tipo da operação a ser efetuada na integração. - Máscara: U Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "Alteração".
qtdUti	Opcional	Double	Quantidade de vales para dia útil. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
perVal	Opcional	Double	Percentual sobre o salário. - Máscara: ZZ9,99 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for diferente de "G" - Gerado e "F" - Valor Fixo.
numEmp	Obrigatório	Integer	Código da empresa que será utilizada na integração. - Chave - Máscara: 9999
qtdSab	Opcional	Double	Quantidade de vales para sábado. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
qtdVal	Opcional	Integer	Quantidade de vales que o colaborador receberá em dia útil, sábado, domingo e feriado. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for igual a "G" - Gerado ou "F" - Valor Fixo.
tipCol	Obrigatório	Integer	Tipo de colaborador. - Chave - Máscara: 9 Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
qtdDom	Opcional	Double	Quantidade de vales para domingo. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
vlrVal	Opcional	Double	Valor unitário do vale. - Máscara: ZZZZZZZZ9,99 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for igual a "G" - Gerado ou "F" - Valor Fixo.
numCad	Obrigatório	Integer	Código do Colaborador. - Chave - Máscara: 999999999
qtdFer	Opcional	Double	Quantidade de vales para feriado. - Máscara: 999 Este campo só pode ser informado quando o tipo base do vale informado no parâmetro CodVal for "G" - Gerado.
perSub	Opcional	Double	Percentual subsidiado pela empresa. - Máscara: ZZ9,99
codVal	Obrigatório	Integer	Código do tipo de vale que será solicitado. - Chave - Máscara: 9999
datSoc	Obrigatório	DateTime	Data da solicitação do vale. - Chave - Máscara: DD/MM/YYYY
datVal	Opcional	DateTime	Data de vencimento da solicitação. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar a própria data de solicitação (parâmetro DatSoc).

Resposta:

Nota

Envelope SOAP de resposta de requisições síncronas.

Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, 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:Solicitacao_2Response>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:Solicitacao_2Response>
  </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.

Gerar

Web Service de Geração de Vales.

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:Gerar>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <gruEmp>Integer</gruEmp>
        <codCal>Integer</codCal>
        <codLot>String</codLot>
        <digVal>String</digVal>
        <abrTcl>Integer</abrTcl>
        <abrCad>String</abrCad>
        <abrFil>String</abrFil>
        <abrLoc>String</abrLoc>
        <abrCCu>String</abrCCu>
        <abrSin>String</abrSin>
        <abrTCo>String</abrTCo>
        <abrTsa>String</abrTsa>
        <abrSit>String</abrSit>
        <abrEtb>String</abrEtb>
        <abrVin>String</abrVin>
        <abrCar>String</abrCar>
        <abrVal>String</abrVal>
        <abrEst>String</abrEst>
      </parameters>
    </ser:Gerar>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome	Preenchimento	Tipo	Descrição
numEmp	Obrigatório	Integer	Código da empresa que será utilizada no processo. - Máscara: 9999
gruEmp	Opcional	Integer	Abrangência: Código de grupo de empresas. - Máscara: 999
codCal	Obrigatório	Integer	Código de cálculo que será usado no processo. - 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).
codLot	Opcional	String	Abrangência: Código de lote de colaboradores. - Máscara: 9999 Ao informar um lote, não será possível utilizar o campo Tipo de Colaborador nem o cadastro do colaborador.
digVal	Opcional	String	Informar o campo Recalcular Vales Digitados - Valores: S - Sim / N - Não
abrTcl	Opcional	Integer	Abrangência de tipos de colaborador - Valores: 1 - Empregado / 2 - Terceiro / 3 - Parceiro
abrCad	Opcional	String	Abrangência: Colaborador (+). - Máscara: A[200]
abrFil	Opcional	String	Abrangência: Filial (+). - Máscara: A[200]
abrLoc	Opcional	String	Abrangência: Local ("+"). - Máscara: A[200]
abrCCu	Opcional	String	Abrangência: Centro de Custo ("+"). - Máscara: A[200]
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]
abrVal	Opcional	String	Abrangência: VAles ("+"). - Máscara: A[200]
abrEst	Opcional	String	Abrangência: Estrutura Salarial (+). - Máscara: A[200]

Resposta:

Nota

Envelope SOAP de resposta de requisições síncronas.

Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, 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:GerarResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GerarResponse>
  </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 de processamentos escalonados da Geração de Vales.

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>
        <numEmp>Integer</numEmp>
        <gruEmp>Integer</gruEmp>
        <codCal>Integer</codCal>
        <codLot>String</codLot>
        <digVal>String</digVal>
        <abrTcl>Integer</abrTcl>
        <abrCad>String</abrCad>
        <abrFil>String</abrFil>
        <abrLoc>String</abrLoc>
        <abrCCu>String</abrCCu>
        <abrSin>String</abrSin>
        <abrTCo>String</abrTCo>
        <abrTsa>String</abrTsa>
        <abrSit>String</abrSit>
        <abrEtb>String</abrEtb>
        <abrVin>String</abrVin>
        <abrCar>String</abrCar>
        <abrVal>String</abrVal>
        <abrEst>String</abrEst>
      </parameters>
    </ser:Escalonar>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome	Tipo	Preenchimento	Ajuda
numEmp	Integer	Obrigatório	Código da empresa que será utilizada no processo. - Máscara: 9999
gruEmp	Integer	Opcional	Abrangência: Código de grupo de empresas. - Máscara: 999
codCal	Integer	Obrigatório	Código de cálculo que será usado no processo. - 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).
codLot	String	Opcional	Abrangência: Código de lote de colaboradores. - Máscara: 9999
digVal	String	Opcional	Informar o campo Recalcular Vales Digitados - Valores: S - Sim / N - Não
abrTcl	Integer	Opcional	Abrangência de tipos de colaborador - Valores: 1 - Empregado / 2 - Terceiro / 3 - Parceiro
abrCad	String	Opcional	Abrangência: Colaborador (+). - Máscara: A[200]
abrFil	String	Opcional	Abrangência: Filial (+). - Máscara: A[200]
abrLoc	String	Opcional	Abrangência: Local ("+"). - Máscara: A[200]
abrCCu	String	Opcional	Abrangência: Centro de Custo ("+"). - Máscara: A[200]
abrSin	String	Opcional	Abrangência: Sindicato (+). - Máscara: A[200]
abrTCo	String	Opcional	Abrangência: Tipo de Contrato (+). - Máscara: A[100]
abrTsa	String	Opcional	Abrangência: Tipo de Salário (+). - Máscara: A[100]
abrSit	String	Opcional	Abrangência: Situação (+). - Máscara: A[200]
abrEtb	String	Opcional	Abrangência: Estabilidade (+). - Máscara: A[100]
abrVin	String	Opcional	Abrangência: Vínculo (+). - Máscara: A[100]
abrCar	String	Opcional	Abrangência: Cargo ("+"). - Máscara: A[200]
abrVal	String	Opcional	Abrangência: Vales ("+"). - Máscara: A[200]
abrEst	String	Opcional	Abrangência: Estrutura Salarial (+). - Máscara: A[200]

Resposta:

Nota

Envelope SOAP de resposta de requisições síncronas.

Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, 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>

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas \| HCM - versão 6.10.3