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

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

Serviço para incluir, alterar e excluir registros na base do Gestão de Pessoas | HCM.

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

Portas

Afastamentos

Permite inserir, alterar ou excluir históricos de afastamentos.

Necessita autenticação: Sim.

Situação da 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:Afastamentos>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<operacao>String</operacao>
</parameters>
</ser:Afastamentos>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Opcional

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

Registro.Sequencia

Integer

Opcional

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

Campo

Set

Opcional

Campos da tabela R038AFA que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Campos da tabela R038AFA

Nome

Chave

Tipo

Tamanho

Máscara

Descrição

NUMEMP

Sim

Número

4

Código da empresa que será utilizado na integração. Este campo é obrigatório.

TIPCOL

Sim

Número

1

Informar o tipo de colaborador, que poderá ser:


1 - Empregado


2 - Terceiro


3 - Parceiro



Este campo é obrigatório.

NUMCAD

Sim

Número

9

Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro. Este campo é obrigatório.

DATAFA

Sim

Data

DD/MM/YYYY

Data inicial do afastamento do colaborador. Este campo é obrigatório.

HORAFA

Sim

Número

HH:MM

Hora inicial do afastamento. Este campo é obrigatório.

SITAFA

Não

Número

3

Informe a situação de afastamento, férias ou demissão. Este campo é obrigatório.



Caso a situação seja do tipo 3 - Auxílio-doença ou 4 - 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.

DATALT

Não

Data

DD/MM/YYYY

Data de alteração da situação de afastamento

EFERET

Não

Texto

1

Indicar se a alteração de motivo tem efeito retroativo.


Opções:


S-Sim


N-Não

DATPAR

Não

Data

DD/MM/YYYY

Data de término do afastamento. Quando o tipo da situação for 7 - Demitido este parâmetro não poderá ser informado.

CODATE

Não

Numérico

6

Código do Atendente. Este campo é obrigatório quando a empresa estiver utilizando o eSocial.



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

Não

Texto

60

Nome do atendente. Este parâmetro somente poderá ser informado para situações dos tipos abaixo:



3 - Auxílio-doença


6 - Licença Maternidade


14 - Auxílio-doença 15 dias


19 - Auxílio Maternidade

ORGCLA

Não

Numérico

1

Órgão de classe do atendente.


Opções:


1 - Conselho Regional de Medicina (CRM)


2 - Conselho Regional de Odontologia (CRO)



Este parâmetro somente poderá ser informado para situações dos tipos abaixo:


3 - Auxílio-doença


6 - Licença Maternidade


14 - Auxílio-doença 15 dias


19 - Auxílio Maternidade

rEGCON

não

texto

14

registro do atendente no conselho profissional. Este parâmetro somente poderá ser informado para situações dos tipos abaixo:


3 - Auxílio-doença


6 - Licença Maternidade


14 - Auxílio-doença 15 dias


19 - Auxílio Maternidade

ESTCON

Não

Texto

2

Estado do conselho profissional do atendente. Este parâmetro somente poderá ser informado para situações dos tipos abaixo:


3 - Auxílio-doença


6 - Licença Maternidade


14 - Auxílio-doença 15 dias


19 - Auxílio Maternidade

ACITRA

Não

Numérico

1

Tipo Acidente Trânsito. Este campo é opcional.



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.

CODDOE

Não

Texto

4

U999

CID (Classificação Internacional de Doença). Este campo é opcional.



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.

CODSUB

Não

Texto

3

U99

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á emitida uma mensagem de alerta, sugerindo “Sim” para o próximo campo

Risco Anexo

.



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 Assinalamentos Diversos (

FR000ASS

) o campo

Controla Nexo Epidemiológico

estiver com “Sim”.



Utilizado nos módulos: Administração de Pessoal; Segurança e Medicina

RISNEX

Não

Texto

1

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 Assinalamentos Diversos (

FR000ASS

) o campo

Controla Nexo Epidemiológico

estiver com “Sim”.



Utilizado nos módulos: Administração de Pessoal; Segurança e Medicina

DATPER

Não

data

dD/MM/YYYY

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 Assinalamentos Diversos (

FR000ASS

) o campo

Controla Nexo Epidemiológico

estiver com “Sim”.



Utilizado nos módulos: Administração de Pessoal; Segurança e Medicina

dATNEX

não

data

dD/MM/YYYY

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: Administração de Pessoal; Segurança e Medicina

SITINI

não

numérico

3

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: Administração de Pessoal; Segurança e Medicina

CAUDEM

Não

Numérico

2

código da causa da demissão. Este campo é opcional.



Este parâmetro somente poderá ser informado quando o tipo da situação for 7 - Demitido.

cONTOV

não

texto

1

indicar se o afastamento deve ou não ser considerado no Turn-Over. Este campo é opcional. 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 Controle de Ponto e Refeitório quando não estiver integrado com outros módulos do Vetorh.

DIAJUS

Não

Numérico

2

Quantidade de dias justificados. Pode ser informado para situações do tipo:


3 - Auxílio-doença


4 - Acidente de trabalho



Este campo é opcional.

qHRAFA

não

numérico

hHH:MM

solicitada apenas para programações de faltas. Este campo é opcional.


Verificar

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.

TIPSUC

Não

Numérico

Preencha com o tipo (CNPJ ou CPF) de inscrição da empresa sucessora, quando houver sucessão do vínculo trabalhista do colaborador.

CGCSUC

Não

Numérico

15

Informar o CNPJ

ou CPF

da empresa Sucessora. Se preenchido, deverá ser um CNPJ

ou CPF

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.

dIAPRV

não

numérico

4

9999

dias Previsto para o término do afastamento. Este campo é opcional.


Verificar

Este parâmetro somente poderá ser informado para situações com tipos diferentes de:


7 - Demitido


15 - Faltas

DATTER

Não

Data

DD/MM/YYYY

Data de término do afastamento. Quando o tipo da situação for 7 - Demitido este parâmetro não poderá ser informado.

HORTER

Não

Numérico

HH:MM

Hora de término do afastamento. Quando o tipo da situação for 7 - Demitido este parâmetro não poderá ser informado.

pRVTER

não

data

dD/MM/YYYY

data final prevista para o término do afastamento. Este campo é opcional. Este parâmetro somente poderá ser informado para situações com tipos diferentes de:


7 - Demitido


15 - Faltas

EXMRET

Não

Texto

1

Indica a necessidade de exame de retorno. Este campo é opcional. Valores:


S - Sim


N - Não



Pode ser informado quando o tipo da situação for:


  • 3 (Auxílio-doença)

  • 4 (Acidente Trabalho)

  • 5 (Serviço Militar)

  • 6 (Licença Maternidade)

  • 8 (Licença s/ Remuneração)

  • 10 (Licença Remunerada p/ Colaborador)

  • 13 (Aviso Prévio Trabalhado)

  • 14 (Auxílio-doença 15 Dias)

  • 19 (Licença Maternidade INSS)

  • 23 (Acidente Trabalho 15 Dias)


Não deve ser informado no Controle de Ponto e Refeitório quando não estiver integrado com outros módulos do Gestão de Pessoas | HCM.


Não deve ser informado no Treinamento e Pesquisa ou no Recrutamento e Seleção quando não estiverem integrados com o módulo Segurança e Medicina.

MOTRAI

Não

Numérico

2

Código do motivo para Rais. Este campo é opcional.



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 Segurança e Medicina.


Disponível quando a situação passada como parâmetro possuir o campo “DesRai” com o valor “S”.


Não deve ser informado no Controle de Ponto e Refeitório quando não estiver integrado com os módulos Segurança e Medicina e Administração de Pessoal.


Não deverá ser informado quando o tipo da situação for 11 - Licença Paternidade e a “DataAfa” for posterior à 31/12/2005.

OBSAFA

Não

Texto

255

Espaço para digitar qualquer mensagem relativa ao afastamento. Este campo é opcional.



Disponível em todos os módulos, exceto no Quadro de Vagas e Orçamento.

atePat

não

texto

1

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
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

Campo.Nome

String

Opcional

Nome do campo.

Campo.Valor

String

Opcional

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

Campo.Status

Integer

Opcional

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

Campo.Mensagem

String

Opcional

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

Status

Set

Opcional

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

Status.Codigo

String

Opcional

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

Status.Mensagem

String

Opcional

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

operacao

String

Opcional

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Envelope xmlns:ser=“http://services.senior.com.br” xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/”>
<soapenv:Body>
<ser:AfastamentosResponse>
<result>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
</result>
</ser:AfastamentosResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Opcional

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

Registro.Sequencia

Integer

Opcional

Identificador para facilitar a recuperação do resultado.

Campo

Set

Opcional

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

Campo.Nome

String

Opcional

Nome do campo.

Campo.Valor

String

Opcional

Valor referente ao campo informado.

Campo.Status

Integer

Opcional

Status do retorno da requisição ao webservice.
0: OK
1: Consistência de negócio
2: Consistência customizados
3: Erro nos campos
4: Erro não mapeado
5: Registro inexistente
6: Parâmetro inválido
7: Aviso
8: Registro já cadastrado

Campo.Mensagem

String

Opcional

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

Status

Set

Opcional

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

Status.Codigo

Integer

Opcional

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

Status.Mensagem

Integer

Opcional

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

erroAposExecucao

String

Opcional

Mensagem de erro após a execução.

erroExecucao

String

Opcional

Mensagem de erro durante a execução.

Atendentes

Permite inserir, alterar ou excluir cadastros de Atendentes.

Necessita autenticação: Sim.

Situação da 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:Atendentes>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

</campo>
</registro>
</parameters>
</ser:Atendentes>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R108TAT que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Máscara

Descrição

CODATE

Sim

Número

6

Código do atendente

ORIATE

Não

Texto

1

Origem do atendente

NUMEMP

Não

Número

4

Código da empresa

TIPCOL

Não

Número

1

Tipo do colaborador

NUMCAD

Não

Número

9

Número do cadastro do colaborador

NOMATE

Não

Texto

40

Nome do atendente

CODPRF

Não

Número

4

Código do conselho profissional

REGCON

Não

Texto

20

Registro no conselho profissional

SITREG

Não

Texto

1

Situação do registro no conselho profissional

TITATE

Não

Texto

9

Título utilizado na apresentação do atendente (Dr, Dra, Fda, etc.)

DDICON

Não

Número

3

Código DDI do contato

DDDCON

Não

Número

3

Código DDD do contato

NUMTEL

Não

Texto

20

Número do telefone

CODUSU

Não

Número

10

Código do usuário relacionado ao atendente

CODPOS

Não

Número

3

Código do posto de atendimento padrão

QTDMES

Não

Número

2

É o tempo que será retrocedido para considerar exames no ASO

INDPAR

Não

Texto

1

Na emissão do ASO considera a situação exame

FECQUE

Não

Texto

1

Define comportamento ao gravar as respostas do questionário

CONCID

Não

Número

1

Define como deve apresentar a tela de consulta da CID
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:AtendentesResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:AtendentesResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao webservice.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

BasesCalculo

Permite inserir, alterar ou excluir valores de Lançamentos Base (FR044BAS)

Necessita autenticação: Sim.

Situação da versão: Atual.

Versão: 1.

Versão atual: 1.

Requisição:

<soapenv:Envelope xmlns:ser=“http://services.senior.com.br” xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/”>
<soapenv:Body>
<ser:BasesCalculo>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<operacao>String</operacao>
</parameters>
</ser:BasesCalculo>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operação

Obrigatório

String

I = Inserir


A = Alterar


E = Excluir

registro

Obrigatório

Set

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Obrigatório

Integer

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Obrigatório

Set

A tabela abaixo lista os campos da tabela R044BAS que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Descrição

NUMEMP

Sim

Número

4

Código da empresa que será utilizado na integração. Este campo é obrigatório.

TIPCOL

Sim

Número

1

Informar o tipo de colaborador, que poderá ser:


  • 1 - Empregado

  • 2 - Terceiro

  • 3 - Parceiro

Este campo é obrigatório.

NUMCAD

Sim

Número

9

Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro. Este campo é obrigatório.

CMPBAS

Sim

Data

Competência da contribuição realizada. Este campo é obrigatório.



Máscara: MM/YYYY

SEQBAS

Sim

Número

2

Sequencia do lançamento na competência. Este campo é obrigatório.

TIPINS

Não

Número

1

Informar o tipo de inscrição, que poderá ser:


  • 1 - CNPJ

  • 2 - CPF

Este campo é obrigatório.

NUMINS

Não

Número

15

Informar o número de inscrição de acordo com o tipo de inscrição, informar somente números. Este campo é obrigatório.

CONIND

Não

Texto

1

Informe se o outro contrato do colaborador se enquadra em categoria de contribuinte individual (“S - Sim” ou “N - Não”). Este campo é obrigatório.

CATESO

Não

Número

3

Informe a categoria do trabalhador, conforme Tabela 01 (Categorias de Trabalhadores) do eSocial. Este campo é obrigatório.

BMEINS

Não

Número

13

Informe a base de cálculo do INSS Mensal

VMEINS

Não

Número

13

Informe o valor de cálculo do INSS Mensal

B13INS

Não

Número

13

Informe a base de cálculo do INSS sobre 13º Salário

V13INS

Não

Número

13

Informe o valor de cálculo do INSS sobre 13º Salário

BMEIRF

Não

Número

13

Informe a base de IRRF

VMEIRF

Não

Número

13

Informe o valor de IRRF

BFEIRF

Não

Número

13

Informe a base de IRRF férias

VFEIRF

Não

Número

13

Informe o valor de IRRF férias

B13IRF

Não

Número

13

Informe a base de IRRF sobre o 13º salário

V13IRF

Não

Número

13

Informe o valor de IRRF sobre o 13º salário

BPLIRF

Não

Número

13

Informe a base de IRRF de participação nos lucros

VPLIRF

Não

Número

13

Informe o valor de IRRF de participação nos lucros

BMEIPE

Não

Número

13

Informe a base do IPE de mensal

VMEIPE

Não

Número

13

Informe o valor do IPE de mensal

BFEIPE

Não

Número

13

Informe a base do IPE de férias

VFEIPE

Não

Número

13

Informe o valor do IPE de férias

B13IPE

Não

Número

13

Informe a base do IPE de 13º salário

V13IPE

Não

Número

13

Informe o valor do IPE de 13º salário

DMENSI

Não

Número

13

Informe o valor da dedução simplificada mensal

DFERSI

Não

Número

13

Informe o valor da dedução simplificada sobre férias

D13SIM

Não

Número

13

Informe o valor da dedução simplificada sobre 13º salário
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

Obrigatório

String

Nome do campo.

campo.valor

Obrigatório

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.

BasesCalculo_2

Nota

Esta porta apresenta um ou mais parâmetros que permitem o envio de CNPJ alfanumérico.

Permite inserir, alterar ou excluir valores de Lançamentos Base (FR044BAS)

Necessita autenticação: Sim.

Situação da versão: Atual.

Versão: 2.

Versão atual: 2.

Requisição:

<soapenv:Envelope xmlns:ser=“http://services.senior.com.br” xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/”>
<soapenv:Body>
<ser:BasesCalculo>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<operacao>String</operacao>
</parameters>
</ser:BasesCalculo>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operação

Obrigatório

String

I = Inserir


A = Alterar


E = Excluir

registro

Obrigatório

Set

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Obrigatório

Integer

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Obrigatório

Set

A tabela abaixo lista os campos da tabela R044BAS que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Descrição

NUMEMP

Sim

Número

4

Código da empresa que será utilizado na integração. Este campo é obrigatório.

TIPCOL

Sim

Número

1

Informar o tipo de colaborador, que poderá ser:


  • 1 - Empregado

  • 2 - Terceiro

  • 3 - Parceiro

Este campo é obrigatório.

NUMCAD

Sim

Número

9

Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro. Este campo é obrigatório.

CMPBAS

Sim

Data

Competência da contribuição realizada. Este campo é obrigatório.



Máscara: MM/YYYY

SEQBAS

Sim

Número

2

Sequencia do lançamento na competência. Este campo é obrigatório.

TIPINS

Não

Número

1

Informar o tipo de inscrição, que poderá ser:


  • 1 - CNPJ

  • 2 - CPF

Este campo é obrigatório.

CFJINS

Não

Texto

14

Informar o número de inscrição de acordo com o tipo de inscrição. Este campo é obrigatório.

CONIND

Não

Texto

1

Informe se o outro contrato do colaborador se enquadra em categoria de contribuinte individual (“S - Sim” ou “N - Não”). Este campo é obrigatório.

CATESO

Não

Número

3

Informe a categoria do trabalhador, conforme Tabela 01 (Categorias de Trabalhadores) do eSocial. Este campo é obrigatório.

BMEINS

Não

Número

13

Informe a base de cálculo do INSS Mensal

VMEINS

Não

Número

13

Informe o valor de cálculo do INSS Mensal

B13INS

Não

Número

13

Informe a base de cálculo do INSS sobre 13º Salário

V13INS

Não

Número

13

Informe o valor de cálculo do INSS sobre 13º Salário

BMEIRF

Não

Número

13

Informe a base de IRRF

VMEIRF

Não

Número

13

Informe o valor de IRRF

BFEIRF

Não

Número

13

Informe a base de IRRF férias

VFEIRF

Não

Número

13

Informe o valor de IRRF férias

B13IRF

Não

Número

13

Informe a base de IRRF sobre o 13º salário

V13IRF

Não

Número

13

Informe o valor de IRRF sobre o 13º salário

BPLIRF

Não

Número

13

Informe a base de IRRF de participação nos lucros

VPLIRF

Não

Número

13

Informe o valor de IRRF de participação nos lucros

BMEIPE

Não

Número

13

Informe a base do IPE de mensal

VMEIPE

Não

Número

13

Informe o valor do IPE de mensal

BFEIPE

Não

Número

13

Informe a base do IPE de férias

VFEIPE

Não

Número

13

Informe o valor do IPE de férias

B13IPE

Não

Número

13

Informe a base do IPE de 13º salário

V13IPE

Não

Número

13

Informe o valor do IPE de 13º salário

DMENSI

Não

Número

13

Informe o valor da dedução simplificada mensal

DFERSI

Não

Número

13

Informe o valor da dedução simplificada sobre férias

D13SIM

Não

Número

13

Informe o valor da dedução simplificada sobre 13º salário
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

Obrigatório

String

Nome do campo.

campo.valor

Obrigatório

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.

CentrosDeCustos

Possibilita inserir, alterar ou excluir Centros de Custos.

Necessita autenticação: Sim.

Situação da 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:CentroDeCustos>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

</campo>
</registro>
</parameters>
</ser:CentroDeCustos>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R018CCU que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Máscara

Descrição

NUMEMP

Sim

Número

4

Código da empresa

CODCCU

Sim

Texto

18

Código Centro Custo Contábil

NOMCCU

Não

Texto

80

Descrição do C.Custo

FILGRP

Não

Número

6

Filial GPS

FILCTB

Não

Número

6

Filial Contábil

CODRAT

Não

Número

9

Código de Rateio do C.Custo

DATCRI

Não

Data

DD/MM/AAAA

Data de Criação

DATEXT

Não

Data

DD/MM/AAAA

Data de Extinção

CODFIL

Não

Número

6

Filial Orçamento

CCUTXT

Não

Texto

32

Texto C.Custo
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:CentroDeCustosResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:CentroDeCustosResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

HistoricoCentroDeCusto

Possibilita inserir, alterar ou excluir Históricos de Centro de Custo.

Necessita autenticação: Sim.

Situação da 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:HistoricoCentroDeCusto>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
</parameters>
</ser:HistoricoCentroDeCusto>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R038HCC que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
(Substituir pela Tabela 1)

Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:HistoricoCentroDeCustoResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
</result>
</ser:HistoricoCentroDeCustoResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

LancarVales

Possibilita inserir Vales.

Necessita autenticação: Sim.

Situação da 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:LancarVales>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
</campo>
</registro>
</parameters>
</ser:LancarVales>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela Vales/Compras (R044VAL) que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Máscara

Descrição

NUMEMP

Sim

Número

4

Código da empresa que será utilizado na integração. Este campo é obrigatório.

TIPCOL

Sim

Número

1

Informar o tipo de colaborador, que poderá ser:


1 - Empregado


2 - Terceiro


3 - Parceiro



Este campo é obrigatório.

NUMCAD

Sim

Número

9

Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro. Este campo é obrigatório.

DATPAG

Sim

Data

DD/MM/YYYY

Data de pagamento do vale. Este campo é obrigatório.

SEQVAL

Sim

Número

2

Sequência na data do vale. Caso este campo não seja informado, o serviço irá calcular automaticamente uma sequência disponível.

TIPVAL

Não

Número

3

Tipo do vale. Este campo é obrigatório.

NRODOC

Não

Texto

15

Número do Documento.

VALBRU

Não

Numérico

11,2

Valor bruto do adiantamento. Este campo é obrigatório.

VALIRF

Não

Numérico

11,2

Valor de IR do adiantamento.

TDCVAL

Não

Texto

1

Tipo de desconto. Opções:


C - Descontar em Todos os Tipos de Cálculo


U - Descontar Apenas no Último Cálculo do Mês


N - Não Descontar



Este campo é obrigatório.

QTDPCL

Não

Número

3

Quantidade de parcelas.


Este parâmetro deverá ser informado quando TDCVAL for diferente de N.

CMPINI

Não

Data

MM/YYYY

Competência de início do desconto.


Este parâmetro deverá ser informado quando TDCVAL for diferente de N.
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:LancarValesResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:LancarValesResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

OutrasEmpresas

Possibilita inserir, alterar ou excluir Outras Empresas.

Necessita autenticação: Sim.

Situação da 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:OutrasEmpresas>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

</campo>
</registro>
</parameters>
</ser:OutrasEmpresas>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R032OEM que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
(Substituir pela Tabela 1)

Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:OutrasEmpresasResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:OutrasEmpresasResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

OutrasEmpresas_2

Nota

Esta porta apresenta um ou mais parâmetros que permitem o envio de CNPJ alfanumérico.

Possibilita inserir, alterar ou excluir Outras Empresas.

Necessita autenticação: Sim

Situação da 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:OutrasEmpresas>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<operacao>String</operacao>
</parameters>
</ser:OutrasEmpresas>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Opcional

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Opcional

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Opcional

Campos da tabela R032OEM que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
(Substituir pela Tabela 1)

Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Opcional

Nome do campo.

campo.valor

String

Opcional

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

campo.status

Integer

Opcional

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Opcional

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Opcional

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

String

Opcional

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

String

Opcional

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

operação

String

Opcional

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:OutrasEmpresasResponse>
<result>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
</result>
</ser:OutrasEmpresasResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Opcional

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Opcional

Identificador para facilitar a recuperação do resultado.

campo

Set

Opcional

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Opcional

Nome do campo.

campo.valor

String

Opcional

Valor referente ao campo informado.

campo.status

Integer

Opcional

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Opcional

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Opcional

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

String

Opcional

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

String

Opcional

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

erroAposExecucao

String

Opcional

Mensagem de erro após a execução.

erroExecucao

String

Opcional

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.

ProgramacaoFerias

Possibilita inserir, alterar ou excluir programações de férias individuais.

Necessita autenticação: Sim.

Situação da 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:ProgramacaoFerias>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

</campo>
</registro>
</parameters>
</ser:ProgramacaoFerias>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R040PRG que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Máscara

Descrição

NUMEMP

Sim

Número

4

Código da empresa

TIPCOL

Sim

Número

1

Tipo do colaborador

NUMCAD

Sim

Número

9

Número do cadastro do colaborador

INIPER

Sim

Data

DD/MM/AAAA

Início do período aquisitivo

PRGDAT

Sim

Data

DD/MM/AAAA

Início das férias

PRGDFE

Não

Número

2,2

Dias de férias

PRGDAB

Não

Número

2,2

Dias de abono

PRG13S

Não

Alfa

1

Adiantamento de 13º salário (S/N)

PRGDPG

Não

Data

DD/MM/AAAA

Data de pagamento

PRGPCL

Não

Número

2

Parcelas

GERADT

Não

Alfa

1

Gerar adiantamento (S/N)

STAPRG

Não

Alfa

1

Programação efetiva ou provisória (E/P)
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:ProgramacaoFeriasResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:ProgramacaoFeriasResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao webservice.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

Rateios

Possibilita inserir, alterar ou excluir Rateios.

Necessita autenticação: Sim.

Situação da 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:Rateios>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

</campo>
</registro>
</parameters>
</ser:Rateios>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R020RAT que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Máscara

Descrição

CODRAT

Sim

Número

9

Código do rateio

DESRAT

Não

Texto

80

Descrição do Rateio

TIPDSP

Não

Número

1

Tipo de Despesa

Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:RateiosResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:RateiosResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao webservice.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

RateioTomador

Possibilita inserir ou alterar Tomadores por Rateio.

Necessita autenticação: Sim.

Situação da 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:RateioTomador>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<operacao>String</operacao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

</campo>
</registro>
</parameters>
</ser:RateioTomador>
</soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

operação

String

Obrigatório

I = Inserir


A = Alterar


E = Excluir


IA = Incluir/Alterar

registro

Set

Obrigatório

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

campo

Set

Obrigatório

Campos da tabela R020TOM que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.


Nome

Chave

Tipo

Tamanho

Máscara

Descrição

NUMEMP

Sim

Número

4

Código da empresa

CODRAT

Sim

Número

9

Código do rateio

CODTOM

Não

Número

8

Código do Tomador de Serviço

CODFIL

Não

Número

6

Código da Filial
Observações
  • O separador de números decimais é o ponto. Exemplo: 9.99.
  • Campos de usuário também são permitidos.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:RateioTomadorResponse>
<result>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>

<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>

</status>
</registro>
</result>
</ser:RateioTomadorResponse>
</soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Opcional

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Opcional

Identificador para facilitar a recuperação do resultado.

campo

Set

Opcional

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Opcional

Nome do campo.

campo.valor

String

Opcional

Valor referente ao campo informado.

campo.status

Integer

Opcional

Status do retorno da requisição ao webservice.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Opcional

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Opcional

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Opcional

Código da mensagem.
0: OK
1: Consistência de negócio
2: Consistência customizados
3: Erro nos campos
4: Erro não mapeado
5: Registro inexistente
6: Parâmetro inválido
7: Aviso
8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

erroAposExecucao

String

Opcional

Mensagem de erro após a execução.

erroExecucao

String

Opcional

Mensagem de erro durante a execução.
### RateioColaborador Permite inserir, alterar ou excluir cadastros de Rateios por colaborador. Necessita autenticação: Sim. Situação da 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:RateioColaborador>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<operacao>String</operacao>
</parameters>
</ser:RateioColaborador>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Opcional

Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.

Registro. Sequencia

Integer

Opcional

Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante.

Campo

Set

Opcional

Chave

Tipo

Tamanho

Máscara

Descrição

Sim

Número

4

Código da empresa

Sim

Número

1

Tipo do colaborador

Sim

Número

9

Número do cadastro do colaborador

Sim

Número

1

MM/YYYY

Competência do Rateio

Sim

Número

9

Código do Rateio

Não

Número

1

Considera Rateio

Não

Texto

5,2

% Rateio

Campo.Nome

String

Opcional

Nome do campo.

Campo.Valor

String

Opcional

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

Campo.Status

Integer

Opcional

Status do retorno da requisição ao web service.
0: OK
1: Consistência de negócio
2: Consistência customizados
3: Erro nos campos
4: Erro não mapeado
5: Registro inexistente
6: Parâmetro inválido
7: Aviso
8: Registro já cadastrado

Campo.Mensagem

String

Opcional

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

Status

Set

Opcional

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

Status.Codigo

String

Opcional

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

Status. Mensagem

String

Opcional

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

operacao

String

Opcional

I = Inserir
A = Alterar
E = Excluir
IA = Incluir/Alterar
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:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:RateioColaboradorResponse>
<result>
<registro>
<sequencia>Integer</sequencia>
<campo>
<nome>String</nome>
<valor>String</valor>
<status>Integer</status>
<mensagem>String</mensagem>
</campo>
<status>
<codigo>String</codigo>
<mensagem>String</mensagem>
</status>
</registro>
<erroAposExecucao>String</erroAposExecucao>
<erroExecucao>String</erroExecucao>
</result>
</ser:RateioColaboradorResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:

Nome

Tipo

Preenchimento

Descrição

registro

Set

Obrigatório

Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação.

registro.sequencia

Integer

Obrigatório

Identificador para facilitar a recuperação do resultado.

campo

Set

Obrigatório

Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.

campo.nome

String

Obrigatório

Nome do campo.

campo.valor

String

Obrigatório

Valor referente ao campo informado.

campo.status

Integer

Obrigatório

Status do retorno da requisição ao web service.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

campo.mensagem

String

Obrigatório

Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro.

status

Set

Obrigatório

Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.

status.codigo

Integer

Obrigatório

Código da mensagem.


0: OK


1: Consistência de negócio


2: Consistência customizados


3: Erro nos campos


4: Erro não mapeado


5: Registro inexistente


6: Parâmetro inválido


7: Aviso


8: Registro já cadastrado

status.mensagem

Integer

Obrigatório

Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro.

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