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

Tipo de execução

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

Autenticação

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

WSDL

Porta

Escalonar

Enviar

Escalonar

Web service utilizado para realização do escalonamento do envio da declaração mensal ao eSocial.

**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:Escalonar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<paramns>
<nome>String</nome>
<valor>String</valor>
</paramns>
</parameters>
</ser:Escalonar>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

paramns

Obrigatório

Set

Abaixo estão os campos permitidos para o processamento do web service.

Observação

: os campos

empati

competetencia

tipoFolha

tipoenviofolha

leiautes

devem ser informados para o correto processamento deste web service.

Nome	Preenchimento	Tipo	Descrição
empati	Obrigatório	Integer	Código da empresa ativa que será utilizado no processo. Máscara: 9999
competetencia	Obrigatório	String	Competência para escalonamento do envio da declaração mensal. Máscara YYYY-MM-DD
tipoFolha	Obrigatório	Integer	Tipo da folha para escalonamento do envio da declaração mensal: 1 - Mensal 2 - 13º Salário 3 - 13º Salário + 13º complementar a devolver
tipoenviofolha	Obrigatório	Integer	Tipo do envio para escalonamento do envio da declaração mensal: 1 – Normal: faz um envio ou somente envia que houve alteração 2 – Total: reenvia todos os colaboradores sem verificar se houve alteração
leiautes	Obrigatório	String	Leiautes a serem considerados no escalonamento do envio da declaração mensal, separados por vírgula. Permitidos: S-1200, S-1202, S-1207, S-1210, S-1260, S-1270 e S-1280.
abr.filiaisEmpregadoras	Opcional	String	Filial empregadora (+). Máscara: A[200]
abr.lote	Opcional	String	Abrangência: Código de lote de colaboradores. Máscara: 9999
abr.tiposColaboradores	Opcional	String	Abrangência: Tipo de Colaborador (+). Máscara: A[100]
abr.cadastros	Opcional	String	Abrangência: Colaborador (+). Máscara: A[200]
abr.filiais	Opcional	String	Abrangência: Filial (+). Máscara: A[200]
abr.locais	Opcional	String	Abrangência: Local (”+”). Máscara: A[200]
abr.centrosDeCustos	Opcional	String	Abrangência: C. Custo (”+”). Máscara: A[200]
abr.vinculos	Opcional	String	Abrangência: Vínculo (+). Máscara: A[100]
abr.cargos	Opcional	String	Abrangência: Cargo (”+”). Máscara: A[200]
abr.categoriasESocial	Opcional	String	Abrangência: Local (”+”). Máscara: A[200]

paramns.Nome

Opcional

String

Nome do campo.

paramns.Valor

Opcional

String

Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação:

Data: DD/MM/YYYY ou MM/YYYY.
- Números com decimais: 9.99.

Resposta:

Nota

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

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

Atributos da resposta:

Nome	Preenchimento	Tipo	Descrição
erroExecucao	Opcional	String	Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores: Vazio ou nulo, indicando que a execução foi feita com sucesso; A mensagem do erro ocorrido no servidor.

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.

Enviar

Web service utilizado para realização do envio da declaração mensal ao eSocial.

**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:Enviar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<paramns>
<nome>String</nome>
<valor>String</valor>
</paramns>
</parameters>
</ser:Enviar>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

paramns

Obrigatório

Set

Abaixo estão os campos necessários para o processamento do web service.

Observação

: todos os campos devem ser informados para que o web service possa ser processado corretamente.

Nome	Preenchimento	Tipo	Descrição
empati	Obrigatório	Integer	Código da empresa ativa que será utilizado no processo. Máscara: 9999
competetencia	Obrigatório	String	Competência para escalonamento do envio da declaração mensal. Máscara YYYY-MM-DD
tipoFolha	Obrigatório	Integer	Tipo da folha para escalonamento do envio da declaração mensal: 1 - Mensal 2 - 13º Salário 3 - 13º Salário + 13º complementar a devolver
tipoenviofolha	Obrigatório	Integer	Tipo do envio para escalonamento do envio da declaração mensal: 1 – Normal: faz um envio ou somente envia que houve alteração 2 – Total: reenvia todos os colaboradores sem verificar se houve alteração
leiautes	Obrigatório	String	Leiautes a serem considerados no escalonamento do envio da declaração mensal, separados por vírgula. Permitidos: S-1200, S-1202, S-1207, S-1210, S-1260, S-1270 e S-1280.
cpfs	Obrigatório	String	Lista de CPFS (separados por vírgula) a serem processados.

paramns.Nome

Opcional

String

Nome do campo.

paramns.Valor

Opcional

String

Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação:

Data: DD/MM/YYYY ou MM/YYYY.
- Números com decimais: 9.99.

Resposta:

Nota

<soapenv:Envelope xmlns:ser=“http://services.senior.com.br” xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/”>
<soapenv:Body>
<ser:EnviarResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:EnviarResponse>
</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.

Nome

Preenchimento

Tipo

Descrição

erroExecucao

Opcional

String

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

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

A mensagem do erro ocorrido no servidor.

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