Web service com.senior.g5.rh.bs.historicos
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.
WSDL
- Síncrono: http://example.com/g5-senior-services/bs_Synccom_senior_g5_rh_bs_historicos?wsdl
- Assíncrono: http://example.com/g5-senior-services/bs_Asynccom_senior_g5_rh_bs_historicos?wsdl
- Agendado: http://example.com/g5-senior-services/bs_Scheduledcom_senior_g5_rh_bs_historicos?wsdl
Portas
- Afastamento_4
- Cargo_2
- Local
- Escala
- Filial_4
- Posto_4
- PostoAdicional_2
- DocumentosAfastamento
- Sindicato
- Vinculo
- Anotacao
- ValeTransporte_2
- Horario
- Salario_2
Afastamento_4
Através deste web service, nos é permitido informar os afastamentos dos colaboradores.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 4
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Afastamento> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAfa>DateTime</datAfa> <horAfa>Time</horAfa> <sitAfa>Integer</sitAfa> <datPar>DateTime</datPar> <datAlt>DateTime</datAlt> <cauDem>Integer</cauDem> <codSub>String</codSub> <risNex>String</risNex> <datPer>DateTime</datPer> <datNex>Time</datNex> <sitIni>Integer</sitIni> <codAte>Integer</codAte> <nomAte>String</nomAte> <orgCla>Integer</orgCla> <regCon>String</regCon> <estCon>String</estCon> <codDoe>String</codDoe> <conTov>String</conTov> <diaJus>Integer</diaJus> <diaPrv>Integer</diaPrv> <qhrAfa>Time</qhrAfa> <cgcSuc>String</cgcSuc> <datTer>DateTime</datTer> <horTer>Time</horTer> <prvTer>DateTime</prvTer> <exmRet>String</exmRet> <motRai>Integer</motRai> <obsAfa>String</obsAfa> <codOem>Integer</codOem> <nroAut>String</nroAut> <aciTra>Integer</aciTra> <tipOpe>String</tipOpe> <oriMot>String</oriMot> <numPro>String</numPro> <msmMot>String</msmMot> </parameters> </ser:Afastamento> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
numEmp | Opcional | Integer | Código da empresa que será utilizado na integração |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Chave |
datAfa | Obrigatório | DateTime | Data inicial do afastamento do colaborador
- Chave - Máscara: DD/MM/YYYY |
horAfa | Opcional | Time | Hora inicial do afastamento
- Máscara: HH:MM |
sitAfa | Obrigatório | Integer | Informe a situação de afastamento, férias ou demissão.
Caso a situação seja do tipo - 03 (Auxílio-doença) ou - 04 (Acidente de Trabalho) e for informada uma quantidade de dias no campo Dias Licença Médica, estes serão calculados na situação com tipo 14 (Licença Médica) de menor código na tabela de situações. |
datPar | Opcional | DateTime | Data de término do afastamento
- Máscara: DD/MM/YYYY Quando o tipo da situação for "7 - Demitido" este parâmetro não poderá ser informado. |
datAlt | Opcional | DateTime | Data de alteração da situação do afastamento - Máscara: DD/MM/YYYY' Esse campo somente pode ser informado quando for alterado a situação de acordo com os seguintes cenários: - De 04 (Acidente Trabalho) para 03 (Auxílio-doença); - De 04 (Acidente Trabalho) para 22 (Aposentadoria); - De 03 (Auxílio-doença) para 04 (Acidente de Trabalho); - De 03 (Auxílio-doença) para 22 (Aposentadoria). |
cauDem | Opcional | Integer | Código da causa da demissão
Este parâmetro somente poderá ser informado quando o tipo da situação for: "7 - Demitido". |
codSub | Opcional | String | Informar o código do subgrupo de doenças que resultou no afastamento do colaborador.
Se este código estiver relacionado ao CNAE da filial do colaborador conforme consta na tabela de CIDs por CNAE em Tabelas/Gerais, será emitido uma mensagem de alerta, sugerindo para o próximo campo 'Risco Anexo' = Sim. Exemplo: A filial do colaborador possui o CNAE fiscal 1749 = Fabricação de outros artefatos têxteis, incluindo tecelagem. O afastamento ocorreu em decorrência do subgrupo da CID M75 = Lesões do ombro. Este campo ficará disponível se na tela de assinalamentos diversos o campo 'Controla Nexo Epidemiológico' estiver com Sim. Utilizado nos módulos: AP e SM |
risNex | Opcional | String | Informe o Risco Nexo:
Valores: S - Informar Sim quando este afastamento corre o risco de ser considerado no Nexo Técnico Epidemiológico (NTEP). Se o código do subgrupo da doença(CID) estiver relacionado com o CNAE da filial do colaborador, o sistema irá sugerir 'S'; N - Informar Não quando não existe a possibilidade da doença vir a ser considerada no nexo epidemiológico. Este campo ficará disponível se na tela de assinalamentos diversos o campo 'Controla Nexo Epidemiológico' estiver com Sim. Utilizado nos módulos: AP e SM |
datPer | Opcional | DateTime | Informar em que data ocorreu a decisão da perícia que avalia se o afastamento será ou não considerado no Nexo Epidemiológico.
Este campo ficará disponível se na tela de assinalamentos diversos o campo 'Controla Nexo Epidemiológico' estiver com Sim. Utilizado nos módulos: AP e SM |
datNex | Opcional | Time | Informar a data em que o afastamento por auxílio-doença foi alterado para Acidente de Trabalho. Este campo será preenchido automaticamente quando ocorrer o registro da CAT no sistema.
Exemplo: O colaborador foi afastado em 01/02/2008 pela situação 3-Auxílio-doença, pelo subgrupo da doença M75 que possui relação com o CNAE da filial do colaborador. Em 11/02/2008 foi registrada a CAT com afastamento para este colaborador. A data de início do nexo será 11/02/2008. Utilizado nos módulos: AP e SM |
sitIni | Opcional | Integer | Apresenta a situação inicial de afastamento que originou o Nexo Epidemiológico. Este campo só será habilitado se a data de início do nexo for preenchida.
Utilizado nos módulos: AP e SM |
codAte | 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 |
nomAte | Opcional | String | Nome médico/dentista que emitiu o atestado |
orgCla | Opcional | Integer | Número de inscrição do órgão de classe |
regCon | Opcional | String | Registro no conselho profissional |
estCon | Opcional | String | UF da expedição do órgão de classe do responsável pelos registros ambientais |
codDoe | 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 |
conTov | Opcional | String | Indicar se o afastamento deve ou não ser considerado no Turn-Over.
Valores: S - Sim N - Não Somente deve ser informado quando o tipo da situação for 7 - Demissão. Além disso, deve ser informado somente se o sistema estiver configurado para utilizar Turn-Over. Não deve ser informado no CP quando estiver não estiver integrado com outros módulos do Vetorh. |
diaJus | Opcional | Integer | Quantidade de dias justificados
Pode ser informados para situações do tipo: - 3 (auxílio-doença) - 4 (acidente de trabalho) |
diaPrv | Opcional | Integer | Dias Previsto para o término do afastamento.
- Máscara: 9999 Este parâmetro somente poderá ser informado para situações com tipos diferentes de: 7 - Demitido 15 - Faltas |
qhrAfa | Opcional | Time | Solicitada apenas para programações de faltas.
- Máscara: HHH:MM Somente deve ser informado quando o tipo da situação for 15 - Faltas. Não deve ser informado no CP quando estiver não estiver integrado com outros módulos do Vetorh. |
cgcSuc | Opcional | String | Informar o CNPJ da empresa Sucessora
- Se preenchido, deverá ser um CNPJ válido O campo só estará disponível quando o tipo da situação preenchida for igual a "Demitido" e quando o último histórico eSocial anterior à data de afastamento da causa de demissão for do tipo 11 ou 12 Disponível somente se o módulo estiver integrado com o Administração de Pessoal |
datTer | Opcional | DateTime | Data de término do afastamento
- Máscara: DD/MM/YYYY Quando o tipo da situação for "7 - Demitido" este parâmetro não poderá ser informado. |
horTer | Opcional | Time | Hora de término do afastamento
- Máscara: HH:MM Quando o tipo da situação for "7 - Demitido" este parâmetro não poderá ser informado. |
prvTer | Opcional | DateTime | Data final prevista para o término do afastamento.
- Máscara: DD/MM/YYYY Este parâmetro somente poderá ser informado para situações com tipos diferentes de: 7 - Demitido 15 - Faltas |
exmRet | Opcional | String | Exame de Retorno |
motRai | Opcional | Integer | Código do motivo para Rais
Valores: 10 - Acidente do trabalho típico 20 - Acidente do trabalho de trajeto 30 - Doença relacionada ao trabalho 40 - Doença não relacionada ao trabalho 50 - Licença Maternidade(e Paternidade até 2005) 60 - Serviço militar obrigatório 70 - Licença sem Remuneração/Vencimentos Disponível em todos os módulos, exceto no SM. Disponível quando a situação passada como parâmetro possuir o campo "DesRai" com o valor "S". Não deve ser informado no CP quando estiver não estiver integrado com os módulos SM e FP. Não deverá ser informado quando o tipo da situação for 11 (Licença Paternidade) e a "DataAfa" for maior que 31/12/2005. |
obsAfa | Opcional | String | Espaço para digitar qualquer mensagem relativa ao afastamento.
Disponível em todos os módulos, exceto no QL. |
codOem | Opcional | Integer | Indica o código da previdência (Internacional)
Somente utilizado no módulo FP, versão Internacional, para a Colômbia |
nroAut | Opcional | String | Número da autorização.
Somente utilizado no módulo FP, versão Internacional, para a Colômbia |
aciTra | 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 |
tipOpe | Opcional | String | Tipo da operação a ser efetuada na integração
"I" - Inclusão "A" - Alteração "E" - Exclusão |
oriMot | Opcional | String | Origem do motivo de alteração |
numPro | Opcional | String | Número do processo, em caso de reintegração por determinação judicial |
msmMot | Opcional | String | Indica se o afastamento decorre de mesmo motivo de afastamento anterior |
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:Afastamento_3Response>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:Afastamento_3Response>
</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. |
Cargo_2
Web service usado para efetuar as alterações ou promoções de cargos.
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:Cargo_2> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <codCar>String</codCar> <carVag>String</carVag> <codCrr>Integer</codCrr> <codMot>Integer</codMot> <qtdConf>Integer</qtdConf> <funEso>String</funEso> <tipOpe>String</tipOpe> </parameters> </ser:Cargo_2> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
numEmp | Obrigatório | Integer | Código da empresa que será utilizado na integração
- Obrigatório - Chave |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data de alteração do cargo.
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
codCar | Opcional | String | Código do novo cargo do colaborador, terceiro ou parceiro.
-Obrigatório na inclusão |
carVag | Opcional | String | Código do cargo da vaga do colaborador, terceiro ou parceiro.
Neste campo deve ser informado o cargo que realmente o colaborador irá exercer, ou seja, o cargo para o qual será considerada a vaga. Este parâmetro somente deve ser informado quando a empresa utiliza Cargo da Vaga. No QL, em: Diversos\Assinalamentos, campo Cargo Vaga = 'S'. |
codCrr | Opcional | Integer | Código do carreira
- Opcinal Este campo somente é informado quando o assinalamento "Cargos Diversas Carreiras" for igual a "S". |
codMot | Opcional | Integer | Código do motivo da alteração do cargo.
-Obrigatório na inclusão |
qtdConf | Opcional | Integer | Quantidade de confirmações sobre questionamentos da rotina que devem ser respondidas.
- Opcional Este número irá variar de acordo com os parâmetros passados para a rotina. Para cada nova solicitação será feito um questionamento e, nestes casos, deve-se adicionas uma confirmação para que a rotina consiga prosseguir normalmente. |
funEso | Opcional | String | Este campo indica se o histórico de cargo representa a atuação de uma função do colaborador para o eSocial.
As opções possíveis são: S-Sim N-Não Ele somente deve ser preenchido quando nas Definições do eSocial estiver assinalado para considerar o histórico de cargo como Função do eSocial. |
tipOpe | Opcional | String | Tipo da operação a ser efetuada na integração
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "alteração" |
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:Cargo_2Response>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:Cargo_2Response>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | String |
Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
- Vazio ou nulo, indicando que a execução foi feita com sucesso; - A mensagem do erro ocorrido no servidor. |
Local
Este web service permite alterar o histórico de local de trabalho (organograma) dos colaboradores.
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:Local> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <numLoc>String</numLoc> <conTov>String</conTov> <conTos>String</conTos> <locTra>Integer</locTra> <motAlt>Integer</motAlt> <tipOpe>String</tipOpe> </parameters> </ser:Local> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data de alteração do local
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
numLoc | Obrigatório | String | Código do novo local de trabalho do colaborador.
- Obrigatório |
conTov | Opcional | String | Indica se a troca do local deve ou não ser considerada no turn-over, quando da entrada do colaborador neste local.
- Opcional Valores: S - Sim N - Não Disponível nos módulos: BS, PLR, CP, RS, FP, SM, TR. Somente deverá ser informado quando o sistema estiver configurado para "Considerar Turn-Over". |
conTos | Opcional | String | Indica se a troca do local deve ou não ser considerada no turn-over quando da saída do colaborador deste local.
- Opcional Valores: S - Sim N - Não Disponível nos módulos: BS, PLR, CP, RS, FP, SM, TR. Somente deverá ser informado quando o sistema estiver configurado para "Considerar Turn-Over". |
locTra | Opcional | Integer | Código da cidade em que o colaborador efetivamente exerce sua função.
- Opcional Disponível somente no módulo FP. |
motAlt | Opcional | Integer | Código do motivo da alteração de local.
- Opcional |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "alteração" |
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:LocalResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:LocalResponse>
</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. |
Escala
Este web service é usado para registrar um histórico de escala, à qual todos os colaboradores estão associados, sejam administrativos, de revezamento, de rodízio, de produção ou outros.
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:Escala> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <codEsc>Integer</codEsc> <codTma>Integer</codTma> <turInt>Integer</turInt> <codEqp>Integer</codEqp> <codCat>Integer</codCat> <tipOpe>String</tipOpe> <desSim>String</desSim> </parameters> </ser:Escala> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data da alteração do histórico de escala
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
codEsc | Obrigatório | Integer | Código da nova escala do colaborador
- Obrigatório |
codTma | Opcional | Integer | Código da turma da escala do colaborador
- Obrigatório Disponível em todos os módulos, exceto no QL e JR Este parâmetro somente deve ser informado se a escala for dos tipos - P - Permanente, ou - B - Busca automática |
turInt | Opcional | Integer | Código da turma de intervalo
- Opcional Disponível nos módulos CP e PLR. |
codEqp | Opcional | Integer | Código da Equipe
- Obrigatório se tipo da escala for do tipo "G" Disponível em todos os módulos que possue histórico de escalas |
codCat | Opcional | Integer | Código da Categoria
- Obrigatório se tipo da escala for do tipo "G" Disponível em todos os módulos que possue histórico de escalas |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "alteração" |
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". |
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:EscalaResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:EscalaResponse>
</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. |
Filial_4
Através deste web service o colaborador pode ser transferido para outra filial, dentro da mesma empresa ou para outra empresa, trocando ou não de código de cadastro.
Quando o web service de histórico de filial é executado com troca de cadastro do colaborador, é necessário preencher os parâmetros da guia Demais históricos.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 4
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Filial> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <novEmp>Integer</novEmp> <novCad>Integer</novCad> <codTap>Integer</codTap> <posTra>String</posTra> <novFil>Integer</novFil> <numLoc>String</numLoc> <codCcu>String</codCcu> <conFin>Integer</conFin> <natDes>Integer</natDes> <tipAdm>Integer</tipAdm> <admeSo>Integer</admeSo> <ficReg>Integer</ficReg> <conTov>String</conTov> <tipOpe>String</tipOpe> <motPos>Integer</motPos> <codCar>String</codCar> <carVag>String</carVag> <codMot>Integer</codMot> <horBas>Integer</horBas> <horSab>Integer</horSab> <horSem>Time</horSem> <horDsr>Time</horDsr> <codEsc>Integer</codEsc> <codTma>Integer</codTma> <turInt>Integer</turInt> <codVin>Integer</codVin> <codMts>Integer</codMts> <tipSal>Integer</tipSal> <codEst>Integer</codEst> <claSal>String</claSal> <nivSal>String</nivSal> <valSal>Double</valSal> <cplSal>Double</cplSal> <codSin>Integer</codSin> <socSin>String</socSin> <numCra>String</numCra> <traBHr>Integer</traBHr> <codBHr>Integer</codBHr> </parameters> </ser:Filial> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador.
- Obrigatório - Chave Valores: "1" - Empregado "2" - Terceiro "3" - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data de transferência para outra filial
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
novEmp | Opcional | Integer | Código da empresa para a qual o colaborador será transferido
- Obrigatório |
novCad | Opcional | Integer | Cadastro do colaborador na nova filial
- Obrigatório |
codTap | Opcional | Integer | Tipo de atuação de destino do colaborador.
Somente deverá ser informado quando houver troca de empresa ou de cadastro, e a empresa de destino utilizar posto de trabalho para o tipo de colaborador que será transferido |
posTra | Opcional | String | Posto de trabalho de destino do colaborador.
Somente deverá ser informado quando houver troca de empresa ou de cadastro, e a empresa de destino utilizar posto de trabalho para o tipo de colaborador que será transferido |
novFil | Opcional | Integer | Filial de destino do colaborador
- Obrigatório |
numLoc | Opcional | String | Código do novo local na nova filial.
- Obrigatório |
codCcu | Opcional | String | Código do centro de custo do colaborador na nova filial.
- Opcional - Máscara: U[18] Disponível nos módulos: BS, CS, JR, PLR, CP, AP |
conFin | Opcional | Integer | Código da conta financeira
- Opcional Disponível somente no módulo Administração de Pessoal. Este parâmetro só pode ser utilizado quando a empresa utilizar contabilização com rateio pelas contas financeiras e quando o parâmetro "CodCcu" for informado. |
natDes | Opcional | Integer | Código da Natureza de Despesa do colaborador na nova filial.
- Opcional Disponível nos módulos: BS, CS, JR, PLR, CP, AP |
tipAdm | Opcional | Integer | Código do tipo da admissão
- Obrigatório Disponível em todos os módulos, exceto no CS e QL. 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) |
admeSo | Opcional | Integer | Tipo de admissão do trabalhador para o eSocial
- Obrigatório Disponível somente no módulo Administração de Pessoal. Valores: 1 - Admissão 2 - Transferência de empresa do mesmo grupo econômico 3 - Admissão por sucessão, incorporação ou fusão 4 - Trabalhador Cedido 9 - Conversão Obs: - A opção 9 é para ser utilizada internamente dentro do sistema, não sendo possível seleciona-la. - Informar somente quando for histórico de admissão ou transferência de empresa. |
ficReg | Opcional | Integer | Número da ficha registro do colaborador
- Opcional Disponível somente nos módulos AP e CP |
conTov | Opcional | String | Considera Turn-Over
- Opcional Valores: S - Sim N - Não Somente deverá ser informado se o sistema estiver configurado para considerar "Turn-Over" |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "alteração" |
motPos | Opcional | Integer | Código do motivo de alteração do posto.
- Obrigatório Somente deverá ser informado se o sistema utiliza posto de trabalho. |
codCar | Opcional | String | Código do novo cargo.
- Obrigatório Será criado automaticamente um novo histórico de cargo com a data da transferência de filial |
carVag | Opcional | String | Cargo no qual o colaborador deveria estar exercendo, ou seja onde deveria ser considerada a vaga.
- Obrigatório Somente deverá ser informado se o sistema utiliza a opção de "Cargo da Vaga". |
codMot | Opcional | Integer | Código do motivo do cargo atual do colaborador.
- Obrigatório Será criado automaticamente um novo histórico de cargo, com o novo motivo, na data da transferência de filial |
horBas | Opcional | Integer | Código do horário base do colaborador
- Opcional Disponível nos módulos AP, RS, SM, TR Deve ser informado somente se o sistema não utiliza escala horária. |
horSab | Opcional | Integer | Código do horário de sábado do colaborador
- Opcional Disponível nos módulos AP, RS, SM, TR Deve ser informado somente se: - o sistema não utiliza escala horária e - se o parâmetro "HorBas" for informado. |
horSem | Opcional | Time | Quantidade de horas semanais
- Opcional - Máscara: HH:MM Disponível nos módulos AP, RS, SM, TR Deve ser informado somente se: - o sistema não utiliza escala horária e - se o parâmetro "HorBas" for informado. |
horDsr | Opcional | Time | Quantidade de horas DSR semanais
- Opcional - Máscara: HH:MM Disponível nos módulos AP, RS, SM, TR Deve ser informado somente se: - o sistema não utiliza escala horária e - se o parâmetro "HorBas" for informado. |
codEsc | Opcional | Integer | Código da nova escala do colaborador
- Opcional Este parâmetro somente deverá ser informado quando a empresa utilizar escala horária. |
codTma | Opcional | Integer | Código da nova turma de escala do colaborador
- Obrigatório Esse parâmetro somente deverá ser informado quando: - a empresa utilizar escala horária e - o parâmetro "CodEsc" for informado e - o tipo da escala for diferente de "D - Definida". |
turInt | Opcional | Integer | Código da nova turma de intervalo do colaborador
Disponível somente no módulo Controle de Ponto e Refeitório. Esse parâmetro somente deverá ser informado quando a empresa utilizar escala horária. |
codVin | Opcional | Integer | Código do novo vínculo do colaborador.
- Opcional Disponível nos módulos: BS, CS, JR, PLR, QL, CP, AP Caso este parâmetro seja informado com o valor 0 "zero", o sistema irá buscar o vínculo do colaborador na data da transferência. |
codMts | Opcional | Integer | Código do motivo da alteração do histórico salarial atual do colaborador.
- Opcional Disponível somente no módulo Administração de Pessoal. Será criado automaticamente um novo histórico salarial, com o novo motivo, na data da transferência de filial. |
tipSal | Opcional | Integer | Código do tipo de salário atual do colaborador.
- Obrigatório Disponível somente no módulo Administração de Pessoal. Somente deve ser informado se o parâmetro "CodMts" também for informado. Valores: 1 - Mensalista 2 - Horista 3 - Diarista 4 - Comissionado 5 - Tarefeiro 6 - Terceiro Será criado automaticamente um novo histórico salarial, com o novo tipo, na data da transferência de filial. |
codEst | Opcional | Integer | Código da nova estrutura salarial.
- Obrigatório Disponível somente no módulo Administração de Pessoal. Será criado automaticamente um novo histórico salarial, com a nova estrutura, na data da transferência de filial. |
claSal | Opcional | String | Código da nova classe salarial.
- Obrigatório Disponível somente no módulo Administração de Pessoal. Somente deverá ser informado se o parâmetro "CodEst" também for informado. Somente deverá ser informado quando o tipo da estrutura salarial for igual a M - Matriz |
nivSal | Opcional | String | Código do novo nível salarial.
- Obrigatório Disponível somente no módulo Administração de Pessoal. Somente deverá ser informado se o parâmetro "CodEst" também for informado. |
valSal | Opcional | Double | Se houver alteração de salário, informar o novo valor do salário.
- Opcional Disponível somente no módulo Administração de Pessoal. |
cplSal | Opcional | Double | Valor do complemento salarial
- Opcional Disponível somente no módulo Administração de Pessoal. |
codSin | Opcional | Integer | Código do novo sindicato.
- Opcional Disponível somente no módulo Administração de Pessoal. |
socSin | Opcional | String | Demonstra se atualmente o colaborador é sócio de seu sindicato.
- Opcional Valores: "S" - Sim "N" - Não Disponível somente no módulo Administração de Pessoal. |
numCra | Opcional | String | Número do novo crachá do colaborador para a transferência
- Opcional. Disponível nos módulos AP e AP (quando integrado com Controle de Ponto e Refeitório) |
codBHr | Opcional | Integer | Código do banco de horas para a transferência. - Opcional Disponível se integrado com o Gestão do Ponto e possuir conta em aberto no banco de horas. |
traBHr | Opcional | Integer | Opção de tratamento para banco de horas. - Opcional Valores: 1 - Somente Transferir 2 - Perdoar 3 - Pagar 4 - Descontar 5 - Migrar Caso possua Gestão do Ponto e banco de horas com saldo em aberto, o campo é Obrigatório, e, se não for preenchido, ocorre erro ao utilizar este web service. Caso não possua saldo em aberto e o preenchimento do campo na requisição seja enviado, também pode gerar erro. |
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:FilialResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:FilialResponse>
</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. |
Posto_4
Web service de integração que permite cadastrar Históricos de Postos de Trabalho.
Disponível em todos os módulo.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 4
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Posto_4> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipOpe>String</tipOpe> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <iniAtu>DateTime</iniAtu> <codTap>Integer</codTap> <posTra>String</posTra> <motPos>Integer</motPos> <obsPos>String</obsPos> <excHis>String</excHis> <codCar>String</codCar> <carVag>String</carVag> <codEsc>Integer</codEsc> <codEqp>Integer</codEqp> <codCat>Integer</codCat> <funEso>String</funEso> <codTma>Integer</codTma> </parameters> </ser:Posto_4> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
tipOpe | Opcional | String | Tipo da operação a ser efetuada
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão |
numEmp | Obrigatório | Integer | Código da empresa que será utilizado na integração
- Obrigatório - Chave Máscara: 9[4] |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro Máscara: 9[1] |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave Máscara: #[EdiCad]N(9,0)# |
iniAtu | Obrigatório | DateTime | Informar a data de inicio da atuação do posto.
- Obrigatório - Chave Máscara: DD/MM/YYYY |
codTap | Opcional | Integer | Informar o tipo de atuação do histórico de posto.
- Obrigatório na inserção Máscara: 9[3] |
posTra | Opcional | String | Informar o posto de trabalho do histórico
- Obrigatório na inserção Máscara: |
motPos | Opcional | Integer | Informar o motivo da alteração do histórico de posto de trabalho
- Obrigatório na inserção Máscara: 9[3] |
obsPos | Opcional | String | Outras observações referentes ao histórico do posto de trabalho do colaborador.
Máscara: A[700] |
excHis | Opcional | String | Determina se na exclusão do histórico de posto devem ser excluídos os históricos que ficarem inconsistentes.
Lista: S - Sim N - Não Máscara: A[1] |
codCar | Opcional | String | Neste campo é possível informar o cargo do novo histórico de cargo, oriundo da troca de posto.
- Informar somente quando o posto permitir vários cargos. Máscara: #[ediCar]# |
carVag | Opcional | String | Neste campo é possível informar o cargo da vaga do novo histórico de cargo, oriundo da troca de posto.
- Informar somente quando o posto permitir vários cargos. - Informar somente quando o sistema utilizar cargo da vaga. Máscara: #[ediCar]# |
codEsc | Opcional | Integer | - É possível definir a escala válida para o novo histórico de escala, que esteja de acordo com o turno informado na característica do posto.
- Informar somente caso nas características do posto, tenha um turno informado. - Informar somente caso a troca de posto for gerar um novo histórico de escala. |
codEqp | Opcional | Integer | É possível definir a equipe válida para o novo histórico de escala.
- Informar somente caso nas características do posto, não tenha uma equipe informada e tenha uma escala. - Informar somente caso a troca de posto for gerar um novo histórico de escala. - Informar somente caso o tipo da escala for Geração Automática. Máscara: 9[4] |
codCat | Opcional | Integer | É possível definir a categoria válida para o novo histórico de escala.
- Informar somente caso nas características do posto, não tenha uma categoria informada e tenha uma escala. - Informar somente caso a troca de posto for gerar um novo histórico de escala. - Informar somente caso o tipo da escala for Geração Automática. Máscara: 9[4] |
funEso | Opcional | String | Este campo indica se o cargo caracterizado no posto representa a atuação de uma função do colaborador para o eSocial.
As opções possíveis são: S-Sim N-Não Ele somente deve ser preenchido quando nas Definições do eSocial estiver assinalado para considerar o histórico de posto como Função do eSocial. |
codTma | Opcional | Integer | É possível definir a turma válida para o novo histórico de escala, que esteja de acordo com a escala informada na característica do posto.
- Informar somente caso nas características do posto, não tenha uma turma informada e tenha uma escala. - Informar somente caso a troca de posto for gerar um novo histórico de escala. Máscara: 9[1] |
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:Posto_3Response>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:Posto_3Response>
</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. |
PostoAdicional_2
Web service de integração que permite cadastrar Históricos adicionais de Postos de Trabalho.
Disponível em todos os módulo.
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:PostoAdicional_2> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipOpe>String</tipOpe> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <iniAtu>DateTime</iniAtu> <seqHis>Integer</seqHis> <codTap>Integer</codTap> <motAlt>Integer</motAlt> <posTra>String</posTra> <terAtu>DateTime</terAtu> <tipSbs>Integer</tipSbs> <cadSbs>Integer</cadSbs> <perAdi>Integer</perAdi> <obsHpo>String</obsHpo> <funEso>String</funEso> </parameters> </ser:PostoAdicional_2> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão |
numEmp | Obrigatório | Integer | Código da empresa que será utilizado na integração
- Obrigatório - Chave Máscara: 9[4] |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro Máscara: 9[1] |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave Máscara: #[EdiCad]N(9,0)# |
iniAtu | Opcional | DateTime | Informar a data de inicio da atuação do posto adicional.
- Obrigatório - Chave Máscara: DD/MM/YYYY |
seqHis | Obrigatório | Integer | Informar a sequência do histórico
- Obrigatório - Chave Máscara: 9[2] |
codTap | Opcional | Integer | Informar o tipo de atuação do histórico adicional
- Obrigatório na inserção Máscara: 9[3] |
motAlt | Opcional | Integer | Informar o motivo da alteração do histórico adicional de posto de trabalho
- Obrigatório na inserção Máscara: 9[3] |
posTra | Opcional | String | Informar o posto de trabalho do histórico
- Obrigatório na inserção Máscara: |
terAtu | Opcional | DateTime | Informar o término da atuação do posto
Máscara: DD/MM/YYYY |
tipSbs | Opcional | Integer | Informar o tipo de colaborador que está sendo substituído.
- Habilitado somente quando o tipo de atuação for titular - Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro Máscara: 9[1] |
cadSbs | Opcional | Integer | Informar o cadastro do colaborador que está sendo substituído.
- Habilitado somente quando o tipo de atuação for titular Máscara: #[EdiCad]N(9,0)# |
perAdi | Opcional | Integer | Informe o percentual que deve ser utilizado na regra de cálculo de adicional de posto.
Máscara: zzz9,99999 |
obsHpo | Opcional | String | Outras observações referentes ao histórico do posto de trabalho do colaborador.
Máscara: A[700] |
funEso | Opcional | String | Este campo indica se o cargo caracterizado no posto representa a atuação de uma função do colaborador para o eSocial.
As opções possíveis são: S-Sim N-Não Ele somente deve ser preenchido quando nas Definições do eSocial estiver assinalado para considerar o histórico de posto como Função do eSocial. |
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:PostoAdicional_2Response>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:PostoAdicional_2Response>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | String |
Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
- Vazio ou nulo, indicando que a execução foi feita com sucesso; - A mensagem do erro ocorrido no servidor. |
DocumentosAfastamento
Através deste web service, nos é permitido cadastrar documentos para os afastamentos dos colaboradores.
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:DocumentosAfastamento> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAfa>DateTime</datAfa> <horAfa>Time</horAfa> <datArq>DateTime</datArq> <desArq>String</desArq> <uRL>String</uRL> <imagem>Blob</imagem> <nomArq>String</nomArq> </parameters> </ser:DocumentosAfastamento> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
numEmp | Opcional | Integer | Código da empresa que será utilizado na integração
- Obrigatório - Chave |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAfa | Obrigatório | DateTime | Data inicial do afastamento do colaborador
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
horAfa | Opcional | Time | Hora inicial do afastamento
- Obrigatório - Chave - Máscara: HH:MM |
datArq | Opcional | DateTime | Indicar uma data de inclusão do arquivo |
desArq | Opcional | String | Indicar uma descrição para o arquivo. |
uRL | Opcional | String | Indicar a URL que comporta um documento(limite 250 caracteres). |
imagem | Opcional | Blob | Campo blob para a passagem da imagem do documento via parâmetro, nos casos em que for possível.
- Opcional |
nomArq | Obrigatório | String | Nome do arquivo que será armazenado na base.
- Obrigatório. |
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:DocumentosAfastamentoResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:DocumentosAfastamentoResponse>
</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
Este web service efetua as transferências de colaboradores entre os sindicatos cadastrados mantendo um histórico dessas alterações.
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> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <codSin>Integer</codSin> <socSin>String</socSin> <tipOpe>String</tipOpe> </parameters> </ser:Sindicato> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data da alteração do sindicato.
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
codSin | Obrigatório | Integer | Código do sindicato do colaborador
- Obrigatório. |
socSin | Opcional | String | Sócio do Sindicato
- Obrigatório se: - Módulo Administração de Pessoal. Caso contrário, não informar. - LSimNao Valores: S - Sim N - Não |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório Valores: I - Inclusão A - Alteração E - Exclusão Se não for informado, será considerado "alteração" |
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. |
Vinculo
Este web service efetua as transferências de colaboradores entre os vínculos cadastrados mantendo um histórico dessas alterações.
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:Vinculo> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <codVin>Integer</codVin> <tipOpe>String</tipOpe> </parameters> </ser:Vinculo> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data da alteração do histórico de vínculo
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
codVin | Obrigatório | Integer | Código do vínculo do colaborador.
- Obrigatório |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório Valores: I - Inclusão A - Alteração E - Exclusão Se não for informado, será considerado "alteração" |
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:VinculoResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:VinculoResponse>
</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. |
Anotacao
Este web service permite informar anotações para serem incluídas na ficha registro eletrônica. Estas anotações podem se referir a Contratos de Aprendizagem de Menores (Senai, Senac ou Senai), alteração de período aquisitivo de férias, transferência de banco de depósito FGTS, etc. Este item também pode servir para a empresa que deseja efetuar um registro particular de seus colaboradores tais como disciplinas, premiações etc.
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:Anotacao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datNot>DateTime</datNot> <seqNot>Integer</seqNot> <tipNot>Integer</tipNot> <nroDoc>String</nroDoc> <notFic>String</notFic> <empDig>Integer</empDig> <tipDig>Integer</tipDig> <cadDig>Integer</cadDig> <tipOpe>String</tipOpe> </parameters> </ser:Anotacao> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datNot | Obrigatório | DateTime | Data da anotação a ser feita na ficha.
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
seqNot | Obrigatório | Integer | Número de sequência para as anotações da mesma data.
- Obrigatório - Chave Deve iniciar com o valor "1". |
tipNot | Opcional | Integer | Código do tipo da anotação sendo realizada.
- Opcional |
nroDoc | Opcional | String | Número de documento que gerou a anotação
- Opcional |
notFic | Opcional | String | Texto com 2500 bytes, onde pode ser efetuada a descrição que deverá constar da ficha registro em cada data.
- Opcional |
empDig | Opcional | Integer | Código da empresa do responsável pela anotação.
- Opcional |
tipDig | Opcional | Integer | Tipo do colaborador responsável pela anotação.
- Obrigatório Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro Somente deverá ser informado se o parâmetro "EmpDig" for maior que zero. |
cadDig | Opcional | Integer | Código do cadastro do responsável pela anotação.
- Obrigatório Somente deve ser informado se o parâmetro "EmpDig" for maior que zero. |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório Valores: I - Inclusão A - Alteração E - Exclusão Se não for informado, será considerado "alteração" |
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:AnotacaoResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:AnotacaoResponse>
</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. |
ValeTransporte_2
Este web service permite cadastrar os históricos de escala de vale transporte por colaborador.
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:ValeTransporte_2> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipOpe>String</tipOpe> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <iniEvt>DateTime</iniEvt> <escVtr>String</escVtr> <ponEmb>Integer</ponEmb> <fimEvt>DateTime</fimEvt> <wGD038EVN> <tipOpe>String</tipOpe> <codLin>Integer</codLin> <numCar>String</numCar> </wGD038EVN> </parameters> </ser:ValeTransporte_2> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
tipOpe | Opcional | String | Tipo da operação a ser efetuada na integração
"I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "Inclusão" |
numEmp | Obrigatório | Integer | Código da empresa que será utilizado na integração
- Obrigatório - Chave |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador, que poderá ser::
- Obrigatório - Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
iniEvt | Obrigatório | DateTime | Data inicial de validade do histórico.
- Obrigatório - Chave |
escVtr | Opcional | String | Escala do Vale Transporte utilizada pelo colaborador.
- Opcional OBS: Na Inclusão a Escala do Vale Transporte é Obrigatória. |
ponEmb | Opcional | Integer | Informar Ponto de embarque do colaborador.
- Opcional |
fimEvt | Opcional | DateTime | Data Final de validade do histórico.
- Opcional |
wGD038EVN | Opcional | Set | Número do cartão conforme a linha.
Observação: Ao inserir um histórico são sugeridas as linhas cadastradas na escala. |
wGD038EVN.tipOpe | Opcional | String | Tipo da operação a ser efetuada para o registro.
- Obrigatório - Máscara: U - Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão - Obs.: Se não for informado, será considerado "Alteração". |
wGD038EVN.codLin | Opcional | Integer | (Obrigatório) - Number(005) - Linha |
wGD038EVN.numCar | Opcional | String | (Opcional) - String(016) - Número do cartão |
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:ValeTransporte_2Response>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:ValeTransporte_2Response>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | String |
Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
- Vazio ou nulo, indicando que a execução foi feita com sucesso; - A mensagem do erro ocorrido no servidor. |
Horario
Este web service é usado para registrar qual o horário de trabalho de um colaborador, bem como seu horário no sábado, quantas horas semanais e também seu descanso semanal remunerado.
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:Horario> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <horBas>Integer</horBas> <horSab>Integer</horSab> <horSem>Time</horSem> <horDsr>Time</horDsr> <tipOpe>String</tipOpe> <desSim>String</desSim> </parameters> </ser:Horario> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador.
- Obrigatório - Chave Valores: "1" - Empregado "2" - Terceiro "3" - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data de alteração do horário do colaborador
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
horBas | Opcional | Integer | Código do horário base do colaborador
- Obrigatório |
horSab | Opcional | Integer | Código do horário de sábado do colaborador
- Obrigatório |
horSem | Opcional | Time | Quantidade de horas semanais do colaborador
- Obrigatório - Máscara: HH:MM |
horDsr | Opcional | Time | Quantidade de horas DSR do colaborador.
- Obrigatório - Máscara: HH:MM |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório "I" - Inclusão "A" - Alteração "E" - Exclusão Se não for informado, será considerado "alteração" |
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". |
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:HorarioResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:HorarioResponse>
</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. |
Salario_2
Este web service permite alterar os salários individualmente por colaborador.
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:Salario> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datAlt>DateTime</datAlt> <seqAlt>Integer</seqAlt> <codMot>Integer</codMot> <datDis>DateTime</datDis> <tipSal>Integer</tipSal> <codEst>Integer</codEst> <claSal>String</claSal> <nivSal>String</nivSal> <valSal>Double</valSal> <cplSal>Double</cplSal> <codIdm>Integer</codIdm> <salEst>Double</salEst> <cplEst>Double</cplEst> <tipOpe>String</tipOpe> </parameters> </ser:Salario> </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 |
tipCol | Obrigatório | Integer | Informar o tipo de colaborador.
- Obrigatório - Chave Valores: "1" - Empregado "2" - Terceiro "3" - Parceiro |
numCad | Obrigatório | Integer | Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.
- Obrigatório - Chave |
datAlt | Obrigatório | DateTime | Data da alteração salarial do colaborador.
- Obrigatório - Chave - Máscara: DD/MM/YYYY |
seqAlt | Obrigatório | Integer | Código da sequência para reajustes na mesma data.
- Obrigatório - Chave Sempre inicia com o valor "1". |
codMot | Obrigatório | Integer | Código do motivo da alteração salarial.
- Obrigatório |
datDis | Opcional | DateTime | Informar a data do fechamento do dissídio (máscara DD/MM/YYYY). Somente pode ser informado, se o motivo (parâmetro codMot) for do tipo "Legal". |
tipSal | Obrigatório | Integer | Código do tipo do salário
- Obrigatório Valores: 1 - Mensalista 2 - Horista 3 - Diarista 4 - Comissionado 5 - Tarefeiro 6 - Terceiro |
codEst | Opcional | Integer | Código da estrutura salarial do colaborador.
- Opcional Disponível somente para os módulos: CS, CP, PLR, AP |
claSal | Opcional | String | Classe da estrutura salarial a que pertence.
- Obrigatório Disponível para os módulos: CS, CP, PLR, AP Somente pode ser informado se o parâmetro "CodEst" for maior que zero. |
nivSal | Opcional | String | Valor do nível da classe a que pertence o salário.
- Obrigatório Disponível para os módulos: CS, CP, PLR, AP Somente pode ser informado se o parâmetro "CodEst" for maior que zero. |
valSal | Opcional | Double | Valor do salário do colaborador.
- Opcional O valore informado para o colaborador deverá ser maior que o valor do salário anterior que este já possuía. |
cplSal | Opcional | Double | - Valor do complemento salarial
- Opcional Disponível para os módulos: CS, CP, PLR, AP, BS, JR |
codIdm | Opcional | Integer | Código do índice a ser utilizado
- Opcional Disponível somente para o módulo Administração de Pessoal, versão Internacional e para o "Peru" |
salEst | Opcional | Double | Valor do salário em moeda estrangeira
- Opcional Disponível somente para o módulo Administração de Pessoal, versão Internacional e para o "Peru" |
cplEst | Opcional | Double | Valor do complemento salarial em moeda estrangeira.
- Opcional Disponível somente para o módulo Administração de Pessoal, versão Internacional e para o "Peru" |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
- Obrigatório Valores: I - Inclusão A - Alteração E - Exclusão Se não for informado, será considerado "alteração" |
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:SalarioResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:SalarioResponse>
</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. |