Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Administração de Pessoal > Com.senior.g5.rh.fp.valeTransporte

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

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/rubi_Synccom_senior_g5_rh_fp_valeTransporte?wsdl
Assíncrono: http://example.com/g5-senior-services/rubi_Asynccom_senior_g5_rh_fp_valeTransporte?wsdl
Agendado: http://example.com/g5-senior-services/rubi_Scheduledcom_senior_g5_rh_fp_valeTransporte?wsdl

DigitarReferencia

Web service responsável pela manutenção da aba Referência da tela de Vale Transporte - Digitar Passes

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:DigitarReferencia>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <wGDDIGPVT>
          <tipOpe>String</tipOpe>
          <data>String</data>
          <linha>Integer</linha>
          <valor>Double</valor>
          <qtde>Integer</qtde>
          <mltiplos>Integer</mltiplos>
          <status>String</status>
        </wGDDIGPVT>
        <perIni>String</perIni>
        <perFim>String</perFim>
        <iniFal>String</iniFal>
        <fimFal>String</fimFal>
        <solIni>String</solIni>
        <solFim>String</solFim>
        <tipCol>Integer</tipCol>
        <numCad>Integer</numCad>
        <recalc>String</recalc>
      </parameters>
    </ser:DigitarReferencia>
  </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 na integração. - Chave - Máscara: 9999
wGDDIGPVT	Opcional	Set	Passes.
wGDDIGPVT.tipOpe	Opcional	String	Tipo da operação a ser efetuada para um lançamento (uma linha). - Máscara: U - Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão - Obs.: Se não for informado, será considerado "Alteração".
wGDDIGPVT.data	Opcional	DateTime	Dia do período que haverá distribuição de passes. - Chave - Máscara: DD/MM/YYYY
wGDDIGPVT.linha	Opcional	Integer	Código da linha que será utilizada. - Chave - Máscara: 9[5]
wGDDIGPVT.valor	Opcional	Double	Valor do passe. - Máscara: ZZZZZ9,99 - Obs.: Se não for informado, o sistema tentará encontrar o valor do passe, de acordo com a linha.
wGDDIGPVT.qtde	Opcional	Integer	Quantidade de passes no dia. - Máscara: 9999
wGDDIGPVT.mltiplos	Opcional	Integer	Quantidade de múltiplos - Chave - Máscara: 99
wGDDIGPVT.status	Opcional	String	Status: - Indicação da situação do passe: - E (Entregue): são os vales pagos ao colaborador; - D (Faltas Descontada): são os afastamentos e faltas já descontadas na geração do vale transporte; - Máscara: U Obs: Caso não informado na Inclusão, será considerado como 'E - Entregue'.
perIni	Obrigatório	DateTime	Data de início do período que será alterado. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
perFim	Obrigatório	DateTime	Data de fim do período que será alterado. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
iniFal	Opcional	DateTime	Data de início para consideração dos afastamentos que perdem para vale transporte. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
fimFal	Opcional	DateTime	Data de fim para consideração dos afastamentos que perdem para vale transporte. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
solIni	Opcional	DateTime	Data de início para consideração das solicitações de vale transporte do CP. - Máscara: DD/MM/YYYY Este parâmetro só poderá ser informado se alguma das seguintes condições for verdadeira: - Sistema integrado com Controle de Ponto e Refeitório . - Campo "Tratar Solicitações Ronda", nas definições de vale transporte estiver igual a "S" - Sim. Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o período de referência.
solFim	Opcional	DateTime	Data de fim para consideração das solicitações de vale transporte do CP. - Máscara: DD/MM/YYYY Este parâmetro só poderá ser informado se alguma das seguintes condições for verdadeira: - Sistema integrado com Controle de Ponto e Refeitório . - Campo "Tratar Solicitações Ronda", nas definições de vale transporte estiver igual a "S" - Sim. Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o período de referência.
tipCol	Obrigatório	Integer	Tipo de colaborador. - Chave - Máscara: 9 Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
numCad	Obrigatório	Integer	Código do Colaborador. - Chave - Máscara: 999999999
recalc	Obrigatório	String	Permite recalcular ou não a distribuição de vales. - Máscara: U Valores: "S" - Sim: Serão recalculados todos os valores gravados. "N" - Não Digitados: Serão recalculados apenas os valores calculados pela própria rotina de vale transporte. "D" - Desconsiderar Recálculo: Demonstra o que já foi calculado.

Resposta:

Observação

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

DigitarFaltas

Web service responsável pela manutenção da aba Faltas da tela de Vale Transporte - Digitar Passes

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:DigitarFaltas>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <wGDFALPVT>
          <tipOpe>String</tipOpe>
          <data>String</data>
          <linha>Integer</linha>
          <valor>Double</valor>
          <qtde>Integer</qtde>
          <mltiplos>Integer</mltiplos>
        </wGDFALPVT>
        <perIni>String</perIni>
        <perFim>String</perFim>
        <iniFal>String</iniFal>
        <fimFal>String</fimFal>
        <solIni>String</solIni>
        <solFim>String</solFim>
        <tipCol>Integer</tipCol>
        <numCad>Integer</numCad>
        <recalc>String</recalc>
      </parameters>
    </ser:DigitarFaltas>
  </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 na integração. - Chave - Máscara: 9999
wGDFALPVT	Opcional	Set	Passes.
wGDFALPVT.tipOpe	Opcional	String	Tipo da operação a ser efetuada para um lançamento (uma linha). - Máscara: U - Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão - Obs.: Se não for informado, será considerado "Alteração".
wGDFALPVT.data	Opcional	DateTime	Dia do período que haverá distribuição de passes. - Chave - Máscara: DD/MM/YYYY
wGDFALPVT.linha	Opcional	Integer	Código da linha que será utilizada. - Chave - Máscara: 9[5]
wGDFALPVT.valor	Opcional	Double	Valor do passe. - Máscara: ZZZZZ9,99 - Obs.: Se não for informado, o sistema tentará encontrar o valor do passe, de acordo com a linha.
wGDFALPVT.qtde	Opcional	Integer	Quantidade de passes no dia. - Máscara: 9999
wGDFALPVT.mltiplos	Opcional	Integer	Quantidade de múltiplos - Chave - Máscara: 99
perIni	Opcional	DateTime	Data de início do período que será alterado. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
perFim	Opcional	DateTime	Data de fim do período que será alterado. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
iniFal	Opcional	DateTime	Data de início para consideração dos afastamentos que perdem para vale transporte. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
fimFal	Opcional	DateTime	Data de fim para consideração dos afastamentos que perdem para vale transporte. - Máscara: DD/MM/YYYY Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o cálculo ativo.
solIni	Opcional	DateTime	Data de início para consideração das solicitações de vale transporte do CP. - Máscara: DD/MM/YYYY Este parâmetro só poderá ser informado se alguma das seguintes condições for verdadeira: - Sistema integrado com Controle de Ponto e Refeitório. - Campo "Tratar Solicitações Ronda", nas definições de vale transporte estiver igual a "S" - Sim. Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o período de referência.
solFim	Opcional	DateTime	Data de fim para consideração das solicitações de vale transporte do CP. - Máscara: DD/MM/YYYY Este parâmetro só poderá ser informado se alguma das seguintes condições for verdadeira: - Sistema integrado com Controle de Ponto e Refeitório. - Campo "Tratar Solicitações Ronda", nas definições de vale transporte estiver igual a "S" - Sim. Se este parâmetro não for informado, o sistema irá utilizar um período de acordo com o período de referência.
tipCol	Obrigatório	Integer	Tipo de colaborador. - Chave - Máscara: 9 Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
numCad	Obrigatório	Integer	Código do Colaborador. - Chave - Máscara: 999999999
recalc	Obrigatório	String	Permite recalcular ou não a distribuição de vales. - Máscara: U Valores: "S" - Sim: Serão recalculados todos os valores gravados. "N" - Não Digitados: Serão recalculados apenas os valores calculados pela própria rotina de vale transporte. "D" - Desconsiderar Recálculo: Demonstra o que já foi calculado.

Resposta:

Observação

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:DigitarFaltasResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:DigitarFaltasResponse>
  </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 responsável pela manutenção da aba Faltas da tela de Vale Transporte - Digitar Passes

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>
				<abrTcl>Integer</abrTcl>
				<codCal>Integer</codCal>
				<abrCad>String</abrCad>
				<iniPer>DateTime</iniPer>
				<abrTrb>String</abrTrb>
				<fimPer>DateTime</fimPer>
				<abrFil>String</abrFil>
				<iniAfa>DateTime</iniAfa>
				<abrLoc>String</abrLoc>
				<fimAfa>DateTime</fimAfa>
				<abrTCo>String</abrTCo>
				<iniRon>DateTime</iniRon>
				<abrSit>String</abrSit>
				<fimRon>DateTime</fimRon>
				<abrVtr>String</abrVtr>
				<digVal>String</digVal>
				<abrTsa>String</abrTsa>
			</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
abrTcl	Opcional	Integer	Abrangência de tipos de colaborador - Opcional Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
codCal	Obrigatório	Integer	Código de cálculo que será usado no processo - Máscara: 9999
abrCad	Opcional	String	Abrangência: Colaborador (+) - Máscara: A[200]
iniPer	Opcional	DateTime	Início do Período - Máscara: DD/MM/YYYY
abrTrb	Opcional	String	Abrangência: Local (+) - Máscara: A[200]
fimPer	Opcional	DateTime	Fim do Período - Máscara: DD/MM/YYYY
abrFil	Opcional	String	Abrangência: Filial (+) - Máscara: A[200]
iniAfa	Opcional	DateTime	Início do Afastamento - Máscara: DD/MM/YYYY
abrLoc	Opcional	String	Abrangência: Local ("+") - Máscara: A[200]
fimAfa	Opcional	DateTime	Fim do Afastamento - Máscara: DD/MM/YYYY
abrTCo	Opcional	String	Abrangência: Tipo de Contrato (+) - Máscara: A[100]
iniRon	Opcional	DateTime	Início perído Solicitações Ronda - Máscara: DD/MM/YYYY
abrSit	Opcional	String	Abrangência: Situação (+) - Máscara: A[200]
fimRon	Opcional	DateTime	Fim período Solicitações Ronda - Máscara: DD/MM/YYYY
abrVtr	Opcional	String	Abrangência: Escala Vlr (+) - Máscara: A[200]
digVal	Opcional	String	Recalcular Vales Digitados Valores: S - Sim N - Não
abrTsa	Opcional	String	Abrangência: Tipo de Salário (+) - Máscara: A[100]

Resposta:

Observação

<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>

Escalonar

Web service para realização de processamentos escalonados da Geração de Vales-transporte.

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>
				<abrTcl>Integer</abrTcl>
				<codCal>Integer</codCal>
				<abrCad>String</abrCad>
				<iniPer>DateTime</iniPer>
				<abrTrb>String</abrTrb>
				<fimPer>DateTime</fimPer>
				<abrFil>String</abrFil>
				<iniAfa>DateTime</iniAfa>
				<abrLoc>String</abrLoc>
				<fimAfa>DateTime</fimAfa>
				<abrTCo>String</abrTCo>
				<iniRon>DateTime</iniRon>
				<abrSit>String</abrSit>
				<fimRon>DateTime</fimRon>
				<abrVtr>String</abrVtr>
				<digVal>String</digVal>
				<abrTsa>String</abrTsa>
			</parameters>
		</ser:Escalonar>
	</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
abrTcl	Opcional	Integer	Abrangência de tipos de colaborador Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
codCal	Obrigatório	Integer	Código de cálculo que será usado no processo - Máscara: 9999
abrCad	Opcional	String	Abrangência: Colaborador (+). - Máscara: A[200]
iniPer	Opcional	DateTime	Início do Período - Máscara: DD/MM/YYYY
abrTrb	Opcional	String	Abrangência: Local (+). - Máscara: A[200]
fimPer	Opcional	DateTime	Fim do Período - Máscara: DD/MM/YYYY
abrFil	Opcional	String	Abrangência: Filial (+). - Máscara: A[200]
iniAfa	Opcional	DateTime	Início do Afastamento - Máscara: DD/MM/YYYY
abrLoc	Opcional	String	Abrangência: Local ("+"). - Máscara: A[200]
fimAfa	Opcional	DateTime	Fim do Afastamento - Máscara: DD/MM/YYYY
abrTCo	Opcional	String	Abrangência: Tipo de Contrato (+). - Máscara: A[100]
iniRon	Opcional	DateTime	Início perído Solicitações Ronda - Máscara: DD/MM/YYYY
abrSit	Opcional	String	Abrangência: Situação (+). - Máscara: A[200]
fimRon	Opcional	DateTime	Fim período Solicitações Ronda - Máscara: DD/MM/YYYY
abrVtr	Opcional	String	Abrangência: Escala Vlr (+). - Máscara: A[200]
digVal	Opcional	String	Recalcular Vales Digitados Valores: S - Sim N - Não
abrTsa	Opcional	String	Abrangência: Tipo de Salário (+). - Máscara: A[100]

Resposta:

Observação

<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.

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