PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas | HCM - versão 6.10.3
Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Controle de Ponto e Refeitório > Com.senior.g5.rh.hr.persistencia

Web service com.senior.g5.rh.hr.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 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

Porta(s)

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:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
			<soapenv:Body>
			<ser:Afastamentos>
			<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:Afastamentos>
			</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 R038AFA que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
NomeChaveTipoTamanhoMáscaraDescrição
NUMEMPSimNúmero4-Código da empresa que será utilizado na integração. Este campo é obrigatório.
TIPCOLSimNúmero1-Informar o tipo de colaborador, que poderá ser:
1 - Empregado
2 - Terceiro
3 - Parceiro

Este campo é obrigatório.
NUMCADSimNúmero9-Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro. Este campo é obrigatório.
DATAFASimData-DD/MM/YYYYData inicial do afastamento do colaborador. Este campo é obrigatório.
HORAFASimNúmero-HH:MMHora inicial do afastamento. Este campo é obrigatório.
SITAFANãoNúmero3-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.
DATALTNãoData-DD/MM/YYYYData de alteração da situação de afastamento
EFERETNãoTexto1-Indicar se a alteração de motivo tem efeito retroativo.
Opções:
S-Sim
N-Não
DATPARNãoData-DD/MM/YYYYData de término do afastamento. Quando o tipo da situação for 7 - Demitido este parâmetro não poderá ser informado.
CODATENãoNumérico6-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.
NOMATENãoTexto60-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
ORGCLANãoNumérico1-Ó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
rEGCONnãotexto14-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
ESTCONNãoTexto2-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
ACITRANãoNumérico1-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.
CODDOENãoTexto4U999CID (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.
CODSUBNãoTexto3U99Informar 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
RISNEXNãoTexto1-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
DATPERNãoData-dD/MM/YYYYinformar 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
dATNEXnãodata-dD/MM/YYYYinformar 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
SITININãonumérico3-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
CAUDEMNãoNumérico2-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.
cONTOVnãotexto1-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.
DIAJUSNãoNumérico2-Quantidade de dias justificados. Pode ser informado para situações do tipo:
3 - Auxílio-doença
4 - Acidente de trabalho

Este campo é opcional.
qHRAFAnãonumérico-hHH:MMsolicitada 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.
TIPSUCNãoNumérico--Preencha com o tipo (CNPJ ou CPF) de inscrição da empresa sucessora, quando houver sucessão do vínculo trabalhista do colaborador.
CGCSUCNãoNumérico15-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.
dIAPRVnãonumérico49999dias 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
DATTERNãoData-DD/MM/YYYYData de término do afastamento. Quando o tipo da situação for 7 - Demitido este parâmetro não poderá ser informado.
HORTERNãoNumérico-HH:MMHora de término do afastamento. Quando o tipo da situação for 7 - Demitido este parâmetro não poderá ser informado.
pRVTERnãodata-dD/MM/YYYYdata 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
EXMRETNãoTexto1-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.
MOTRAINãoNumérico2-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.
OBSAFANãoTexto255-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.

Observação: 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
Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
			<soapenv:Body>
			<ser:AfastamentosResponse>
			<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:AfastamentosResponse>
			</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.

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.
NomeChaveTipoTamanhoMáscaraDescrição
CODATESimNúmero6-Código do atendente
ORIATENãoTexto1-Origem do atendente
NUMEMPNãoNúmero4-Código da empresa
TIPCOLNãoNúmero1-Tipo do colaborador
NUMCADNãoNúmero9-Número do cadastro do colaborador
NOMATENãoTexto40-Nome do atendente
CODPRFNãoNúmero4-Código do conselho profissional
REGCONNãoTexto20-Registro no conselho profissional
SITREGNãoTexto1-Situação do registro no conselho profissional
TITATENãoTexto9-Título utilizado na apresentação do atendente (Dr, Dra, Fda, etc.)
DDICONNãoNúmero3-Código DDI do contato
DDDCONNãoNúmero3-Código DDD do contato
NUMTELNãoTexto20-Número do telefone
CODUSUNãoNúmero10-Código do usuário relacionado ao atendente
CODPOSNãoNúmero3-Código do posto de atendimento padrão
QTDMESNãoNúmero2-É o tempo que será retrocedido para considerar exames no ASO
INDPARNãoTexto1-Na emissão do ASO considera a situação exame
FECQUENãoTexto1-Define comportamento ao gravar as respostas do questionário
CONCIDNãoNúmero1-Define como deve apresentar a tela de consulta da CID

Observação: 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. Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser: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.

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.
NomeChaveTipoTamanhoMáscaraDescrição
NUMEMPSimNúmero4-Código da empresa
CODCCUSimTexto18-Código Centro Custo Contábil
NOMCCUNãoTexto80-Descrição do C.Custo
FILGRPNãoNúmero6-Filial GPS
FILCTBNãoNúmero6-Filial Contábil
CODRATNãoNúmero9-Código de Rateio do C.Custo
DATCRINãoData-DD/MM/AAAAData de Criação
DATEXTNãoData-DD/MM/AAAAData de Extinção
CODFILNãoNúmero6-Filial Orçamento
CCUTXTNãoTexto32-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.
Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser: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 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.

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.
Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns: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 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.

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.
Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser: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 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.
NomeChaveTipoTamanhoMáscaraDescrição
CODRATSimNúmero9-Código do rateio
DESRATNãoTexto80-Descrição do Rateio
TIPDSPNãoNúmero1-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.
Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser: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.
NomeChaveTipoTamanhoMáscaraDescrição
NUMEMPSimNúmero4-Código da empresa
CODRATSimNúmero9-Código do rateio
CODTOMNãoNúmero8-Código do Tomador de Serviço
CODFILNãoNúmero6-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.
Números com decimais: 9.99

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser: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 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.

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

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

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

Ver site completo