PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas | HCM - versão 6.10.3
Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Administração de Pessoal > Com.senior.g5.rh.fp.fichaBasica

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

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

Portas

Diretor

Web service para realização de manutenção na guia Diretor da Ficha Básica.

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:Diretor>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <numCad>Integer</numCad>
        <numIns>Double</numIns>
        <apoIda>String</apoIda>
        <faiIns>Integer</faiIns>
        <gpsTri>DateTime</gpsTri>
        <opcAtu>String</opcAtu>
        <emtCar>String</emtCar>
        <dctIns>Integer</dctIns>
        <dedIns>Double</dedIns>
      </parameters>
    </ser:Diretor>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999
numIns Opcional Double Número de inscrição no INSS.
- Opcional
- Máscara: 9[11]
apoIda Opcional String Emitir carnê com os códigos GPS instituídos pelo Decreto 6042/2007 do INSS (1163, 1180, 1473, 1490).
- Máscara: U

Valores:
"S" - Sim
"N" - Não
faiIns Opcional Integer Faixa de contribuição do carnê do INSS na qual o contribuinte está efetuando os recolhimentos.
- Opcional
- Máscara: 99
gpsTri Opcional DateTime Data início da GPS Trimestral
- Opcional
- Máscara: MM/YYYY

Este parâmetro só pode ser informado se o parâmetro FalIns for igual a 1 e se o parâmetro OpcAtu for diferente de "S".
opcAtu Opcional String Efetuar automaticamente a atualização da faixa deste contribuinte para a próxima, em função do número de contribuições efetuadas na faixa.
- Máscara: U

Valores:
"S" - Sim
"N" - Não
emtCar Opcional String Emitir ou não o carnê do contribuinte.
- Máscara: U

Valores:
"S"
"N"
dctIns Opcional Integer Em quais proventos há desconto de INSS.
- Opcional
- Máscara: 9

Valores:
0 - Nenhum
1 - Normal
2 - 13º Salário
3 - Todos

Se este parâmetro não for informado, o sistema utilizará o valor 0.
dedIns Opcional Double Percentual devido (normalmente 11% ou 20%), para cálculo do desconto de INSS.
- Obrigatório, se o parâmetro DedIns for diferente de 0. Caso o contrário, não deve ser informado.
- Máscara: Z9,99

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

OutroContrato

Web service para realização de manutenção na guia Outro Contrato da Ficha Básica.

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:OutroContrato>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
	 <tipCol>Integer</tipCol>
        <numCad>Integer</numCad>
        <outCon>String</outCon>
        <outTet>String</outTet>
        <outEmp>Integer</outEmp>
        <outTip>Integer</outTip>
        <outCad>Integer</outCad>
      </parameters>
    </ser:OutroContrato>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
tipCol Opcional Integer Tipo de Colaborador, caso não informado o sistema considera o valor padrão 1 - Empregado.

Valores:
1- Empregado
2- Terceiro

Máscara: 9
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999
outCon Opcional String Existência de um outro contrato de trabalho do colaborador, para ajustar os cálculos do INSS e IR, respeitando o percentual devido e o teto.
- Máscara: U

Valores:
"U" - Contrato Único
"S" - Outro Contrato Fora do Sistema
"F" - Outro Contrato Dentro do Sistema
"T" - Terceiros com mesmo CPF

Nunca informar esta opção para este web service. Este item foi descrito somente para ficar compatível com o Help.
outTet Opcional String Atingir teto INSS no outro contrato:
- Opcional
- Máscara: U

Valores:
"S" - Sim
"N" - Não

Somente informar se o parâmetro OutCon for igual a "F".
outEmp Opcional Integer Código da empresa no outro contrato.
- Opcional
- Máscara: 9999

Não informar valor se o parâmetro OutCon for igual a "U".
outTip Opcional Integer Tipo do colaborador no outro contrato.
- Opcional
- Máscara: 9

Valores:
1 - Empregado
2 - Terceiro
3 - Parceiro

Não informar valor se o parâmetro OutCon for igual a "U".
outCad Opcional Integer Código do colaborador no outro contrato.
- Opcional
- Máscara: 999999999

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

Sindicato

Web service para realização de manutenção na guia Sindicatos da Ficha Básica.

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:Sindicato>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <sindicatos>
          <tipOpe>String</tipOpe>
          <codSin>Integer</codSin>
          <socSin>String</socSin>
          <pagSin>String</pagSin>
          <tasSin>String</tasSin>
          <cusSin>String</cusSin>
          <revSin>String</revSin>
          <datIni>DateTime</datIni>
          <datFim>DateTime</datFim>
        </sindicatos>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Sindicato>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Obrigatório
- Chave
- Máscara: 9999
sindicatos Opcional Set Lista de sindicatos.
sindicatos.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Obrigatório
- Máscara: U
- Valores:
"I" - Inclusão
"A" - Alteração
"E" - Exclusão
sindicatos.codSin Obrigatório Integer Código do sindicato que o colaborador pertence.
- Obrigatório
- Chave
- Máscara: 999
sindicatos.socSin Opcional String Colaborador sindicalizado
- Máscara: U
- Valores:
"S" - Sim
"N" - Não
sindicatos.pagSin Opcional String Recolher da contribuição sindical.
- Máscara: U
- Valores:
"S" - Sim
"N" - Não
sindicatos.tasSin Opcional String Descontar taxa assistencial.
- Máscara: U
- Valores:
"S" - Sim
"N" - Não
sindicatos.cusSin Opcional String Descontar taxa de custeio.
- Máscara: U
- Valores:
"S" - Sim
"N" - Não
sindicatos.revSin Opcional String Descontar reversão salarial.
- Opcional
- Máscara: U
- Valores:
"S" - Sim
"N" - Não
sindicatos.datIni Opcional DateTime Data inicial de vigência do sindicato
- Máscara: DD/MM/YYYY
sindicatos.datFim Opcional DateTime Data final da vigência do sindicato
- Opcional
- Máscara: DD/MM/YYYY
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

Selecao

Web service para realização de manutenção na guia Seleção da Ficha Básica.

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:Selecao>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <selecao>
          <tipOpe>String</tipOpe>
          <codSel>Integer</codSel>
        </selecao>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Selecao>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
selecao Opcional Set Lista de código de seleção do colaborador.
selecao.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Máscara: U
- Valores:
"I" - Inclusão
"E" - Exclusão
selecao.codSel Obrigatório Integer Código da seleção.
- Obrigatório
- Chave
- Máscara: 999
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

Seguros

Web service para realização de manutenção na guia Seguros da Ficha Básica.

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:Seguros>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <seguros>
          <tipOpe>String</tipOpe>
          <codSeg>Integer</codSeg>
        </seguros>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Seguros>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
seguros Opcional Set Lista de códigos de seguro.
seguros.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Obrigatório
- Máscara: U
- Valores:
"I" - Inclusão
"E" - Exclusão
seguros.codSeg Obrigatório Integer Código do tipo de seguro.
- Obrigatório
- Chave
- Máscara: 999
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

Percentuais

Web service para realização de manutenção na guia Percentuais da Ficha Básica.

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:Percentuais>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <percentuais>
          <tipOpe>String</tipOpe>
          <codPer>Integer</codPer>
          <desPer>String</desPer>
          <perLiv>Double</perLiv>
        </percentuais>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Percentuais>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
percentuais Opcional Set Lista de Percentuais.
percentuais.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Obrigatório
- Máscara: U
- Valores:
"I" - Inclusão
"A" - Alteração
"E" - Exclusão
percentuais.codPer Obrigatório Integer Código do Percentual Livre.
- Obrigatório
- Chave
- Máscara: 99
percentuais.desPer Opcional String Descrição do percentual.
Mascara: A[30]
percentuais.perLiv Opcional Double Percentual Livre.
- Máscara: ZZ9,9999
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

Anuidades

Web service para realização de manutenção na guia Anuidades da Ficha Básica.

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:Anuidades>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <anuidades>
          <tipOpe>String</tipOpe>
          <numAnu>Integer</numAnu>
          <datAnu>DateTime</datAnu>
          <tipAnu>String</tipAnu>
          <perAnu>Double</perAnu>
          <valAnu>Double</valAnu>
        </anuidades>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Anuidades>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
anuidades Opcional Set Lista de Anuidades.
anuidades.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".
Anuidades.NumAnu Opcional Integer Anos: Quantidade de anos de cada anuidade, conforme o tipo: anuênio = 01, biênio = 02, triênio = 03, etc.
- Chave
- Máscara: 99
anuidades.datAnu Opcional DateTime Competência para início da contagem da quantidade de anos trabalhados.
- Opcional
- Máscara: MM/YYYY
anuidades.tipAnu Opcional String Tipo de tratamento da anuidade.
- Máscara: U
- Valores:
"P" - Percentual p/ Cada Anuidade
"F" - Percentual Fixo
"V" - Valor p/ Cada Anuidade
"S" - Valor p/ Cada Anuidade Sindicato
anuidades.perAnu Opcional Double Percentual para pagamento da anuidade.
- Opcional
- Máscara: Z9,99
- Obs.: Este parâmetro só pode ser informado se o Tipo for "P" ou "F".
anuidades.valAnu Opcional Double Valor para pagamento da anuidade.
- Opcional
- Máscara: ZZZZZZZZ9,99
- Obs.: Este parâmetro só pode ser informado se o Tipo for "V".
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

Filhos

Web service para realização de manutenção na guia Filhos da Ficha Básica.

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:Filhos>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <nascimentos>
          <tipOpe>String</tipOpe>
          <nasFil>DateTime</nasFil>
        </nascimentos>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Filhos>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
nascimentos Opcional Set Lista Nascimentos dos Filhos.
nascimentos.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Obrigatório
- Máscara: U
- Valores:
"I" - Inclusão
"E" - Exclusão
nascimentos.nasFil Obrigatório DateTime Data de nascimento de um filho.
- Obrigatório
- Chave
- Máscara: DD/MM/YYYY
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

ModalidadesPat

Web service para realização de manutenção na guia Modalidades PAT da Ficha Básica.

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:ModalidadesPat>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <modalidadesPat>
          <tipOpe>String</tipOpe>
          <modPat>Integer</modPat>
        </modalidadesPat>
        <numCad>Integer</numCad>
      </parameters>
    </ser:ModalidadesPat>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
modalidadesPat Opcional Set Lista das Modalidades PAT.
modalidadesPat.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Máscara: U
- Valores:
"I" - Inclusão
"E" - Exclusão
modalidadesPat.modPat Obrigatório Integer Modalidades do PAT que o colaborador participa.
- Chave
- Máscara: 9
- Valores:
1 - Serviço Próprio
2 - Administração de Cozinhas
3 - Refeição Convênio
4 - Refeições Transportadas
5 - Cesta de Alimentos
6 - Alimentação Convênio
numCad Obrigatório Integer Código do Colaborador.
- Chave
- Máscara: 999999999

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

Projetos

Web service para realização de manutenção na guia Projetos da Ficha Básica.

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:Projetos>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <projetos>
          <tipOpe>String</tipOpe>
          <datHis>DateTime</datHis>
          <conPrj>String</conPrj>
        </projetos>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Projetos>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Opcional Integer Código da empresa que será utilizada na integração.
- Chave
- Máscara: 9999
projetos Opcional Set Lista de Histórico de Projetos do Colaborador.
projetos.tipOpe Obrigatório String Tipo da operação a ser efetuada para um lançamento (uma linha).
- Obrigatório
- Máscara: U
- Valores:
"I" - Inclusão
"A" - Alteração
"E" - Exclusão
Projetos.DatHis Obrigatório DateTime Data da Alteração.
- Obrigatório
- Chave
- Máscara: DD/MM/YYYY
projetos.conPrj Opcional String Controlar Projeto/Fase.
- Máscara: U
- Valores:
"S" - Sim
"N" - Não
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999

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

FichaBasica_6

Web service de integração que permite realizar alterações na Ficha Básica.

Necessita autenticação: Sim

Situação de versão: Atual

Versão: 6

Requisição: 

<soapenv:Envelope xmlns:ser="http://services.senior.com.br" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ser:FichaBasica>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <datAdm>DateTime</datAdm>
        <sitAfa>Integer</sitAfa>
        <codCar>String</codCar>
        <codEsc>Integer</codEsc>
        <codFil>Integer</codFil>
        <indAdm>Integer</indAdm>
        <numLoc>String</numLoc>
        <codEtb>Integer</codEtb>
        <codCcu>String</codCcu>
        <numCtp>Integer</numCtp>
        <pagSin>String</pagSin>
        <codFicFmd>String</codFicFmd>
        <codTap>Integer</codTap>
        <escVtr>Integer</escVtr>
        <cateSo>Integer</cateSo>
        <tipOpe>String</tipOpe>
        <codVinHvi>Integer</codVinHvi>
        <datAfaAfa>DateTime</datAfaAfa>
        <datAltHca>DateTime</datAltHca>
        <datAltHes>DateTime</datAltHes>
        <datAltHfi>DateTime</datAltHfi>
        <admeSo>Integer</admeSo>
        <datAltHlo>DateTime</datAltHlo>
        <iniEtbHeb>DateTime</iniEtbHeb>
        <datAltCcu>String</datAltCcu>
        <serCtp>String</serCtp>
        <depIrf>Integer</depIrf>
        <conRho>Integer</conRho>
        <posTra>String</posTra>
        <iniEvt>DateTime</iniEvt>
        <numCad>Integer</numCad>
        <apuPonApu>Integer</apuPonApu>
        <horAfaAfa>Time</horAfaAfa>
        <codMotHca>Integer</codMotHca>
        <codTmaHes>Integer</codTmaHes>
        <tipAdmHfi>Integer</tipAdmHfi>
        <admEmp>DateTime</admEmp>
        <conTovHlo>String</conTovHlo>
        <fimEtbHeb>DateTime</fimEtbHeb>
        <conFinCcu>Integer</conFinCcu>
        <digCar>String</digCar>
        <depSaf>Integer</depSaf>
        <cadFol>String</cadFol>
        <iniAtu>DateTime</iniAtu>
        <fimEvt>DateTime</fimEvt>
        <nomFun>String</nomFun>
        <artCltApu>Integer</artCltApu>
        <codAteAfa>Integer</codAteAfa>
        <funEsoHca>String</funEsoHca>
        <turInt>Integer</turInt>
        <conTovHfi>String</conTovHfi>
        <segDes>Integer</segDes>
        <conTosHlo>String</conTosHlo>
        <obsIniHeb>String</obsIniHeb>
        <dexCtp>DateTime</dexCtp>
        <modPag>String</modPag>
        <verInt>String</verInt>
        <motPos>Integer</motPos>
        <ponEmb>Integer</ponEmb>
        <apeFun>String</apeFun>
        <codDSiApu>Integer</codDSiApu>
        <nomAteAfa>String</nomAteAfa>
        <carVagHca>String</carVagHca>
        <codEqp>Integer</codEqp>
        <datEntHfi>DateTime</datEntHfi>
        <catAnt>Integer</catAnt>
        <locTraHlo>String</locTraHlo>
        <obsFimHeb>String</obsFimHeb>
        <estCtp>String</estCtp>
        <codBan>Integer</codBan>
        <tipSal>Integer</tipSal>
        <posObs>String</posObs>
        <tipCon>Integer</tipCon>
        <codSinHsi>Integer</codSinHsi>
        <orgClaAfa>Integer</orgClaAfa>
        <codCat>Integer</codCat>
        <codMotHsa>Integer</codMotHsa>
        <tInAnt>Integer</tInAnt>
        <natDesHna>String</natDesHna>
        <numCpf>String</numCpf>
        <codAge>Integer</codAge>
        <busHor>Integer</busHor>
        <tipSex>String</tipSex>
        <socSinHsi>String</socSinHsi>
        <regConAfa>String</regConAfa>
        <desSim>String</desSim>
        <tipSalHsa>Integer</tipSalHsa>
        <cnpjAn>Double</cnpjAn>
        <numPis>Double</numPis>
        <tpcPix>Integer</tpcPix>
        <assPpr>Integer</assPpr>
        <estCiv>Integer</estCiv>
        <possBHHsi>String</possBHHsi>
        <estConAfa>String</estConAfa>
        <horBas>Integer</horBas>
        <codEstHsa>Integer</codEstHsa>
        <admAnt>DateTime</admAnt>
        <dcdPis>DateTime</dcdPis>
        <chvPix>String</chvPix>
        <codFor>Integer</codFor>
        <graIns>Integer</graIns>
        <usaBhrHsi>String</usaBhrHsi>
        <aciTraAfa>Integer</aciTraAfa>
        <datAltHor>DateTime</datAltHor>
        <claSalHsa>String</claSalHsa>
        <matAnt>String</matAnt>
        <tipOpc>String</tipOpc>
        <tpCtBa>Integer</tpCtBa>
        <insCur>Integer</insCur>
        <datNas>DateTime</datNas>
        <codBhrHsi>Integer</codBhrHsi>
        <codDoeAfa>String</codDoeAfa>
        <horSabHor>Integer</horSabHor>
        <nivSalHsa>String</nivSalHsa>
        <onuSce>Integer</onuSce>
        <datOpc>DateTime</datOpc>
        <conBan>Double</conBan>
        <reaRes>String</reaRes>
        <codPro>String</codPro>
        <cauDemAfa>Integer</cauDemAfa>
        <horSemHor>Time</horSemHor>
        <valSalHsa>Double</valSalHsa>
        <resOnu>String</resOnu>
        <conFgt>Double</conFgt>
        <digBan>String</digBan>
        <codNac>Integer</codNac>
        <conTovAfa>String</conTovAfa>
        <horDsrHor>Time</horDsrHor>
        <cplSalHsa>Double</cplSalHsa>
        <perJur>Integer</perJur>
        <perPag>String</perPag>
        <diaJusAfa>Integer</diaJusAfa>
        <desSimHor>String</desSimHor>
        <moeEstHsa>Integer</moeEstHsa>
        <tipApo>Integer</tipApo>
        <qhrAfaAfa>Integer</qhrAfaAfa>
        <salEstHsa>Double</salEstHsa>
        <datApo>DateTime</datApo>
        <datTerAfa>DateTime</datTerAfa>
        <cplEstHsa>Double</cplEstHsa>
        <irrIse>String</irrIse>
        <horTerAfa>Time</horTerAfa>
        <movSef>String</movSef>
        <prvTerAfa>DateTime</prvTerAfa>
        <recAdi>String</recAdi>
        <exmRetAfa>String</exmRetAfa>
        <rec13S>String</rec13S>
        <obsAfaAfa>String</obsAfaAfa>
        <lisRai>String</lisRai>
        <manCgcAfa>String</manCgcAfa>
        <emiCar>String</emiCar>
        <manRemAfa>String</manRemAfa>
        <codCha>String</codCha>
        <atePatAfa>String</atePatAfa>
        <defFis>String</defFis>
        <codDef>Integer</codDef>
        <benRea>String</benRea>
        <cotDef>String</cotDef>
        <racCor>Integer</racCor>
        <ratEve>String</ratEve>
        <catSef>Integer</catSef>
        <datAltHcs>DateTime</datAltHcs>
        <datInc>DateTime</datInc>
        <horInc>Time</horInc>
        <recGra>String</recGra>
        <docEst>String</docEst>
        <codIdn>String</codIdn>
        <sisCes>Integer</sisCes>
        <opcCes>DateTime</opcCes>
      </parameters>
    </ser:FichaBasica>
  </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
datAdm Opcional DateTime Informar data de admissão:
- Obrigatório na inclusão

Máscara:
DD/MM/AAAA
sitAfa Opcional Integer Informar o código da situação

Valor Padrão: 1
codCar Opcional String Informar o código de cargo
codEsc Opcional Integer Informar o código da escala
- Obrigatório se:
- A empresa utilizar escala de horários
ou se integrar com os módulos CP, PLR ou BS

Máscara: Z[5]9[4]
codFil Opcional Integer Informar o código da filial do colaborador
- Obrigatório se: For inclusão
indAdm Opcional Integer Indicativo de Admissão:

Informar o indicativo de admissão
- Campo obrigatório * na inclusão de um novo colaborador

Valores:
1 - Normal
2 - Decorrente de Ação Fiscal (celetista)
3 - Decorrente de Decisão Judicial
4 - Tomou posse mas não entrou exercício (estatutário)

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
numLoc Opcional String Informar o código de local para o colaborador
- Obrigatório se: Incluir um novo colaborador
codEtb Opcional Integer Informar o tipo de estabilidade
* Somente informar se integrar através do módulo Administração de Pessoal

Valores
1 - Cipa
2 - Acidente de Trabalho
3 - Auxílio Maternidade
4 - Serviço Militar
5 - Mandato Sindical
6 - Servidor Público
7 - Retorno Férias
8 - Retorno Auxílio-doença
9 - Tempo Próximo Aposentadoria
10 - Convenção Coletiva (Dissídio)
11 - Tempo Anterior Opção FGTS
12 - Não Optante FGTS
13 - CIPA Empregador
14 - Membro da Comissão de Conciliação Prévia
15 - Membro do Conselho Curador do FGTS
16 - Membro do Conselho Nacional da Previdência Social
17 - Auxílio Educação
18 - Cooperativa de Consumo
19 - Cooperativa de Crédito
20 - Pessoa com Deficiência (PcD)
21 - Cooperativa do Sindicato
22 - CIPATR
99 - Outros

Valor padrão: 0
codCcu Opcional String Informar o centro de custo do colaborador
* Não informar para os módulos PLR, BS, SM e JR

- Máscara: U[18]
numCtp Opcional Integer Informar o número da carteira de trabalho do colaborador
* Não informar se o módulo de integração for o PLR
pagSin Opcional String Informar a indicação de recolhimento da contribuição, artigo 582 da CLT.
Obrigatório se:
- Integrar com o módulo Administração de Pessoal
Caso contrário, não informar.

Valores:
S - Já recolheu ao sindicato no ano
P - Colaborador admitido em Dezembro, será descontado na primeira competência do Próximo Ano (*)
N - Ainda não recolheu
M - Profissional liberal que recolhe para sua classe profissional
(*) A opção 'P' só estará disponível quando a data de admissão for na competência Dezembro.
codFicFmd Opcional String

Definir a geração da ficha médica para o colaborador.

* Somente informar se for integrado com o módulo Segurança e Medicina (SM).

Se no módulo Segurança e Medicina (SM), em Medicina > Definições > Ficha Médica > Gerar Ficha Colaborador, estiver informado:

  • "N": não informar o campo codFicFmd;
  • "S": informar no campo codFicFmd a string:
    • "AUTO": caso deseje gerar automaticamente a ficha.
  • "C": informar no campo codFicFmd a string:
    • "CONFIRMA": caso deseje gerar a ficha médica;
    • "CANCELA": caso deseje gerar a ficha médica.
  • "U": informar no campo codFicFmd a string:
    • "NOVO": caso deseje que o módulo Segurança e Medicina (SM) gere um novo código da ficha médica.

Observação: do contrário, informe o código da ficha médica que desejar para o colaborador.
codTap Opcional Integer Tipo de atuação do colaborador no posto de trabalho.

- O campo deverá ser preenchido somente quando a empresa utilizar posto de trabalho.

Máscara: 9[3]
escVtr Opcional Integer

Informar a escala de vale-transporte
* Somente informar se integrar com o AP ou BS

Máscara: 9[5]
cateSo Opcional Integer Informar a categoria do colaborador no eSocial

Valores:
101 - Empregado - Geral
102 - Empregado - Trabalhador Rural por Pequeno Prazo da Lei 11.718/2008
103 - Empregado - Aprendiz
104 - Empregado - Doméstico
105 - Empregado - contrato a termo firmado nos termos da Lei 9601/98
106 - Empregado - contrato por prazo determinado nos termos da Lei 6019/74
107 - Trabalhador não vinculado ao RGPS com direito ao FGTS
201 - Trabalhador Avulso - Portuário
202 - Trabalhador Avulso - Não Portuário (Informação do Sindicato)
203 - Trabalhador Avulso - Não Portuário (Informação do Contratante)
301 - Servidor Público - Titular de Cargo Efetivo
302 - Servidor Público - Ocupante de Cargo exclusivo em comissão
303 - Servidor Público - Exercente de Mandato Eletivo
304 - Servidor Público - Agente Público
305 - Servidor Público vinculado a RPPS indicado para conselho ou órgão representativo, na condição de representante do governo, órgão ou entidade ad administração pública.
401 - Dirigente Sindical - Em relação a Remuneração Recebida no Sindicato.
701 - Contrib. Individual - Autônomo contratado por Empresas em geral
702 - Contrib. Individual - Autônomo contratado por Contrib. Individual, por pessoa física em geral, ou por missão diplomática e repartição consular de carreira estrangeiras
703 - Contrib. Individual - Autônomo contratado por Entidade Beneficente de Assistência Social isenta da cota patronal
704 - Excluído.
711 - Contrib. Individual - Transportador autônomo contratado por Empresas em geral
712 - Contrib. Individual - Transportador autônomo contratado por Contrib. Individual, por pessoa física em geral, ou por missão diplomática e repartição consular de carreira estrangeiras
713 - Contrib. Individual - Transportador autônomo contratado por Entidade Beneficente de Assistência Social isenta da cota patronal
721 - Contrib. Individual - Diretor não empregado com FGTS
722 - Contrib. Individual - Diretor não empregado sem FGTS
731 - Contrib. Individual - Cooperado que presta serviços a empresa por intermédio de cooperativa de trabalho
732 - Contrib. Individual - Cooperado que presta serviços a Entidade Beneficente de Assistência Social isenta da cota patronal ou para pessoa física
733 - Contrib. Individual - Cooperado eleito para direção da Cooperativa
734 - Contrib. Individual - Transportador Cooperado que presta serviços a empresa por intermédio de cooperativa de trabalho
735 - Contrib. Individual - Transportador Cooperado que presta serviços a Entidade Beneficente de Assistência Social isenta da cota patronal ou para pessoa física
736 - Contrib. Individual - Transportador Cooperado eleito para direção da Cooperativa.
741 - Contrib. Individual - Cooperado filiado a cooperativa de produção.
751 - Contrib. Individual - Micro Empreendedor Individual, quando contratado por PJ
781 - Ministro de confissão religiosa ou membro de vida consagrada, de congregação ou de ordem religiosa
901 - Estagiário
902 - Médico residente ou residente em área profissional da saúde
903 - Bolsista
904 - Participante de curso de formação, com etapa de concurso público, sem vínculo de emprego/estatutário
905 - [Válida até 09/05/2021] Atleta não profissional em formação que receba bolsa
9995 - Beneficiário Ente Público
9996 - Beneficiário Ente Público - Somente Cadastro Benefício
9997 - Demitido com data anterior à sucessão (categoria exclusiva Senior)
9999 - Não se aplica
tipOpe Obrigatório String Tipo da operação a ser efetuada na integração

Valores:
I - Inclusão
A - Alteração
E - Exclusão
codVinHvi Opcional Integer Informar código de vínculo
- Obrigatório quando o módulo de integração não for SM, RS e TR
- Não informar na alteração
datAfaAfa Opcional DateTime Informar a data do afastamento
Obrigatório se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
Caso contrário, não informar.

Máscara:
DD/MM/AAAA
datAltHca Opcional DateTime Informar a data de alteração do cargo:
Obrigatório se:
- Na alteração, mudar o código de cargo
Caso contrário, não informar

Máscara:
DD/MM/AAAA
datAltHes Opcional DateTime Informar a data de alteração da escala
- Obrigatório se:
- Alterar a escala
- A empresa utilizar escala de horários
ou integrar com os módulos CP, PLR ou BS

Máscara:
DD/MM/AAAA
datAltHfi Opcional DateTime Informar data de alteração de filial
- Obrigatório se:
- Na alteração, mudar o código da filial
Caso contrário, não informar

Máscara:
DD/MM/AAAA
admeSo Opcional Integer Tipo Admissão eSocial:

Informar o tipo de admissão para o eSocial
- Campo Obrigatório* na inclusão de um novo colaborador

Valores:
1 - Admissão
2 - Transferência de empresa do mesmo grupo econômico
3 - Transferência de empresa consorciada ou de consórcio
4 - Transferência por motivo de sucessão, incorporação, cisão ou fusão
9 - Trabalhador Cedido (específico Senior)

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
datAltHlo Opcional DateTime Informar data de alteração do local
- Obrigatório se:
- Alterar o local do colaborador
Caso contrário, não informar

Máscara
DD/MM/AAAA
iniEtbHeb Opcional DateTime Informar a data de início da estabilidade
- Obrigatório se:
- Integrar através do módulo Administração de Pessoal
- Na alteração, se mudar o código de estabilidade
Caso contrário, não informar.

Máscara:
DD/MM/AAAA
datAltCcu Opcional String Informar data de alteração do centro de custo
- Obrigatório se:
- Na alteração, mudar o centro de custo
Caso contrário, não informar.

Máscara:
DD/MM/AAAA
serCtp Opcional String Informar a série da carteira de trabalho
* Não informar se o módulo de integração for o PLR
depIrf Opcional Integer Informar a quantidade de dependentes de IR.
* Somente informar se:
- Não utilizar rotina de dependentes
- O módulo de integração for o Administração de Pessoal

Valor padrão: 0
conRho Opcional Integer Informar quais os colaboradores que serão contados na verificação do limite de colaboradores permitidos
* Somente informar se possuir o módulo Controle de Ponto e Refeitório

Valores:
"1 - Ronda Ponto e Refeitório": será considerado para a contagem de colaboradores tanto para o controle de ponto quanto para o controle de refeitório.
"2 - Ronda Ponto": será considerado apenas para a contagem de colaboradores ativos para o controle de ponto. Será ignorado pelo Controle de Refeitório nos procedimentos de controle de refeitório.
"3 - Ronda Refeitório": será considerado apenas para a contagem de colaboradores ativos para o controle de refeitório. Será ignorado pelo Controle de Ponto nos procedimentos de controle de ponto.
"4 - Não Conta": não será considerado para a contagem de colaboradores ativos para o controle de ponto, controle de refeitório e a Gestão do Ponto. Será ignorado pelo Controle de Ponto e Refeitório e Gestão do Ponto em todos os procedimentos.

Valor Padrão:
1

Obs: Quando o sistema não estiver integrado com Controle de Refeitório, não é permitido informar os seguintes valores:
1 - Ronda Ponto e Refeitório
3 - Ronda Refeitório
posTra Opcional String Posto de trabalho em que o colaborador atua.


- O campo deverá ser preenchido somente quando a empresa utilizar posto de trabalho.
iniEvt Opcional DateTime Informar data de início da escala de vale-transporte
- Obrigatório se:
- Na alteração, mudar a escala de vale-transporte.
Caso contrário, não informar.

Máscara:
DD/MM/AAAA
numCad Obrigatório Integer Indicar um número de cadastro para identificar cada colaborador.
- Chave

* Se informar o valor 0, será gerado um novo cadastro para o colaborador. Somente disponível esta opção para o TipOpe=I.
apuPonApu Opcional Integer Informar o tipo de apuração
- Obrigatório se possuir o módulo CP e o módulo de integração for diferente do CS ou QL
- Não informar na alteração

Valores:
1 - Normal
2 - Dispensado do Ponto
3 - Somente Refeitório
4 - Dispensado do Ponto - Desconsidera Todas Marcações
5 - Sem Controle de Ponto e Refeitório
6 - Dispensado do Ponto - Desconsidera Marcações de Ponto
horAfaAfa Opcional Time Informar a hora do afastamento
Obrigatório se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
Caso contrário, não informar.

Máscara:
HH:MM
codMotHca Opcional Integer Informar o código de motivo de alteração de cargo
codTmaHes Opcional Integer Informar o código da turma da escala
- Obrigatório se:
- Alterar a escala
- A empresa utilizar escala de horários
ou integrar com os módulos CP, PLR ou BS
- O tipo da escala for diferente de 'D - Definida'
Não informar se o módulo de integração for o CS, QL ou JR
tipAdmHfi Opcional Integer Informar o tipo de admissão na filial
- Obrigatório se:
- Incluir um novo colaborador
- Na alteração, mudar o código da filial
Caso contrário, não informar

Valores:
1 - Primeiro Emprego
2 - Reemprego
3 - Transferência com Ônus
4 - Transferência sem Ônus
5 - Incorporação / Fusão / Cisão / Outros
6 - Reintegração
7 - Recondução (Servidor Público)
8 - Reversão / Readaptação (Servidor Público)
admEmp Opcional DateTime

Este campo é obrigatório quando a categoria eSocial for 997. Nos demais casos não deve ser informado.
Deverá ser preenchido com a data de sucessão.

Máscara:
DD/MM/AAAA
conTovHlo Opcional String Informar turn-over de entrada
- Obrigatório se:
- Incluir um novo colaborador
ou Alterar o local do colaborador
- Se assinalado para usar turn-over
Caso contrário, não informar

Valores:
S - Sim
N - Não
fimEtbHeb Opcional DateTime Informar a data de início da estabilidade
* Somente informar se:
- Integrar através do módulo Administração de Pessoal
- Na alteração, se mudar o código de estabilidade
- Na inclusão, se o código da estabilidade for diferente de 0

Máscara:
DD/MM/AAAA
conFinCcu Opcional Integer Informar a conta financeira
- Obrigatório se:
- Alterar ou incluir o centro custo
- O módulo de integração for o Administração de Pessoal
- A empresa usar contabilização por conta financeira
Caso contrário, não informar.
digCar Opcional String Informar o dígito verificador da carteira de trabalho
* Não informar se o módulo de integração for o PLR
depSaf Opcional Integer Informar a quantidade de dependentes do Salário Família.
* Somente informar se
- Não utilizar rotina de dependentes
- O módulo de integração for o Administração de Pessoal

Valor padrão: 0
cadFol Opcional String Informe o cadastro do colaborador no sistema da folha de pagamento. Este código será utilizado na geração do arquivo texto com as horas para a folha.
* Somente informar se estiver integrando com o módulo Controle de Ponto.

Valor padrão:
Número do Cadastro
iniAtu Opcional DateTime Informar início da atuação do colaborador no posto de trabalho:

Obrigatório: Se na alteração, mudar o posto ou o tipo de atuação. Caso contrário, não informar

Máscara: DD/MM/AAAA

O campo deverá ser preenchido somente quando a empresa utilizar posto de trabalho.
fimEvt Opcional DateTime Informar a data final da escala de vale-transporte
* Somente informar se integrar com o AP ou BS

Máscara:
DD/MM/AAAA
nomFun Opcional String Nome do colaborador
artCltApu Opcional Integer

Informar o código do artigo 62 da CLT:
- Obrigatório se possuir o módulo Controle de Ponto e Refeitório e o tipo de apuração for diferente de "1 - Normal";
- Quando o parâmetro apuPonApu estiver informado com valor "1 - Normal", esse parâmetro não deve ser informado;
- Não informar na alteração.

Valores:
1 - Não se aplica
2 - Atividade Externa especificada no Inciso I
3 - Funções especificadas no Inciso II
4 - Teletrabalho, previsto no Inciso III
codAteAfa Opcional Integer Código do Atendente
- Obrigatório, quando a empresa estiver utilizando o e-Social

Este parâmetro somente poderá ser informado para situações com tipos iguais a:
3 - Auxílio-doença,
6 - Licença Maternidade,
14 - Auxílio-doença 15 dias,
19 - Auxílio Maternidade.

Somente poderá ser informado um atendente que possua as informações do
Conselho Profissional e Registro no Conselho já cadastradas.

Disponível em todos os módulos
funEsoHca Opcional String Informar se o cargo deve considerado como Função eSocial.

Opções:
S - Sim
N - Não

Observação: este campo deve ser informado quando o campo Função eSocial, da tela de Definições do eSocial (FR030DES), estiver definido como "2 - Histórico de Cargo" ou "4 - Histórico de Função ou Cargo".
turInt Opcional Integer Informar o código da turma do intervalo
Informar somente se:
- Integrar com o Controle de Ponto e Refeitório
conTovHfi Opcional String Informar se considera para o turn-over da filial
- Obrigatório se:
- Incluir um novo colaborador
- Na alteração, mudar o código da filial
- Se assinalado para usar turn-over
Caso contrário, não informar

Valores:
S - Sim
N - Não
segDes Opcional Integer

Seguro Desemprego

Este parâmetro serve para controlar se o colaborador admitido requeriu ou está em gozo de seguro desemprego (atendendo à Portaria 1.129/2014). As seguintes opções estão disponíveis:

- 0 - Não consultado, caso a informação não tenha sido verificada no momento da admissão;
- 1 - Não está recebendo;
- 2 - Está recebendo ou efetuou entrada no requerimento.

A informação preenchida aqui é considerada pelo campo Seguro Desemprego durante a geração do CAGED Diário.

* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
conTosHlo Opcional String Informar turn-over de saída
- Obrigatório se:
- Incluir um novo colaborador
ou Alterar o local do colaborador
- Se assinalado para usar turn-over
Caso contrário, não informar

Valores:
S - Sim
N - Não
obsIniHeb Opcional String Informar observações iniciais de estabilidade

Máscara:
255 caracteres
dexCtp Opcional DateTime Informar a data de expedição da carteira de trabalho
* Não informar se o módulo de integração for o PLR

Máscara
DD/MM/AAAA
modPag Opcional String Informar o modo de pagamento
- Obrigatório se:
- O módulo de integração for AP ou PLR
Caso contrário, não informar

Valores:
C - Em cheque
R - Relação bancária
D - Em dinheiro
O - Ordem de Pagamento
P - Pix
verInt Opcional String Informar uma opção de controle de interjornada
* Somente informar se integrando com o Controle de Ponto e Refeitório

Valores:
B - Bloquear, o sistema bloqueará a Programação, cuja sequência de horários não respeitar o limite da Interjornada.
A - Alertar, o sistema fará um alerta, informando que o horário não está respeitando o limite da Interjornada.
I - Ignorar o controle de horas da Interjornada.

Valor Padrão:
I
motPos Opcional Integer Informar o motivo de alteração do posto de trabalho.

Máscara: 9[3]

O campo deverá ser preenchido somente quando a empresa utilizar posto de trabalho.
ponEmb Opcional Integer Informar o código do ponto de embarque
* Somente informar se integrar com o AP ou BS
apeFun Opcional String Apelido do colaborador
codDSiApu Opcional Integer Código da definição de situação
nomAteAfa Opcional String Nome do Atendente
Obrigatório se:
- A empresa utiliza o eSocial
- O Motivo eSocial for "1 - Acidente/Doença do trabalho" ou "2 - Novo afastamento decorrente do mesmo acidente/doença do trabalho dentro de 60 dias".

- Não possuir atendente informado
carVagHca Opcional String Informar o código de cargo do novo cargo da vaga
Somente informar se:
- No sistema estiver assinalado com 'S' para permitir informar cargo diferenciado para a vaga
codEqp Opcional Integer Informar o código da Equipe
- Obrigatório se tipo de escala for G
DatEntHfi Opcional DateTime

Informar a data em que o colaborador transferido entrou na filial, essa data irá no histórico de filial. Caso não informada será usada a data de admissão no histórico de filial

A data de entrada na filial não pode ser menor que a data de admissão original.

Máscara: DD/MM/AAAA
codMotHsa Opcional Integer Informar o código do motivo de alteração
- Obrigatório se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL
Caso contrário, não informar
catAnt Opcional Integer Categoria eSocial Origem:

Informar categoria do eSocial do empregador anterior. Obrigatório* quando:
- Categoria eSocial do trabalhador for 401 ou 410;

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* A obrigatoriedade só será aplicada se já estiver utilizando eSocial.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.

Valores válidos apenas para categoria eSocial 410:
101 - Empregado - Geral, inclusive o empregado público da administração direta ou indireta contratado pela CLT
301 - Servidor Público - Titular de Cargo Efetivo
302 - Servidor Público - Ocupante de Cargo exclusivo em comissão
306 - Servidor Público Temporário, sujeito a regime administrativo especial definido em lei própria

Valores:
101 - Empregado - Geral, inclusive o empregado público da administração direta ou indireta contratado pela CLT
102 - Empregado - Trabalhador Rural por Pequeno Prazo da Lei 11.718/2008
103 - Empregado - Aprendiz
104 - Empregado - Doméstico
105 - Empregado - contrato a termo firmado nos termos da Lei 9601/98
106 - Empregado - contrato por prazo determinado nos termos da Lei 6019/74
201 - Trabalhador Avulso - Portuário
202 - Trabalhador Avulso - Não Portuário
301 - Servidor Público - Titular de Cargo Efetivo
302 - Servidor Público - Ocupante de Cargo exclusivo em comissão
303 - Agente Político
305 - Servidor Público indicado para conselho ou órgão representativo, na condição de representante do governo, órgão ou entidade da administração pública
306 - Servidor Público Temporário, sujeito a regime administrativo especial definido em lei própria
309 - Agente Público - Outros
401 - Dirigente Sindical - informação prestada pelo Sindicato
410 - Trabalhador cedido - informação prestada pelo Cessionário
701 - Contribuinte individual - Autônomo em geral, exceto se enquadrado em uma das demais categorias de contribuinte individual
711 - Contribuinte individual - Transportador autônomo
721 - Contribuinte individual - Diretor não empregado com FGTS
722 - Contribuinte individual - Diretor não empregado sem FGTS
723 - Contribuinte individual - empresários, sócios e membro de conselho de administração ou fiscal
731 - Contribuinte individual - Cooperado que presta serviços a empresa por intermédio de cooperativa de trabalho
734 - Contribuinte individual - Transportador Cooperado que presta serviços por intermédio de cooperativa de trabalho
738 - Contribuinte individual - Cooperado filiado a Cooperativa de Produção
741 - Contribuinte individual - Micro Empreendedor Individual, quando contratado por PJ
751 - Contribuinte individual - aposentado de qualquer regime previdenciário, nomeado magistrado classista temporário da Justiça do Trabalho ou nomeado da Justiça Eleitoral
761 - Contribuinte individual - Associado eleito para direção de Cooperativa, associação ou entidade de classe de qualquer natureza ou finalidade
771 - Contribuinte individual - Membro de conselho tutelar, nos termos da Lei nº 8.069, de 13 de julho de 1990
781 - Ministro de confissão religiosa ou membro de vida consagrada, de congregação ou de ordem religiosa
901 - Estagiário
902 - Médico Residente
9999 - Não se aplica
locTraHlo Opcional String Informar o local de trabalho na Rais
* Somente informar se:
- Incluir um colaborador
ou Alterar o local de um colaborador
- O módulo da integração for o Administração de Pessoal
obsFimHeb Opcional String Informar observações finais de estabilidade

Máscara:
255 caracteres
estCtp Opcional String Informar a unidade de federação da carteira de trabalho

* Não informar se o módulo de integração for o PLR

Valores:
AC - Acre
AL - Alagoas
AM - Amazonas
AP - Amapá
BA - Bahia
CE - Ceará
DF - Distrito Federal
ES - Espírito Santo
FN - Fernando de Noronha
GO - Goiás
MA - Maranhão
MG - Minas Gerais
MS - Mato Grosso do Sul
MT - Mato Grosso
PA - Pará
PB - Paraíba
PE - Pernambuco
PI - Piauí
PR - Paraná
RJ - Rio de Janeiro
RN - Rio Grande do Norte
RO - Rondônia
RR - Roraima
RS - Rio Grande do Sul
SC - Santa Catarina
SE - Sergipe
SP - São Paulo
TO - Tocantins
XX - Estrangeiro
codBan Opcional Integer Informar o código do banco da conta bancária do colaborador.
- Obrigatório se:
- Informar modo de pagamento for R - Relação bancária".

* Não informar se:
- Utilizar histórico de contas bancárias
- O módulo de integração for diferente do AP, BS ou PLR
tipSal Opcional Integer Informar o código correspondente ao Tipo de Salário do colaborador:
* Somente informar se:
- O modulo de integração for o Controle de Ponto e Refeitório
- Não possuir o Administração de Pessoal integrado.

Valores:
1 - Mensalista
2 - Horista
3 - Diarista
4 - Comissionado
5 - Tarefeiro
6 - Terceiro

Valor Padrão: 1
posObs Opcional String Observação do histórico de posto de trabalho.

O campo deverá ser preenchido somente quando a empresa utilizar posto de trabalho.
tipCon Opcional Integer Informar o tipo de contrato entre empresa e colaborador
Obrigatório se:
- O tipo de operação for inclusão
- Integrar com os módulos: BS, CS, JR, PLR, CP e AP

Valores:
1 - Empregado Normal
2 - Diretor Não-Empregado
3 - Trabalhador Rural
4 - Aposentado
5 - Estagiário
6 - Menor Aprendiz
7 - Prazo Determinado
8 - Diretor Aposentado
9 - Agente Público
10 - Professor
11 - Cooperado
12 - Trabalhador Doméstico
codSinHsi Opcional Integer Informar código de sindicato
- Obrigatório quando o módulo de integração for CS, AP, CP
- Não informar na alteração
orgClaAfa Opcional Integer Órgão de Classe
Obrigatório se:
- A empresa utiliza o eSocial
- O Motivo eSocial for "1 - Acidente/Doença do trabalho" ou "2 - Novo afastamento decorrente do mesmo acidente/doença do trabalho dentro de 60 dias".
- Não possuir atendente informado

Lista:
1 - Conselho Regional de Medicina (CRM)
2 - Conselho Regional de Odontologia (CRO)
codCat Opcional Integer Informar o código da categoria
- Obrigatório se tipo da escala for do tipo G
tipSalHsa Opcional Integer Informar o tipo de salário do colaborador
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL

Valores:
1 - Mensalista
2 - Horista
3 - Diarista
4 - Comissionado
5 - Tarefeiro
6 - Terceiro

Valor padrão: 1
tInAnt Opcional Integer Tipo de inscrição do empregador anterior.

* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
natDesHna Opcional String Informar o código de natureza da despesa do colaborador.
- Obrigatório se:
- Incluir um colaborador
- Estiver assinalado para usar Natureza de Despesa
numCpf Opcional String Informar o CPF do colaborador:
* Não informar se o módulo de integração for o PLR ou JR

Máscara
999.999.99-99

Observações:
* Se informar deve ser um CPF válido
* Informar inclusive o dígito verificador
codAge Opcional Integer Informar o código da agência da conta bancária do colaborador
- Obrigatório se:
- Informar modo de pagamento for R - Relação bancária".

* Não informar se:
- Utilizar histórico de contas bancárias
- O módulo de integração for diferente do AP, BS ou PLR
busHor Opcional Integer Informar a forma de busca do horário
- Obrigatório se:
- Integrar o colaborador com o Controle de Ponto e Refeitório
- Possuir o módulo Transporte Coletivo
Caso contrário, não informar

Valores:
1 - Escala
2 - Serviço
tipSex Opcional String Informar o sexo do colaborador

Valores:
M - Masculino
F - Feminino
socSinHsi Opcional String Informar se é sindicalizado
Obrigatório se:
- Integrar com o módulo Administração de Pessoal
Caso contrário, não informar
- Não informar na alteração

Valores:
S - Sim, o colaborador é sindicalizado
N - Não é sindicalizado
regConAfa Opcional String Registro Conselho Profissional

Obrigatório se:
- A empresa utiliza o eSocial
- O Motivo eSocial for "1 - Acidente/Doença do trabalho" ou "2 - Novo afastamento decorrente do mesmo acidente/doença do trabalho dentro de 60 dias".
- Não possuir atendente informado
desSim Opcional String Descrição detalhada da jornada para o eSocial.

Este campo será utilizado apenas quando o campo Descrição de Jornada eSocial Simplificada da tela de assinalamentos, acessada através do menu Diversos > Assinalamentos (FR000ASS), estiver definido com a opção "S- Sim".
codEstHsa Opcional Integer Informar o código da estrutura de cargo
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL

Valor Padrão: 0
cnpjAn Opcional Double CNPJ Origem:

Número do CNPJ do empregador anterior. Obrigatório* quando:
- Tipo Admissão eSocial for 2, 3 ou 4;
- Categoria do trabalhador for igual a 410;
- Valor do campo Categoria eSocial Origem for 101, 102, 103, 104, 105 ou 106.
Caso contrário, não informar

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* A obrigatoriedade só será aplicada se já estiver utilizando eSocial.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
numPis Opcional Double Informar o número do PIS do colaborador
* Não informar se o módulo de integração for o PLR

Máscara:
999.99999.99.9

Observações:
* Se informar assegurar-se que o número está correto
* Informar inclusive o dígito verificador
tpcPix Opcional String Informar o tipo da chave PIX.
Máscara: 9[2]

Atenção, se utilizar histórico de contas bancárias, não deve informar esse parâmetro, os dados devem ser enviados através da porta ChavePix.

Valores:
01 - Telefone
02 - E-mail
03 - CPF/CNPJ
04 - Chave Aleatória
05 - Conta Bancária
tpCtBa Opcional Integer Informar o tipo de conta bancária
* Não informar se:
- Utilizar histórico de contas bancárias
- Não for a versão Internacional do Administração de Pessoal

Valores:
1 - Conta Corrente
2 - Conta Poupança
3 - Conta Salário
9 - Outros
assPpr Opcional Integer Assinalamento para o PPR
* Somente informar se o módulo de integração for o PLR

Valores:
1 - Recebe e conta para o PPR
2 - Recebe mas não conta para o PPR
3 - Não recebe mas conta para o PPR
4 - Não recebe e não conta para o PPR

Valor Padrão:
0
estCiv Opcional Integer Informar o estado civil do colaborador
* Não informar se o módulo de integração for o CP e não possuir TR integrado.

Valores:
1 - Solteiro
2 - Casado
3 - Divorciado
4 - Viúvo
5 - Concubinato
6 - Separado
9 - Outros
possBHHsi Opcional String Informar se o colaborador possui banco de horas

Disponível apenas se o cliente possuir o módulo CP na Proprietária.
Quando for vazio, o valor será cadastrado como 'N'.
estConAfa Opcional String UF Conselho profissional
Opcional, é possível informar quando:
- A empresa utiliza o eSocial

- O Motivo eSocial for "1 - Acidente/Doença do trabalho" ou "2 - Novo afastamento decorrente do mesmo acidente/doença do trabalho dentro de 60 dias".
horBas Opcional Integer Informar o código do horário base do colaborador
- Obrigatório se:
- A empresa não usar escala horária
- O módulo de integração for diferente do CP, BS ou PLR
Caso contrário, não informar
claSalHsa Opcional String Informar a classe salarial
- Obrigatório se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL
- Se o código da estrutura salarial for diferente de 0
- Se o formato da estrutura salarial for do tipo matriz
admAnt Opcional DateTime Data Admissão Origem:

Informar a data de admissão anterior. Obrigatório* quando:
- Tipo Admissão eSocial for 2, 3 ou 4;
- Categoria do trabalhador for igual a 410;
- Valor do campo Categoria eSocial Origem for 101, 102, 103, 104, 105 ou 106.
Caso contrário, não informar

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* A obrigatoriedade só será aplicada se já estiver utilizando eSocial.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
dcdPis Opcional DateTime Informar a data de cadastramento no Pis/Pasep.
* Não informar se o módulo de integração for o PLR

Máscara
DD/MM/AAAA
chvPix Opcional String Informar a chave PIX conforme seu tipo.

Quando a chave for do tipo "5 - Conta Bancária" não será possível informar este campo. O sistema irá considerar os dados informados nos parâmetros do banco.
Quando o tipo de chave PIX for "3 - CPF/CNPJ", se o parâmetro não for informado, o sistema irá automaticamente preencher com o CPF (numCpf).

Máscara: A[100]
conBan Opcional Double Informar o número da conta bancária do colaborador
* Não informar se:
- Utilizar histórico de contas bancárias
- O módulo de integração for diferente do AP, BS ou PLR
codFor Opcional Integer Indicar o código do fornecedor diferenciado por colaborador. Quando for gerada a integração financeira, se esse código não estiver indicado, será utilizado o código do fornecedor cadastrado no CIF
* Somente informar se integrar com o Administração de Pessoal com integração financeira com o ERP
graIns Opcional Integer Indicar a escolaridade de acordo com a codificação utilizada pela Rais

* Não informar se o módulo de integração for o CP e não possuir TR integrado.

Valores:
1 - Analfabeto
2 - 4ª Série Incompleta
3 - 4ª Série Completa
4 - 5ª a 8ª Série Incompleta
5 - 1º Grau Completo (1ª a 8ª Série)
6 - 2º Grau Incompleto
7 - 2º Grau Completo
8 - Superior Incompleto
9 - Superior Completo
10 - Pós-Graduação
11 - Mestrado
12 - Doutorado
13 - Ph.D.
usaBhrHsi Opcional String Informar como será a utilização do banco de horas, sendo "1 - Por abrangência do Banco" ou "2 - Pelo histórico do Sindicato".

Somente informar quando o campo Possui banco de horas estiver definido como "S - Sim".

Disponível apenas se o cliente possuir o módulo CP na Proprietária.
aciTraAfa Opcional Integer Tipo Acidente Trânsito

Este parâmetro somente poderá ser informado para situações com tipos iguais a:
3 - Auxílio-doença,
4 - Acidente Trabalho,
14 - Auxílio-doença 15 dias,
23 - Acidente Trabalho 15 dias

Disponível em todos os módulos
datAltHor Opcional DateTime Informar a data de alteração do horário
- Obrigatório se:
- A empresa não usar escala horária
- O módulo de integração for diferente do CP, BS ou PLR
- Alterar o horário base
Caso contrário, não informar

Máscara:
DD/MM/AAAA
nivSalHsa Opcional String Informar o nível salarial
- Obrigatório se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL
- Se o código da estrutura salarial for diferente de 0
matAnt Opcional String Matrícula Origem:

Informar a matrícula anterior. Obrigatório* quando:
- Tipo Admissão eSocial for 2, 3 ou 4;
- Categoria do trabalhador for igual a 410;
- Valor do campo Categoria eSocial Origem for 101, 102, 103, 104, 105 ou 106.
Caso contrário, não informar

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* A obrigatoriedade só será aplicada se já estiver utilizando eSocial.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
tipOpc Opcional String Informar se é optante do FGTS
* Informar somente se o módulo de integração for o Administração de Pessoal

Valores:
S - Para optante
N - Para não optante

Valor padrão:
S
digBan Opcional String Informar o dígito da conta bancária informada.
* Não informar se:
- Utilizar histórico de contas bancárias
- O módulo de integração for diferente do AP, BS ou PLR
insCur Opcional Integer Informar o código do tipo de instrutor do curso.
* Somente informar se integrar com o módulo TR

Valor Padrão:
0
datNas Opcional DateTime Informar a data de nascimento do colaborador

Máscara:
DD/MM/AAAA
codBhrHsi Opcional Integer Informar o código do banco de horas

Somente informado quando o campo Utiliza banco estiver definido como "2 - Pelo histórico do Sindicato".

Disponível apenas se o cliente possuir o módulo CP na Proprietária.
codDoeAfa Opcional String CID (Classificação Internacional de Doença)

23 - Acidente Trabalho 15 dias

Este parâmetro somente poderá ser informado para situações com tipos iguais a:
3 - Auxílio-doença,
6 - Licença Maternidade,
14 - Auxílio-doença 15 dias,
19 - Auxílio Maternidade.

Disponível em todos os módulos
horSabHor Opcional Integer Informar a código do horário de sábado
- Obrigatório se:
- A empresa não usar escala horária
- O módulo de integração for diferente do CP, BS ou PLR
- Alterar o horário base ou incluir um colaborador
Nunca informar se:
- A empresa usar escala horária
- O módulo de integração for CP, BS ou PLR
valSalHsa Opcional Double Informar o valor do salário
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL

Máscara:
ZZZZZZZZ9,99
onuSce Opcional Integer Ônus:

Informar ônus da cessão
- Obrigatório* se Tipo Admissão eSocial for 410
Caso contrário, não informar

* A obrigatoriedade só será aplicada quando integrado com o módulo Administração de Pessoal.
* A obrigatoriedade só será aplicada se já estiver utilizando eSocial.
* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.

Valores:
1 - Cedente
2 - Cessionário
3 - Cedente e Cessionário
datOpc Opcional DateTime Informar a data de opção pelo FGTS.
* Informar somente se:
- O módulo de integração for o Administração de Pessoal
- O parâmetro TipOpc for igual a 'S'

Máscara
DD/MM/AAAA
perPag Opcional String Definir o período de pagamento

Valores:
M - Mensal
S - Semanal
Q - Quinzenal
reaRes Opcional String Informar se deseja efetuar reserva de refeitório ou não
- Obrigatório se:
- Se assinalamento "Tela Efetua Reserva" estiver assinalado.

Caso contrário, não informar

Valores:
S - Sim
N - Não
codPro Opcional String Informar o número do processo quando colaborador for menor de 14 anos
cauDemAfa Opcional Integer Informar a causa da demissão
- Obrigatório se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
- O tipo de situação for (7) demissão
Caso contrário, não informar
horSemHor Opcional Time Informar as horas semanais
- Obrigatório se:
- A empresa não usar escala horária
- O módulo de integração for diferente do CP, BS ou PLR
- Na alteração, se o horário base estiver zerado
Caso contrário, não informar

Máscara:
HH:MM
cplSalHsa Opcional Double Informar o complemento do salário
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL

Máscara:
ZZZZZZZZ9,99
resOnu Opcional String Ressarcimento Ônus
Informar se há ressarcimento do ônus.
Não deve ser informado caso Ônus for igual a 2.
Valores: S - Sim N - Não

* Esse parâmetro só deve ser informando quando a categoria do eSocial do colaborador for: 101, 102, 103, 104, 105, 106, 107, 108, 111, 301, 302, 303, 306, 307, 309, 401, 410 ou 997.
conFgt Opcional Double Informar o número da conta do FGTS do colaborador, junto a CEF.
* Informar somente se:
- O módulo de integração for o Administração de Pessoal
- O parâmetro TipOpc for igual a 'S'
tipApo Opcional Integer Informar o tipo de aposentadoria do colaborador:
* Somente informar se integrar com o Administração de Pessoal

Valores:
1 - Tempo Serviço
2 - Tempo Serviço Proporcional
3 - Idade
4 - Invalidez
5 - Invalidez Acidente Trabalho
6 - Invalidez Doença Profissional
7 - Compulsória
8 - Especial

Valor Padrão: 0
codNac Opcional Integer Informar o código da nacionalidade, de acordo com a codificação utilizada para a Rais.
* Não informar se o módulo de integração for o CP ou PLR ou BS ou JR.
conTovAfa Opcional String Informar se considera o turn-over.
- Obrigatório se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
- A empresa utilizar turn-over e a situação for demissão
Caso contrário, não informar

Valores:
S - Sim
N - Não
horDsrHor Opcional Time Informar as horas DSR
- Obrigatório se:
- A empresa não usar escala horária
- O módulo de integração for diferente do CP, BS ou PLR
- Na alteração, se o horário base estiver zerado
Caso contrário, não informar

Máscara:
HH:MM
moeEstHsa Opcional Integer Informar o código do índice do salário
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL
- Se for versão internacional e se o país ativo for o Peru
perJur Opcional Integer Informar percentual de juros do FGTS. Este dado será utilizado quando a empresa deseja acompanhar o saldo do FGTS do colaborador ou para cálculos em atraso, onde os coeficientes são diferenciados para percentual de juros Para optantes após 1971 a informação válida é 3, se a opção for anterior poderá ou não ser 6, dependendo de ter sido retroativa após 1971. Zeros é igual a 3.
* Informar somente se:
- O módulo de integração for o Administração de Pessoal
- O parâmetro TipOpc for igual a 'S'
datApo Opcional DateTime Informar a data da aposentadoria
* Somente informar se integrar com o Administração de Pessoal e o parâmetro TipApo diferente do 0

Máscara
DD/MM/AAAA
diaJusAfa Opcional Integer Informar dias justificados
* Somente informar se:
- O tipo de situação for 3 ou 4
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
salEstHsa Opcional Double Informar o salário em moeda estrangeira
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL
- Se for versão internacional e se o país ativo for o Peru

Máscara:
ZZZZZZZZ9,99
irrIse Opcional String Informar se o colaborador aposentado tem seus rendimentos isentos (S) ou não (N). Esta informação influencia na geração do Informe e DIRF
* Somente informar se o parâmetro TipApo for 4, 5 ou 6

Valores
S - Sim
N - Não
qhrAfaAfa Opcional Integer Informar a quantidade de horas da falta
* Somente informar se:
- O tipo de situação for 15 (Faltas).
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa

Máscara:
HH:MM
cplEstHsa Opcional Double Informar o complemento do salário em moeda estrangeira
* Somente informar se:
- Incluir um novo colaborador
- Se o módulo for: AP, CS ou QL
- Se for versão internacional e se o país ativo for o Peru

Máscara:
ZZZZZZZZ9,99
movSef Opcional String Informar o código de movimentação da Sefip
* Somente informar se integrar com o Administração de Pessoal
datTerAfa Opcional DateTime Informar a data de término do afastamento
* Somente informar se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
- Se o tipo da situação for diferente de 7 (Demissão)

Máscara:
DD/MM/AAAA
recAdi Opcional String Informar se recebe adiantamento salarial
- Obrigatório se:
- Integrar com o Administração de Pessoal
* Na alteração é opcional
Caso contrário, não informar

Valores
S - Sim
N - Não
horTerAfa Opcional Time Informar a hora de término do afastamento
* Somente informar se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
- Se o tipo da situação for diferente de 7 (Demissão)

Máscara:
HH:MM
rec13S Opcional String Informar se recebe 13º Salário
- Obrigatório se:
- Integrar com o Administração de Pessoal, versão Nacional
* Na alteração é opcional
Caso contrário, não informar

Valores
S - Sim
N - Não
prvTerAfa Opcional DateTime Informar a data de previsão do término do afastamento
* Somente informar se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
- Se o tipo da situação for diferente de 7 (Demissão) ou 15 (Faltas)

Máscara:
DD/MM/AAAA
lisRai Opcional String Informar se consta da RAIS

Valores
S - Quando deve ser informado na Rais
N - Para não constar da Rais
exmRetAfa Opcional String Informar se tem exame de retorno
* Somente informar se:
- O tipo de situação for quaisquer um dos seguintes:
3, 4, 5, 6, 8, 10, 13, 14, 19 ou 23
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa

Valores:
S - Sim
N - Não
emiCar Opcional String Informar se deve emitir etiqueta ou cartão ponto para este colaborador
- Obrigatório se:
- Integrar com o Administração de Pessoal ou Controle de Ponto e Refeitório
* Na alteração é opcional
Caso contrário, não informar

Valores
S - Imprimir cartão ponto para este colaborador.
N - Não imprimir cartão ponto para este colaborador
obsAfaAfa Opcional String Informar a observação do afastamento
* Somente informar se:
- Na inclusão, se o valor for diferente de 1
- Na alteração, se mudar o valor de SitAfa
codCha Opcional String Informar o mesmo número que foi indicado para o cartão ponto, para o quadro ponto da chapeira.
* Somente informar se integrar com o Administração de Pessoal
manCgcAfa Opcional String  
defFis Opcional String Informa se o colaborador é uma pessoa com deficiência
* Somente informar se integrar com os módulos BS, QL, RS, AP, TR ou SM

Valores
S - Sim
N - Não
manRemAfa Opcional String  
codDef Opcional Integer Informa o código da deficiência do colaborador
* Somente informar se
- Integrar com os módulos BS, QL, RS, AP, TR ou SM
- O colaborador possui deficiência física
atePatAfa Opcional String

Atestado Sem Incidência INSS

Informar quando tipo da situação for 14 ou 23, ou se for 3 ou 4 e tiver dias justificados informado.

Valores:
S - Sim
N - Não
benRea Opcional String Informar se o colaborador encontra-se reabilitado ou não para o trabalho
* Somente informar se integrar com os módulos BS, QL, RS, AP, TR ou SM

Valores
S - Sim
N - Não
cotDef Opcional String Informe se o colaborador preenche a cota de pessoas com deficiência habilitadas ou de beneficiários reabilitados.

Valores:
S - Sim
N - Não
racCor

Obrigatório

 Integer Código da raça/etnia da tela de cadastro de raça/etnia.
* Somente informar se integrar com o AP ou TR.
ratEve Opcional String Informar se o colaborador entra no cálculo de rateio do eventos
* Somente informar se:
- A empresa utilizar rateio de eventos
- Integrar com os módulos AP ou QL

Valores:
S Sim;
N Não.

Valor Padrão:
S
catSef Opcional Integer Informar a categoria do colaborador no SEFIP
- Obrigatório se:
- Os tipos de contrato forem 1, 2, 4, 6, 7, 10 e 11 (Opcional para outros tipos)
- Integrar com o módulo Administração de Pessoal
Caso contrário, não informar

Valores:
01 - Empregado;
02 - Trabalhador avulso;
03 - Trabalhador não vinculado ao RGPS, mas com direito ao FGTS;
04 - Empregado sob contrato de trabalho por prazo determinado (Lei n* 9.601/98);
05 - Contribuinte Individual - Diretor não empregado com FGTS (Lei nº 8.036/90, art. 16);
06 - Empregado Doméstico;
07 - Menor Aprendiz ( Lei 10.097/2000);
11 - Contribuinte Individual - Diretor não empregado e demais empresários sem FGTS;
12 - Demais Agentes Públicos;
13 - Contribuinte Individual - Trabalhador autônomo ou a este equiparado, inclusive o operador de máquina com contribuição sobre remuneração;
14 - Contribuinte Individual - Trabalhador autônomo ou a este equiparado, inclusive o operador de máquina com contribuição sobre salário-base;
15 - Contribuinte Individual - Transportador autônomo com contribuição sobre remuneração;
16 - Contribuinte Individual - Transportador autônomo com contribuição sobre salário-base;
17 - Contribuinte Individual - Cooperado que presta serviços a empresas contratantes de Cooperativa de Trabalho;
18 - Contribuinte Individual - Transportador Cooperado que presta serviços a empresas contratantes de Cooperativa de Trabalho;
19 - Agente Político;
20 - Servidor Público Ocupante, exclusivamente, de cargo em comissão; Servidor Público Ocupante de cargo temporário ;
21 - Servidor Público titular de cargo efetivo, magistrado, membro do Ministério Público e do Tribunal e Conselho de Contas.
datAltHcs Opcional DateTime Informar a data de alteração da Categoria Sefip
- Obrigatório se :
- Na alteração, mudar o código da categoria Sefip
Caso contrário, não informar

Máscara:
DD/MM/AAAA
datInc Opcional DateTime Informar a data de inclusão para fins de informação na ficha registro, de acordo com a IN 68
* Somente informar se integrar com o módulo Administração de Pessoal

Máscara:
DD/MM/AAAA

Valor Padrão:
Data da integração
horInc Opcional Time Informar a hora da inclusão para fins de informação na ficha registro, de acordo com a IN 68
* Somente informar se integrar com o módulo Administração de Pessoal

Máscara:
DD/MM/AAAA

Valor Padrão:
Hora da integração
recGra Opcional String Informar se recebe gratificação
* Somente informar para o Administração de Pessoal Versão Internacional
docEst Opcional String Informar o código de documento estrangeiro
* Somente informar no Administração de Pessoal versão Internacional

Valores:
4 - Cédula de Estrangeria
5 - PasaPorte
99 - Otros

Valor Padrão: 0
codIdn Opcional String Informar o código de identificação
* Somente informar no Administração de Pessoal versão Internacional
sisCes Opcional Integer Informar o tipo do sistema cesantia
* Somente informar se for o Administração de Pessoal versão Internacional e país ativo igual a Colômbia

Valores:
1 - Sistema Tradicional
2 - Sistema Anual
3 - Salário Integral
9 - Não Filiado
opcCes Opcional DateTime Informar a data de opção pelo sistema cesantia
* Somente informar se for o Administração de Pessoal versão Internacional e país ativo igual a Colômbia

Máscara:
DD/MM/AAAA

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:FichaBasicaResponse>
      <result>
        <numEmp>Integer</numEmp>
        <numCad>Integer</numCad>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:FichaBasicaResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Número da empresa.
numCad Obrigatório Integer Número do cadastro.
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.

 

IndicacaoModulos

Web service de integração que permite realizar manutenção na guia Indicação Módulos da Ficha Básica.

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:IndicacaoModulos>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <numCad>Integer</numCad>
        <indicacaoModulos>
          <codMod>String</codMod>
          <modSel>String</modSel>
        </indicacaoModulos>
      </parameters>
    </ser:IndicacaoModulos>
  </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.
- Obrigatório
- Chave
numCad Obrigatório Integer Indicar um número de cadastro para identificar cada colaborador.
- Obrigatório
- Chave
indicacaoModulos Opcional Set Lista de módulos a assinalar

Módulo: Nome do módulo por extenso (exemplo: Benefícios)
Considera: 0 - Não Considera e 1 - Considera
indicacaoModulos.codMod Obrigatório String

Informar a descrição do Módulo
- Chave

- Administração de Pessoal;
- Benefícios;
- Captura Ponto Portaria 373;
- Cargos e Salários;
- Gestão do Ponto;
- Integrador SST;
- Jurídico;
- Marcação Ponto Mobilidade;
- Medicina;
- Orçamento;
- PLR;
- Painel de Gestão;
- Pesquisa;
- Quadro de Vagas;
- Recrutamento;
- Segurança;
- Tarefeiros;
- Treinamento.

Atenção

O módulo Captura Ponto Portaria 373 foi descontinuado e a indicação do colaborador para esse módulo não se refletirá em uso. O sistema permanece na proprietária com Captura Ponto Portaria 373 apenas para emissão de arquivos fiscais das marcações coletadas antes da descontinuação do módulo.
indicacaoModulos.modSel Obrigatório String Definir se o empregado será considerado ou não nas rotinas dos módulos
- Obrigatório

Valores
0 - Não
1 - Sim

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

Ponto

Web service de integração que permite realizar manutenção na guia Ponto da Ficha Básica.

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:Ponto>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <datIni>DateTime</datIni>
        <numCad>Integer</numCad>
        <horIni>Time</horIni>
        <eliMar>Integer</eliMar>
        <viaCra>Integer</viaCra>
        <numCra>String</numCra>
        <datFim>DateTime</datFim>
        <horFim>Time</horFim>
      </parameters>
    </ser:Ponto>
  </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.
- Obrigatório
- Chave
datIni Opcional DateTime Data a partir da qual esta pessoa irá realizar marcações com o crachá informado.
- Obrigatório na alteração, opcional na inclusão

Máscara
DD/MM/AAAA
numCad Obrigatório Integer Indicar um número de cadastro para identificar cada colaborador.
- Obrigatório
- Chave
horIni Opcional Time Hora a partir da qual o crachá será utilizado na data inicial.
- Opcional

Máscara:
HH:MM
eliMar Obrigatório Integer Indicar se marcações realizadas por este colaborador devem ser eliminadas em alguns casos ou não:
- Obrigatório

Valores:
1- Não elimina marcações.
2- Elimina intermediárias em dias normais, folga e nas extras .
3 - Elimina intermediárias em dias de folga e nas extras .
4 - Elimina as marcações ímpares intermediárias em dias de folga .
5 - Elimina intermediárias ignorando o intervalo de refeição .
6 - Elimina Marcações de Ponto + Refeitório na Folga
7 - Elimina Intermediárias Ignorando Intervalos de Refeição em Dias Normais
viaCra Opcional Integer Número da via do crachá
- Opcional
numCra Opcional String Informe o número do crachá do colaborador, com até 12 posições numéricas, conforme definição do campo Máscara Crachá, presente na opção Coletores / Definições do Crachá / Layout.
- Opcional
datFim Opcional DateTime Data de término do uso deste crachá.
- Opcional

Máscara
DD/MM/AAAA
horFim Opcional Time Hora a partir da qual o crachá não será mais utilizado dentro da data final.
- Opcional

Máscara:
HH:MM

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

Estrangeiro_2

Web service de integração que permite realizar manutenção na guia Estrangeiro da Ficha Básica.

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:Estrangeiro>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <tipCol>Integer</tipCol>
        <numCad>Integer</numCad>
        <datChe>DateTime</datChe>
        <visEst>Integer</visEst>
        <regEst>String</regEst>
        <emiEst>String</emiEst>
        <datEst>DateTime</datEst>
        <dvlEst>DateTime</dvlEst>
        <dvlCtp>DateTime</dvlCtp>
        <casBra>String</casBra>
        <filCbr>String</filCbr>
        <numPor>String</numPor>
        <datPor>DateTime</datPor>
	 <tmpRes>Integer</tmpRes>
	 <datTer>DateTime</datTer>	
      </parameters>
    </ser:Estrangeiro>
  </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
tipCol Obrigatório Integer Tipo do Estrangeiro (2-Terceiros, 3-Parceiros).
- Chave
numCad Obrigatório Integer Indicar um número de cadastro para identificar cada colaborador.
- Chave
datChe Opcional DateTime Informar a data de chegada do estrangeiro
- Máscara: DD/MM/YYYY
visEst Opcional Integer Informar o tipo de visto.
- Opcional

Valores:
1 - Visto permanente
2 - Visto temporário
3 - Asilado
4 - Refugiado
5 - Solicitante de Refúgio
6 - Residente fora do Brasil
7 - Deficiente físico e com mais de 51 anos
8 - Com residência provisória e anistiado, em situação irregular
9 - Permancência no Brasil em razão de filhos e cônjuge brasileiro
10 - Beneficiado pelo acordo entre países do Mercosul
11 - Dependente de agente diplomático e/ou consular de países que mantém convênio de reciprocidade para exercícios de atividade remunerada no Brasil
12 - Beneficiado pelo Tratado de Amizade, Cooperação e Consulta entre a República Federativa do Brasil e a República Portuguesa
regEst Opcional String Informar o registro do estrangeiro.
emiEst Opcional String Órgão Emissor Reg. Estrangeiro
datEst Opcional DateTime Data Expedição Reg. Estrangeiro

Máscara:
DD/MM/AAAA
dvlEst Opcional DateTime Validade do Visto

Máscara:
DD/MM/AAAA
dvlCtp Opcional DateTime Data Validade CTPS

Máscara:
DD/MM/AAAA
casBra Opcional String Casado com Brasileiro.
Opções:
S - Sim
N - Não
filCbr Opcional String

Filhos Brasileiros.
Opções:
S - Sim
N - Não
numPor Opcional String Informar o número da portaria de naturalização do estrangeiro.
- Opcional
datPor Opcional DateTime Informar a data da portaria de naturalização do estrangeiro.
- Opcional

Máscara:
DD/MM/AAAA
tmpRes Opcional Integer Tempo de residência do trabalhador imigrante.
Opções:
1 - Prazo indeterminado
2 - Prazo determinado
datTer Opcional DateTime Data de término de residência do trabalhador.
Máscara: DD/MM/AAAA

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

ContaBancaria

Web service de integração que permite realizar manutenção na guia Contas Bancárias da Ficha Básica.

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:ContaBancaria>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <numCad>Integer</numCad>
        <contasBancarias>
          <tipOpe>String</tipOpe>
          <codBan>Integer</codBan>
          <codAge>Integer</codAge>
          <tipBan>Integer</tipBan>
          <conBan>Double</conBan>
          <digBan>String</digBan>
          <perCon>Double</perCon>
        </contasBancarias>
        <datAlt>DateTime</datAlt>
      </parameters>
    </ser:ContaBancaria>
  </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.
- Obrigatório
- Chave
- Máscara: 9999
numCad Obrigatório Integer Código do Colaborador.
- Obrigatório
- Chave
- Máscara: 999999999
contasBancarias Opcional Set Lista de bancos do histórico.
Obs.: A soma dos percentuais da lista informada deve ser igual a 100.
contasBancarias.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".
contasBancarias.codBan Obrigatório Integer Código do banco.
- Obrigatório
- Chave
- Máscara: 9999
contasBancarias.codAge Obrigatório Integer Código da agência.
- Obrigatório
- Chave
- Máscara: 99999
contasBancarias.tipBan Obrigatório Integer Tipo de conta bancária.
- Obrigatório
- Máscara: 9
- Valores:
1 - Conta Corrente
2 - Conta Poupança
3 - Conta Salário
9 - Outros
contasBancarias.conBan Obrigatório Double Número da conta:
- Obrigatório
- Chave
- Máscara: 9[12]
contasBancarias.digBan Opcional String Dígito da conta.
- Opcional
- Máscara: AA
contasBancarias.perCon Obrigatório Double Percentual rateado para este banco.
- Obrigatório
- Máscara: ZZ9,99
- Obs.: A soma dos percentuais no históricos resultar no valor de 100%.
datAlt Obrigatório DateTime Data da alteração do histórico.
- Obrigatório
- Chave
- Máscara: DD/MM/YYYY

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

Deficiencias

Web service de integração que permite realizar manutenção na guia Deficiências da Ficha Básica.

Necessita autenticação: Sim.

Situação da versão: Atual.

Versão: 1.

Requisição:

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:Deficiencias>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <deficiencias>
          <tipOpe>String</tipOpe>
          <defPri>String</defPri>
          <datDef>String</datDef>
          <codDef>Integer</codDef>
          <obsDef>String</obsDef>
        </deficiencias>
        <numCad>Integer</numCad>
      </parameters>
    </ser:Deficiencias>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Número da empresa.
deficiencias Opcional Set Informações da deficiência.
deficiencias.tipOpe Obrigatório String Tipo de Operação.
deficiencias.defPri Opcional String Deficiência principal.
deficiencias.datDef Opcional String Data início da deficiência.
deficiencias.codDef Obrigatório Integer Código da deficiência.
deficiencias.obsDef Opcional String Observações.
numCad Obrigatório Integer Cadastro do colaborador.

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

ChavePix

Permite realizar manutenção da guia Pix da Ficha Básica.

Necessita autenticação: Sim

Situação de versão: Atual

Versão: 1

Requisição: 

<soapenv:Envelope xmlns:ser="http://services.senior.com.br" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ser:ChavePix>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <numCad>Integer</numCad>
        <chavePix>
          <tipOpe>String</tipOpe>
          <tpcPix>Integer</tpcPix>
          <chvPix>String</chvPix>
          <perCon>Double</perCon>
        </chavePix>
        <datAlt>DateTime</datAlt>
      </parameters>
    </ser:ChavePix>
  </soapenv:Body>
</soapenv:Envelope>
Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Código da empresa ativa.
Máscara: 9\[4]
numCad Obrigatório Integer Código do colaborador.
Máscara: 9\[9]
chavePix Opcional Set  
ChavePix.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".
ChavePix.TpcPix Obrigatório Integer Informar o tipo da chave Pix.
Máscara: 9[2]

Valores:
01 - Telefone
02 - E-mail
03 - CPF/CNPJ
04 - Chave Aleatória
05 - Conta Bancária
ChavePix.ChvPix Opcional String Chave Pix.

Quando a chave for do tipo "5 - Conta Bancária" não será possível informar este parâmetro. O sistema irá considerar os dados informados na porta Conta Bancária.

Quando o tipo de chave Pix for "3 - CPF/CNPJ", se o parâmetro não for informado, o sistema irá automaticamente preencher com o CPF (numCpf).


Máscara: A[100]
ChavePix.PerCon Obrigatório Double Percentual da Chave.
Máscara: 9[3]
datAlt Obrigatório DateTime Data do Histórico.
Máscara: DD/MM/AAAA

Resposta: 

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

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.

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

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).

Ver site completo